Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/img/setup-aws/aws10.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions src/img/setup-aws/aws11.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions src/img/setup-aws/aws19.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions src/img/setup-aws/aws20.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions src/img/setup-azure/azure14.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions src/img/setup-azure/azure15.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions src/img/setup-digital-ocean/click-create-droplet.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions src/img/setup-digital-ocean/create-droplet.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions src/img/setup-digital-ocean/do-authentication.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions src/img/setup-digital-ocean/do-check-logs.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions src/img/setup-digital-ocean/do-console-terminal.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions src/img/setup-digital-ocean/do-console.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions src/img/setup-digital-ocean/do-distribution.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions src/img/setup-digital-ocean/do-droplets.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions src/img/setup-digital-ocean/do-edit-firewall.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions src/img/setup-digital-ocean/do-firewall.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions src/img/setup-digital-ocean/do-networking.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions src/img/setup-digital-ocean/do-plan.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions src/img/setup-digital-ocean/do-prompt.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions src/img/setup-digital-ocean/do-run-script.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions src/img/setup-digital-ocean/do-userdata.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions src/img/setup-digital-ocean/do-userdata2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions src/img/setup-digital-ocean/do10.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions src/img/setup-digital-ocean/do11.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions src/img/setup-digital-ocean/do12.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions src/img/setup-digital-ocean/do5.png
3 changes: 0 additions & 3 deletions src/img/setup-digital-ocean/do6.png
Diff not rendered.
4 changes: 2 additions & 2 deletions src/img/setup-digital-ocean/do7.png
4 changes: 2 additions & 2 deletions src/img/setup-digital-ocean/do8.png
3 changes: 3 additions & 0 deletions src/img/setup-digital-ocean/syncendpoint-droplet.png
3 changes: 3 additions & 0 deletions src/img/ssh-tunneling/connect-to-server.png
3 changes: 3 additions & 0 deletions src/img/ssh-tunneling/local-access.png
3 changes: 2 additions & 1 deletion src/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,8 @@ The :doc:`tables-sample-app` walks you through the process of using a basic tabl
sync-endpoint
sync-endpoint-cloud-setup
sync-endpoint-manual-setup
sync-endpoint-user-instructions.rst
sync-endpoint-user-instructions
ssh-tunneling

.. toctree::
:maxdepth: 2
Expand Down
34 changes: 34 additions & 0 deletions src/ssh-tunneling.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
.. _ssh-tunneling:

SSH Tunneling for ODK-X Sync Endpoint
============================================

Secure Shell (SSH) tunneling provides a secure way to access services remotely. The following instructions explain how to set up an SSH tunnel to access the admin portal for the ODK-X Sync Endpoint deployed in a cloud environment.

1. Open your terminal or command prompt on your local machine and run the following command:

.. code-block:: console

$ ssh -L <local_port>:<server_ip>:40000 <user>@<ssh_server>

Replace the placeholders with your actual values.

.. image:: /img/ssh-tunneling/connect-to-server.png
:width: 600

2. Once connected, you've created an SSH tunnel, allowing you to access the admin portal locally. Go to https://localhost:local_port to access the admin portal.

.. image:: /img/ssh-tunneling/local-access.png
:width: 600

.. _ssh-tunnel-additional-resources:

Additional Resources
-----------------------
For more in-depth information on SSH tunneling, refer to the following resources:

- `How to Set Up SSH Tunnel with PuTTY <https://tecadmin.net/putty-ssh-tunnel-and-port-forwarding/>`_
- `Guide to Using SSH Port Forwarding (SSH Tunneling) <https://builtin.com/software-engineering-perspectives/ssh-port-forwarding>`_
- `SSH Tunneling: Examples, Command, Server Config <https://www.ssh.com/academy/ssh/tunneling-example>`_

Feel free to explore these resources for a deeper understanding of SSH tunneling concepts and usage.
Loading