diff --git a/src/img/setup-aws/aws10.png b/src/img/setup-aws/aws10.png index 1991dca1..77e08fe9 100644 --- a/src/img/setup-aws/aws10.png +++ b/src/img/setup-aws/aws10.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:10d5bba3a08a26552f77ace2110851658cddc25c57057780cc4cf8008d38a9fc -size 75080 +oid sha256:339c5614c3f8c57839c860db289a331474a4f57661eabc41bbc079e7bb353112 +size 44594 diff --git a/src/img/setup-aws/aws11.png b/src/img/setup-aws/aws11.png index 693daf97..d0fc1d6c 100644 --- a/src/img/setup-aws/aws11.png +++ b/src/img/setup-aws/aws11.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:5559cab1f87351dadaba32b7e90de5273e75a983e690d368f51d49fe77d2639d -size 78204 +oid sha256:7631b6f2580806a2a0c13231f38e469819086754caa7ccf7b5ba43a63c9e76c5 +size 75626 diff --git a/src/img/setup-aws/aws19.png b/src/img/setup-aws/aws19.png index cf418509..d3d95c19 100644 --- a/src/img/setup-aws/aws19.png +++ b/src/img/setup-aws/aws19.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:f6228952ac8de8db2aa8b0af405bbdc915a8b728f3f9c7fa0596a07c732b6e1d -size 2421071 +oid sha256:d79c782539a04bcabd5a3c3e9fa70a00f9e47a95a7bbd7f9c09debe07327d730 +size 39749 diff --git a/src/img/setup-aws/aws20.png b/src/img/setup-aws/aws20.png index 14da655b..d456cf05 100644 --- a/src/img/setup-aws/aws20.png +++ b/src/img/setup-aws/aws20.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:647d7f6bd72769bdb567c76bfbe471e9a33ef0c9891311946e40a5fa45a79206 -size 661926 +oid sha256:442ec3dd1d97ea60d70310399f6cef0f5716f589cc531ca12130d1fb00b06e5c +size 76465 diff --git a/src/img/setup-azure/azure14.png b/src/img/setup-azure/azure14.png index 42eb705d..d3d95c19 100644 --- a/src/img/setup-azure/azure14.png +++ b/src/img/setup-azure/azure14.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:1ca9f711832c562f26ad98417c6a5529de4bf3cd12704be4aa3871538d743912 -size 2488534 +oid sha256:d79c782539a04bcabd5a3c3e9fa70a00f9e47a95a7bbd7f9c09debe07327d730 +size 39749 diff --git a/src/img/setup-azure/azure15.png b/src/img/setup-azure/azure15.png index 1c06f1db..d456cf05 100644 --- a/src/img/setup-azure/azure15.png +++ b/src/img/setup-azure/azure15.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:df62f51cad77e2f623fad721453796d588f4a58b2576c14da02cd0ffa78813ee -size 687051 +oid sha256:442ec3dd1d97ea60d70310399f6cef0f5716f589cc531ca12130d1fb00b06e5c +size 76465 diff --git a/src/img/setup-digital-ocean/click-create-droplet.png b/src/img/setup-digital-ocean/click-create-droplet.png new file mode 100644 index 00000000..a1d2901e --- /dev/null +++ b/src/img/setup-digital-ocean/click-create-droplet.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:507b990749caeb125ddb65e8cfbdd8975aa6206ba779ca7299cebeb9ac3b5f2a +size 76281 diff --git a/src/img/setup-digital-ocean/create-droplet.png b/src/img/setup-digital-ocean/create-droplet.png index 39b387a0..620fb1ea 100644 --- a/src/img/setup-digital-ocean/create-droplet.png +++ b/src/img/setup-digital-ocean/create-droplet.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:826d938cc9c4b0ba1084045341f52daa35af6cc1510d3f54a6ad16f28aeae881 -size 158494 +oid sha256:9bf7227b5f41b9eae8e4caf1974a0c5b1af00753ac97f39bcba8e09c73f97768 +size 130263 diff --git a/src/img/setup-digital-ocean/do-authentication.png b/src/img/setup-digital-ocean/do-authentication.png index 96aee0a5..5a1d050f 100644 --- a/src/img/setup-digital-ocean/do-authentication.png +++ b/src/img/setup-digital-ocean/do-authentication.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:148b4e8816f0d5eff1635ce612ead9b94591d29adeecd210d9cfa93b14bf66c2 -size 100111 +oid sha256:f99f70854043d73f8b18a059a44b5f095acd2ffe23b51d6526ae3557f004b022 +size 71508 diff --git a/src/img/setup-digital-ocean/do-check-logs.png b/src/img/setup-digital-ocean/do-check-logs.png new file mode 100644 index 00000000..06471d07 --- /dev/null +++ b/src/img/setup-digital-ocean/do-check-logs.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:671e9fbb06417879180efe4f8cb686aa0d2df6120aeaaab35ac50a77b3002d93 +size 22995 diff --git a/src/img/setup-digital-ocean/do-console-terminal.png b/src/img/setup-digital-ocean/do-console-terminal.png index 7860c71b..583dd848 100644 --- a/src/img/setup-digital-ocean/do-console-terminal.png +++ b/src/img/setup-digital-ocean/do-console-terminal.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:8d51e969b74ef9f0092f731513f63cfa5a358ba5c518ee8a4405e7369a635f8d -size 52885 +oid sha256:d347ab6758ecbaeacc8ffc7a2bc7f5bc153be20ebc9ed6cecf31ac6d4cee8735 +size 36377 diff --git a/src/img/setup-digital-ocean/do-console.png b/src/img/setup-digital-ocean/do-console.png index d01fd06b..fa4086b6 100644 --- a/src/img/setup-digital-ocean/do-console.png +++ b/src/img/setup-digital-ocean/do-console.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:4277cf7899800bf26131641cb07468c572132c0258d7f0a9b4101d07cca9b83c -size 123523 +oid sha256:f485ecbc9a37865c4767078598373af887395a94a400d1670f5a0e853ec4c874 +size 77773 diff --git a/src/img/setup-digital-ocean/do-distribution.png b/src/img/setup-digital-ocean/do-distribution.png index 1d93613f..dce624a0 100644 --- a/src/img/setup-digital-ocean/do-distribution.png +++ b/src/img/setup-digital-ocean/do-distribution.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:b79e2ff736732bf3ea77d33509fda4a7133ae3d6227c32940ff79206fd4458f2 -size 112602 +oid sha256:3b93ef8f7972bea9720523ad21f1c98ace5e2052bad758df210c0d7c78d93b5e +size 75955 diff --git a/src/img/setup-digital-ocean/do-droplets.png b/src/img/setup-digital-ocean/do-droplets.png index cd5921b7..2b9d57d1 100644 --- a/src/img/setup-digital-ocean/do-droplets.png +++ b/src/img/setup-digital-ocean/do-droplets.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:111881895c660aee445e10d23ffb8e692d246c1a95459d1ceee795bf4a8d5fe7 -size 111184 +oid sha256:e9243c9038c1dd36c5d408fddcdbf992e8d770fba5cfac127d20f2f4e7dd3def +size 71423 diff --git a/src/img/setup-digital-ocean/do-edit-firewall.png b/src/img/setup-digital-ocean/do-edit-firewall.png new file mode 100644 index 00000000..0c0da1b3 --- /dev/null +++ b/src/img/setup-digital-ocean/do-edit-firewall.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9aa7960443207436bb495399903a23963a7d0578beb945bdbdde55e1af98ea25 +size 46770 diff --git a/src/img/setup-digital-ocean/do-firewall.png b/src/img/setup-digital-ocean/do-firewall.png new file mode 100644 index 00000000..e03af261 --- /dev/null +++ b/src/img/setup-digital-ocean/do-firewall.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b295eef633ff930bff3fba1a27f8932866bbc68ee02d58064a629aa99f25b81e +size 60938 diff --git a/src/img/setup-digital-ocean/do-networking.png b/src/img/setup-digital-ocean/do-networking.png index c150ef86..c1d915ee 100644 --- a/src/img/setup-digital-ocean/do-networking.png +++ b/src/img/setup-digital-ocean/do-networking.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:a5e02457e184fde1ce0cacd46d20204687ced655028c2199b7984770d8630a16 -size 119386 +oid sha256:eae19faf9cee059584f5008d73ea47b189ac2ad40c798362c21cdef5da7ba3db +size 85177 diff --git a/src/img/setup-digital-ocean/do-plan.png b/src/img/setup-digital-ocean/do-plan.png index 0922d4e6..f62aeed3 100644 --- a/src/img/setup-digital-ocean/do-plan.png +++ b/src/img/setup-digital-ocean/do-plan.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:796a2e0aa6fbc3c4fbce69f2e49fb2bdd820c87f2ab67ad8809051fedc8bc7b5 -size 147129 +oid sha256:8de08c5ae377ed5b5e0ad9f0e2d6e3dcbc5da677c66d16f5218c97424edaef95 +size 81687 diff --git a/src/img/setup-digital-ocean/do-prompt.png b/src/img/setup-digital-ocean/do-prompt.png new file mode 100644 index 00000000..b454e656 --- /dev/null +++ b/src/img/setup-digital-ocean/do-prompt.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b53a9a61865dcdf5200298b9e5709a2fe7fae2fe97efbfe685ead3e5a8670594 +size 60988 diff --git a/src/img/setup-digital-ocean/do-run-script.png b/src/img/setup-digital-ocean/do-run-script.png new file mode 100644 index 00000000..aaa4456b --- /dev/null +++ b/src/img/setup-digital-ocean/do-run-script.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:006ff0b854b52118fb2a6b2b581d51c1c9cb37d9f2e885fbb9ec5dce4e602ffa +size 56280 diff --git a/src/img/setup-digital-ocean/do-userdata.png b/src/img/setup-digital-ocean/do-userdata.png index c251cb59..9c666349 100644 --- a/src/img/setup-digital-ocean/do-userdata.png +++ b/src/img/setup-digital-ocean/do-userdata.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:51c4154c220f26e79ed03880b28ba71536c849d1740f12e6a9146db66a53a1a5 -size 80531 +oid sha256:c7a27652b5b2214842778403b809e1a9090b852be1e1b562de0d251b126f650e +size 71539 diff --git a/src/img/setup-digital-ocean/do-userdata2.png b/src/img/setup-digital-ocean/do-userdata2.png index 35835125..826588c0 100644 --- a/src/img/setup-digital-ocean/do-userdata2.png +++ b/src/img/setup-digital-ocean/do-userdata2.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:079ea0e6fc06aa5f99fbcec5abe2334c16a360fe294233a6b46466486c4299e3 -size 105671 +oid sha256:8df029c83da84ffe3452326db7c59e360d07bec9df362570133f5cdb9d344a28 +size 78799 diff --git a/src/img/setup-digital-ocean/do10.png b/src/img/setup-digital-ocean/do10.png index e0a95412..e63f90c8 100644 --- a/src/img/setup-digital-ocean/do10.png +++ b/src/img/setup-digital-ocean/do10.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:83b56992f88b6fb76f106d555d8118c6933ebbc9bce0469d9d677a3c2f906839 -size 1200439 +oid sha256:80dca02e45cc7a29fb99788ddd4fb81791bf0197cb72c0c62c537b162676c429 +size 68095 diff --git a/src/img/setup-digital-ocean/do11.png b/src/img/setup-digital-ocean/do11.png index a190f262..b2c1e964 100644 --- a/src/img/setup-digital-ocean/do11.png +++ b/src/img/setup-digital-ocean/do11.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:0a3c5d87c2d89ef29ab7ce4db73954580ba909d503d5c3c68fc62fbe31ab951e -size 801591 +oid sha256:7505210a57ed5c7d960ceb60663027b6c29d53ecc221b18add95aa69ee21666e +size 54097 diff --git a/src/img/setup-digital-ocean/do12.png b/src/img/setup-digital-ocean/do12.png index 341a72b2..fbf149ac 100644 --- a/src/img/setup-digital-ocean/do12.png +++ b/src/img/setup-digital-ocean/do12.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:a58f55641d36e42cd4df88e26a9c2208b9803a0ee6fbbd193490c53f71bd45c6 -size 2226036 +oid sha256:da62ada8f5ed1896e24beb14f0ae6d029090e1e3e4b40853a05c9617f7403db8 +size 69900 diff --git a/src/img/setup-digital-ocean/do5.png b/src/img/setup-digital-ocean/do5.png index 0ee7b243..7c87d6be 100644 --- a/src/img/setup-digital-ocean/do5.png +++ b/src/img/setup-digital-ocean/do5.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:68da6943452b9d3e0189c24bb0121978632d637630195057af2ce2018676688b -size 868860 +oid sha256:168a9afa20eabcdca8f522e312b7669a4f0f434e2879772ed7f85b9267d4563a +size 51608 diff --git a/src/img/setup-digital-ocean/do6.png b/src/img/setup-digital-ocean/do6.png deleted file mode 100644 index 0f28e356..00000000 --- a/src/img/setup-digital-ocean/do6.png +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:aa3b25d9b94a87720aaf261c9677972c44038a30d083dd397025c861de3cf2c5 -size 439229 diff --git a/src/img/setup-digital-ocean/do7.png b/src/img/setup-digital-ocean/do7.png index 73bfe392..d3d95c19 100644 --- a/src/img/setup-digital-ocean/do7.png +++ b/src/img/setup-digital-ocean/do7.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:65d1fa130e8268362bcbe01ed16fe90e05f63b6693f61c5519236317a6e39356 -size 2420033 +oid sha256:d79c782539a04bcabd5a3c3e9fa70a00f9e47a95a7bbd7f9c09debe07327d730 +size 39749 diff --git a/src/img/setup-digital-ocean/do8.png b/src/img/setup-digital-ocean/do8.png index 7f551193..d456cf05 100644 --- a/src/img/setup-digital-ocean/do8.png +++ b/src/img/setup-digital-ocean/do8.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:ae7dcf5e9a8266a0b4ed0c654839a25be6eee12feb9e15f85d56b43aab83d9fe -size 633779 +oid sha256:442ec3dd1d97ea60d70310399f6cef0f5716f589cc531ca12130d1fb00b06e5c +size 76465 diff --git a/src/img/setup-digital-ocean/syncendpoint-droplet.png b/src/img/setup-digital-ocean/syncendpoint-droplet.png new file mode 100644 index 00000000..e0a3b05b --- /dev/null +++ b/src/img/setup-digital-ocean/syncendpoint-droplet.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8125a2bdfd42e46e5c5f7f61aa774eff6f528535491663bda349e8358c75cd74 +size 75006 diff --git a/src/img/ssh-tunneling/connect-to-server.png b/src/img/ssh-tunneling/connect-to-server.png new file mode 100644 index 00000000..28849751 --- /dev/null +++ b/src/img/ssh-tunneling/connect-to-server.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:83a750432bcb05983defd3e47209df322a8511021159e4507b75ddc811509e4d +size 49435 diff --git a/src/img/ssh-tunneling/local-access.png b/src/img/ssh-tunneling/local-access.png new file mode 100644 index 00000000..d456cf05 --- /dev/null +++ b/src/img/ssh-tunneling/local-access.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:442ec3dd1d97ea60d70310399f6cef0f5716f589cc531ca12130d1fb00b06e5c +size 76465 diff --git a/src/index.rst b/src/index.rst index 85161b47..215c6e88 100644 --- a/src/index.rst +++ b/src/index.rst @@ -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 diff --git a/src/ssh-tunneling.rst b/src/ssh-tunneling.rst new file mode 100644 index 00000000..9cb4c1dc --- /dev/null +++ b/src/ssh-tunneling.rst @@ -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 ::40000 @ + +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 `_ +- `Guide to Using SSH Port Forwarding (SSH Tunneling) `_ +- `SSH Tunneling: Examples, Command, Server Config `_ + +Feel free to explore these resources for a deeper understanding of SSH tunneling concepts and usage. \ No newline at end of file diff --git a/src/sync-endpoint-cloud-setup.rst b/src/sync-endpoint-cloud-setup.rst index 46ab3a2b..db9fca82 100644 --- a/src/sync-endpoint-cloud-setup.rst +++ b/src/sync-endpoint-cloud-setup.rst @@ -42,8 +42,8 @@ Option 1: DigitalOcean console | - :ref:`Setting up a DigitalOcean account ` | - :ref:`Setting up a Droplet, DigitalOcean’s name for a server you can access and manage ` | - :ref:`Setting up a DNS record ` -| - :ref:`Connecting to your Droplet ` | - :ref:`Enabling a firewall to prevent unintended traffic ` +| - :ref:`Connecting to your Droplet ` | - :ref:`Launching the ODK-X Server ` .. _sync-endpoint-setup-digital-ocean-account: @@ -63,7 +63,7 @@ Setting up a Droplet .. image:: /img/setup-digital-ocean/create-droplet.png :width: 600 -2. In the Distributions tab, on the :guilabel:`Create Droplet` screen; select *18.04 (LTS) x64* under the Ubuntu dropdown. Next, choose a plan and data center region based on your needs. +2. On the :guilabel:`Create Droplets` screen, select a region. On the OS tab, select *Ubuntu* then select *22.04 (LTS) x64* as the version. Next, choose a plan based on your needs. .. note:: Sync Endpoint requires more than *2GB* of space to run, this means that plans below *4GB* will not work. @@ -74,7 +74,14 @@ Setting up a Droplet .. image:: /img/setup-digital-ocean/do-plan.png :width: 600 -3. Scroll down to the :guilabel:`Select additional options`, click on the User data checkbox, copy and paste the contents of the :download:`cloud_init_DO.yml` file in the text area provided. +3. The next step is :guilabel:`Authentication`. There are two authentication types to select from; **SSH Keys** and **Password**. We highly recommend that you use an SSH key for authentication. Copy and paste your SSH key username, and the key itself. + + You can refer to this guide on `creating an SSH key `_ for detailed instructions. + + .. image:: /img/setup-digital-ocean/do-authentication.png + :width: 600 + +4. Scroll down to the :guilabel:`Advanced options`, click on the *Add Initialization scripts (free)* checkbox, copy and paste the contents of the :download:`cloud_init_DO.yml` file in the text area provided. .. image:: /img/setup-digital-ocean/do-userdata.png :width: 600 @@ -82,52 +89,73 @@ Setting up a Droplet .. image:: /img/setup-digital-ocean/do-userdata2.png :width: 600 -4. The next step is :guilabel:`Authentication`. There are two authentication types to select from; **SSH Keys** and **Password**. We highly recommend that you use an SSH key for authentication. Copy and paste your SSH key username, and the key itself. - - Use the `following resource `_ to learn more about creating an SSH key. - - .. image:: /img/setup-digital-ocean/do-authentication.png - :width: 600 +5. After adding the initialization script, scroll down to :guilabel:`Finalize Details`. Enter a name for the droplet and click on the :guilabel:`Create Droplet` button. This might take a few minutes to set up. -5. After the authentication is set up, you can choose to name the droplet; then scroll down and click the :guilabel:`Create Droplet` button. This might take a few minutes to set up. + .. image:: /img/setup-digital-ocean/click-create-droplet.png + :width: 600 .. _sync-endpoint-setup-digital-ocean-dns: Setting up a DNS Record """""""""""""""""""""""" -1. On the resources tab of the main DigitalOcean page, click on the :guilabel:`Droplet` you created. +1. On the resources tab of the main DigitalOcean page, hover over the IP address of the droplet you just created and click on the :guilabel:`Copy` text that shows up to copy the IP address of the droplet. .. image:: /img/setup-digital-ocean/do-droplets.png :width: 600 -2. Obtain the IP address of the droplet you created. +2. Log into your account for your domain name registrar and DNS provider. See :ref:`Acquiring a domain name` for more information and a list of registrars and DNS providers. -3. Log into your account for your domain name registrar and DNS provider. See :ref:`Acquiring a domain name` for more information and a list of registrars and DNS providers. +3. Add a dns 'A' record for the domain or subdomain you would like to use for the Sync Endpoint with your droplet's IP address. -4. Add a dns 'A' record for the domain or subdomain you would like to use for the Sync Endpoint with your droplet's IP address. - -.. _sync-endpoint-setup-digital-ocean-connecting: +.. _sync-endpoint-setup-digital-ocean-firewall: -Connecting to your Droplet -""""""""""""""""""""""""""""" +Enabling a firewall to prevent unintended traffic +""""""""""""""""""""""""""""""""""""""""""""""""""" 1. On the resources tab of the main DigitalOcean page, click on the :guilabel:`Droplet` you created. - .. image:: /img/setup-digital-ocean/do-droplets.png + .. image:: /img/setup-digital-ocean/syncendpoint-droplet.png + :width: 600 + +2. On the droplet page, click on :guilabel:`Networking`, this will take you to the droplet's networking page. + .. image:: /img/setup-digital-ocean/do-networking.png + :width: 600 + +3. Next, scroll down to the :guilabel:`Firewalls` section and click on the :guilabel:`Edit` button. + + .. image:: /img/setup-digital-ocean/do-edit-firewall.png + :width: 600 + +4. On the :guilabel:`Firewalls` tab of the :guilabel:`Networking` page, and click on the :guilabel:`Create Firewall` button. + + .. image:: /img/setup-digital-ocean/do-firewall.png :width: 600 -2. Now, click on the :guilabel:`Console` link in the upper-right corner of the page +5. Set a name for your firewall and modify the inbound rules to match the inbound rules specified in the picture below (SSH, HTTP, and HTTPS). Attach the firewall to the desired droplet. Leave the outbound rules as-is and click on the :guilabel:`Create Firewall` button. + + .. image:: /img/setup-digital-ocean/do10.png + :width: 600 + + .. image:: /img/setup-digital-ocean/do11.png + :width: 600 + +.. _sync-endpoint-setup-digital-ocean-connecting: + +Connecting to your Droplet +""""""""""""""""""""""""""""" + +1. On the droplet page, click on the :guilabel:`Console` link in the upper-right corner of the page .. image:: /img/setup-digital-ocean/do-console.png :width: 600 -3. A console window will now open up. If you chose the **password** authentication, you will be asked to enter your username and then asked for a password. +2. A console window will now open up. If you chose the **password** authentication, you will be asked to enter your username and then asked for a password. .. image:: /img/setup-digital-ocean/do-console-terminal.png :width: 600 -4. Before running our launch scripts, we need to check our logs to ensure that all the packages have been successfully installed, which should take about 2-3 minutes. The droplet may also reboot in this time. +3. Before running our launch scripts, you need to check your logs to ensure that all the packages have been successfully installed, which should take about 2-3 minutes. The droplet may also reboot in this time. | Use the following command to get into the log directory. @@ -141,14 +169,17 @@ Connecting to your Droplet $ tail cloud-init-output.log + .. image:: /img/setup-digital-ocean/do-check-logs.png + :width: 600 + If you see the message **“The system is finally up, after X seconds”** you can proceed to the next step! Otherwise, continue to wait and check the log file again. -5. In order to run our launch scripts, we must first navigate back to +4. In order to run our launch scripts, we must first navigate back to the root directory with the following command: .. code-block:: console - $ cd /home/ubuntu + $ cd /home/root Now, we can run our build scripts with the command: @@ -156,28 +187,32 @@ Connecting to your Droplet $ ./script_to_run.sh + .. image:: /img/setup-digital-ocean/do-run-script.png + :width: 600 + The script will ask you for the server's domain and an administration email address to configure https on the server. + .. image:: /img/setup-digital-ocean/do-prompt.png + :width: 600 + After gathering this data the script will begin the install and you should see a bunch of statements executing in your console. Wait approximately 5-10 minutes for the installation to complete. - .. image:: /img/setup-digital-ocean/do5.png - :width: 600 - Once all the services have been created, we need to check if all the services are running properly with the command: .. code-block:: console $ docker stack ls - If there are 8 (or 7 without https) services running under the name `syncldap`, everything is running properly. + .. image:: /img/setup-digital-ocean/do5.png + :width: 600 -6. From the **Droplets** section of the console, obtain the IP address of the droplet you created. Now, navigate to https://[IP_ADDRESS]:40000 within your browser in order to access the services screen. It will warn you about your connection not being private but should give you the option to proceed at the bottom. + If there are 9 (or 7 without https) services running under the name `syncldap`, everything is running properly. +5. Next, set up SSH tunneling for the Sync Endpoint admin portal. This is the recommended method of accessing the admin interface rather than leaving port 40000 open on the firewall. You can find detailed instructions on how you can do this on the :ref:SSH tunneling page. - .. image:: /img/setup-digital-ocean/do6.png - :width: 600 +6. Now, navigate to https://localhost:local_port within your browser in order to access the services screen. It will warn you about your connection not being private but should give you the option to proceed at the bottom. .. image:: /img/setup-digital-ocean/do7.png :width: 600 @@ -189,29 +224,6 @@ Connecting to your Droplet 8. Read our section on :ref:`Creating a Sample User ` to learn how to create a user from within the admin interface. -.. _sync-endpoint-setup-digital-ocean-firewall: - -Enabling a firewall to prevent unintended traffic -""""""""""""""""""""""""""""""""""""""""""""""""""" - -1. On the DigitalOcean console, click on the arrow beside the **MANAGE** dropdown and navigate to the *Networking* section. Go to the *Firewalls* section and click :guilabel:`Create Firewall`. - - .. image:: /img/setup-digital-ocean/do-networking.png - :width: 600 - -2. Set a name for your firewall and modify the inbound rules to match the inbound rules specified in the picture below (SSH, HTTP, HTTPS and port for admin interface). Attach the firewall to the desired droplet. Leave the outbound rules as-is. - - .. image:: /img/setup-digital-ocean/do10.png - :width: 600 - - .. image:: /img/setup-digital-ocean/do11.png - :width: 600 - -3. After going through the instructions for “Creating a Sample User,” we no longer need access to this admin interface anymore. This admin interface is running on port 40000, and in order to ensure that this admin interface is not publicly accessible to anyone, we want to remove the rule that accepts incoming traffic to that port. Go ahead and remove the following rule: - - .. image:: /img/setup-digital-ocean/do12.png - :width: 600 - .. _sync-endpoint-setup-digital-ocean-launching: Launching the ODK-X Server @@ -296,11 +308,6 @@ Setting up a virtual machine .. image:: /img/setup-azure/azure10.png :width: 600 -7. In order to modify the firewall settings and change the type of incoming traffic we want to allow, we need to modify the **Networking** settings of our VM. Navigate to this section, and add an extra inbound security rule to allow traffic on port 40000. Leave the outbound rules unchanged. - - .. image:: /img/setup-azure/azure11.png - :width: 600 - .. _sync-endpoint-setup-azure-dns: Setting up a DNS Record @@ -398,7 +405,7 @@ Connecting to your virtual machine There should be 9 services (or 7 without https) as shown by docker stack ls while 7 services (or 6 without https) actively running as shown by the command ``docker ps``. -5. After obtaining the IP address of the virtual machine you created, navigate to https://[IP_ADDRESS]:40000 within your browser in order to access the services screen. It will warn you about your connection not being private but should give you the option to proceed at the bottom. +5. Next, set up SSH tunneling for the Sync Endpoint admin portal. This is the recommended method of accessing the admin interface rather than leaving port 40000 (the port on which the admin portal is running) open on the firewall. This ensures that the admin interface is not publicly accessible. Detailed instructions on how to set up SSH tunneling can be found on the :ref:`SSH tunneling ` page. .. image:: /img/setup-azure/azure14.png :width: 600 @@ -410,8 +417,6 @@ Connecting to your virtual machine 7. Read our section on :ref:`Creating a Sample User ` to learn how to create a user from within the admin interface. -8. After going through the instructions for *Creating a Sample User,* we no longer need access to this admin interface anymore. This admin interface is running on port 40000, and in order to ensure that this admin interface is not publicly accessible to anyone, we want to remove the rule that accepts incoming traffic to that port. We do this the same way we added the rules above. - .. _sync-endpoint-setup-azure-launch: Launching the ODK-X Server @@ -583,7 +588,7 @@ Connecting to your virtual machine .. image:: /img/setup-aws/services.png :width: 600 -5. After obtaining the IP address of the virtual machine you created, navigate to https://[IP_ADDRESS]:40000 within your browser in order to access the services screen. It will warn you about your connection not being private but should give you the option to proceed at the bottom. +5. Next, set up SSH tunneling for the Sync Endpoint admin portal. This is the recommended method of accessing the admin interface rather than adding a rule that accepts incoming traffic to the admin interface port(port 40000) on the firewall. This ensures that the admin interface is not publicly accessible. Detailed instructions on how to set up SSH tunneling can be found on the :ref:`SSH tunneling ` page. .. image:: /img/setup-aws/aws19.png :width: 600 @@ -595,8 +600,6 @@ Connecting to your virtual machine 7. Read our section on :ref:`Creating a Sample User ` to learn how to create a user from within the admin interface. -8. After going through the instructions for *Creating a Sample User,* we no longer need access to this admin interface anymore. This admin interface is running on port 40000, and in order to ensure that this admin interface is not publicly accessible to anyone, we want to remove the rule that accepts incoming traffic to that port. We do this the same way we added the rules above. - .. _sync-endpoint-setup-aws-launch: Launching the ODK-X Server