Start9/documentation
2
0
Fork 0
mirror of https://github.com/Start9Labs/documentation.git synced 2026-03-30 04:01:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

a bunch of changes

Browse Source
This commit is contained in:
Matt Hill
2022-02-23 15:58:41 -07:00
parent df6cc9b23f
commit 659ca38d6e
86 changed files with 979 additions and 1215 deletions
Download Patch File Download Diff File Expand all files Collapse all files

68
site/source/user-manual/ssh.rst
View File

@@ -4,21 +4,20 @@
Using SSH
=========
.. warning:: This is an advanced feature and should be used with caution. Start9 is not responsible for any damage you might cause while using SSH access.
Creating an SSH Key
-------------------
.. tip:: An ED25519 key is strongly recommended. If you have issues with any other type of key, please consider using an ED25519.
@TODO
Setting Up SSH Access
---------------------
Registering an SSH Key
----------------------
Connecting via CLI (Linux / Mac)
================================
#. Navigate to the *Embassy > SSH*.
#. Click "Add New Key".
#. Paste in your SSH *public* key (created above) and click "Submit".
#. Navigate to the ``Embassy`` tab, then under ``Settings``, click ``SSH``
#. Click the ``+ Add New Key`` button
#. Paste in your SSH public key and hit ``Submit``
.. tip:: This is typically found under your ``home`` in the ``.ssh`` directory and the file should end in ``.pub`` - copy the entire contents of the file.
Connecting via CLI on Linux/Mac
-------------------------------
#. You can now access your Embassy from the command line (Linux and Mac) using:
@@ -28,22 +27,22 @@ Connecting via CLI (Linux / Mac)
Replacing ``<LAN URL>`` with your Embassy's LAN (``embassy-xxxxxxx.local``) address
Connecting via SSH on Windows, using PuTTY
==========================================
Connecting via PuTTY on Windows
-------------------------------
One of our community members, `@brewsbitcoin <https://twitter.com/brewsbitcoin>`_ (https://brewsbitcoin.com/), has put together this `Guide <https://medium.com/@brewsbitcoin/ssh-to-start9-embassy-from-windows-4a4e17891b5a>`_ for connecting via PuTTY on Windows.
@TODO
Setting Up Remote SSH Access (Tor)
----------------------------------
Using SSH Over Tor
------------------
.. note:: The following guide requires that you have already added an `SSH key to your Embassy<ssh>`.
.. note:: The following guide requires that you have already added an :ref:`SSH key to your Embassy<ssh>`.
This guide will allow you remote SSH access via Tor. Currently only supported on Linux, but may work on Windows with `Torifier <https://torifier.com/>`_. Currently, this setup will not persist after a reboot.
.. caution:: SSH over Tor is only supported on Linux, though it may also work on Windows with `Torifier <https://torifier.com/>`_.
Setup
=====
.....
#. First, you'll need one dependency, ``torsocks``, which will allow you to use SSH over Tor on the machine that you want access with. Select your Linux flavor to install:
#. First, you'll need one dependency, ``torsocks``, which will allow you to use SSH over Tor on the machine that you want access with. Select your Linux flavor to install:
.. tabs::
@@ -61,42 +60,41 @@ Setup
#. SSH in:
.. warning:: The changes you make here are on the overlay and won't persist after a restart of your Embassy.
.. code-block:: bash
ssh root@embassy-xxxxxxx.local
#. Add the following 2 lines to ``/etc/tor/torrc`` **EITHER** by using your preferred text editor (such as ``nano`` or ``vim``):
``HiddenServiceDir /var/lib/tor/ssh``
``HiddenServicePort 22 127.0.0.1:22``
**OR** by entering the following 2 commands:
#. Using Vim or Nano, add the following 2 lines to ``/etc/tor/torrc``
.. code-block:: bash
echo "HiddenServiceDir /var/lib/tor/ssh" >> /etc/tor/torrc
echo "HiddenServicePort 22 127.0.0.1:22" >> /etc/tor/torrc
HiddenServiceDir /var/lib/tor/ssh
HiddenServicePort 22 127.0.0.1:22
#. Then reload the Tor configuration with your edits:
.. tip:: You can also add these lines by running the following command:
.. code-block:: bash
echo "HiddenServiceDir /var/lib/tor/ssh" >> /etc/tor/torrc && echo "HiddenServicePort 22 127.0.0.1:22" >> /etc/tor/torrc
#. Reload the Tor configuration with your edits:
.. code-block:: bash
systemctl reload tor
#. Next, gather the ``.onion`` address you just created:
#. Gather the ".onion" address you just created:
.. code-block:: bash
cat /var/lib/tor/ssh/hostname
.. note:: All these changes are on the overlay and won't persist after a restart of your Embassy
#. Add an additional SSH key in your EmbassyUI if you want to access from a machine other than the one you did this setup with.
Access
======
Now to log in, simply use the following command, using the ``.onion`` hostname you printed above:
To log in, simply use the following command, using the ".onion" hostname you printed above:
.. code-block::