mirror of
https://github.com/Start9Labs/documentation.git
synced 2026-03-26 10:21:53 +00:00
Refactor device guides
This commit is contained in:
kn0wmad
@@ -6,47 +6,17 @@ EmbassyD
|
||||
|
||||
.. warning:: This is for advanced users only!! Anything you do while SSH'd into your Embassy is NOT SUPPORTED, unless under the guidance of a Start9 technician.
|
||||
|
||||
.. When interacting with Embassy directly, you will invariably want to use ``embassy-cli``. Embassy-CLI can control EmbassyOS in many of the same ways that the UI can, but with finer controls and deeper insights.
|
||||
EmbassyD is the daemon that runs everything that could be considered EmbassyOS.
|
||||
|
||||
.. In order to use Embassy-CLI, you will first need to authorize yourself with the following command...
|
||||
When SSH'd into your Embassy, you may see the status of EmbassyD with the following:
|
||||
|
||||
.. .. code-block:: bash
|
||||
.. code-block:: bash
|
||||
|
||||
.. embassy-cli auth login
|
||||
systemctl status embassyd
|
||||
|
||||
.. and enter your Embassy Master Password at the prompt.
|
||||
If you need to restart the daemon for some reason, you can do so with:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
.. You can enter ``embassy-cli help`` or ``embassy-cli <option> help`` to get an overview of capabilities:
|
||||
|
||||
.. .. code-block:: bash
|
||||
|
||||
.. Embassy CLI
|
||||
|
||||
.. USAGE:
|
||||
.. embassy-cli [OPTIONS] <SUBCOMMAND>
|
||||
|
||||
.. FLAGS:
|
||||
.. --help Prints help information
|
||||
.. -V, --version Prints version information
|
||||
|
||||
.. OPTIONS:
|
||||
.. -c, --config <config>
|
||||
.. -h, --host <host>
|
||||
.. -p, --proxy <proxy>
|
||||
|
||||
.. SUBCOMMANDS:
|
||||
.. auth Login/logout and manage sessions
|
||||
.. backup Manage backups
|
||||
.. db Interact with the Database
|
||||
.. disk Information on the external drive
|
||||
.. echo Echoes
|
||||
.. git-info Print the current git hash
|
||||
.. help Prints this message or the help of the given subcommand(s)
|
||||
.. inspect Details on services and their components
|
||||
.. net Network information
|
||||
.. notification Control UI notifications
|
||||
.. package Interact with packages
|
||||
.. server EmbassyOS operations and information
|
||||
.. ssh Manage SSH keys
|
||||
.. wifi Manage WiFi networks
|
||||
systemctl restart embassyd
|
||||
|
||||
@@ -4,6 +4,4 @@
|
||||
Android
|
||||
=======
|
||||
|
||||
If you are running Android 12, you can setup :ref:`Local Access<lan>`, please see :ref:`Android Limitations <lim-android>` for more details on devices that have this capability.
|
||||
|
||||
|
||||
If you are running Android 12+, you can setup :ref:`Local Access<lan>`, please see :ref:`Android Limitations <lim-android>` for more details on devices that have this capability.
|
||||
|
||||
@@ -4,14 +4,26 @@
|
||||
Android
|
||||
=======
|
||||
|
||||
.. note:: Please see Android's :ref:`Known Limitations<lim-android>` to understand what is currently not possible on these devices
|
||||
.. tip:: Please see Android's :ref:`Known Limitations<lim-android>` to understand what is currently not possible on these devices
|
||||
|
||||
Tor Setup (Connectivity)
|
||||
------------------------
|
||||
|
||||
`Setup Tor <docs.start9.com/user-manual/configuration/tor-setup/tor-os/tor-android>`_ to run natively (in the background) on your device. This will allow you to use applications on your Android via the :ref:`Tor Network<tor>` so they can communicate with your Embassy.
|
||||
.. topic-box::
|
||||
:title: LAN Setup (Connectivity, Performance)
|
||||
:link: https://start9.com/latest/support/user-manual/configuration/lan-setup/lan-android
|
||||
:anchor: Setup
|
||||
|
||||
Tor Firefox Config (Connectivity)
|
||||
---------------------------------
|
||||
For a fast and secure connection while on your Embassy's local network
|
||||
|
||||
`Configure Firefox <docs.start9.com/user-manual/configuration/tor-setup/tor-firefox/torff-android>`_ to be able to use the :ref:`Tor Network<tor>` so that you can reach ``.onion`` sites without needing to change browsers.
|
||||
.. topic-box::
|
||||
:title: Tor Setup (Connectivity)
|
||||
:link: https://start9.com/latest/support/user-manual/configuration/tor-setup/tor-os/tor-android
|
||||
:anchor: Setup
|
||||
|
||||
Run Tor natively (in the background) on your device. This will allow you to use applications on your Windows machine via the Tor Network so they can communicate with your Embassy.
|
||||
|
||||
.. topic-box::
|
||||
:title: Tor Firefox Config (Connectivity)
|
||||
:link: https://start9.com/latest/support/user-manual/configuration/tor-setup/tor-firefox/torff-android
|
||||
:anchor: Configure
|
||||
|
||||
Configure Firefox to use the Tor Network so that you can reach ``.onion`` sites without needing to change browsers.
|
||||
|
||||
@@ -4,9 +4,11 @@
|
||||
iOS
|
||||
===
|
||||
|
||||
.. note:: Please see iOS's :ref:`Known Limitations<lim-ios>` to understand what is currently not possible on these devices
|
||||
.. tip:: Please see iOS's :ref:`Known Limitations<lim-ios>` to understand what is currently not possible on these devices
|
||||
|
||||
LAN Setup (Connectivity, Performance)
|
||||
-------------------------------------
|
||||
.. topic-box::
|
||||
:title: LAN Setup (Connectivity, Performance)
|
||||
:link: https://start9.com/latest/support/user-manual/configuration/lan-setup/lan-ios
|
||||
:anchor: Setup
|
||||
|
||||
`Setup LAN Access <docs.start9.com/user-manual/configuration/lan-setup/lan-ios>`_ for a fast and secure connection while on your Embassy's local network.
|
||||
For a fast and secure connection while on your Embassy's local network
|
||||
|
||||
@@ -4,24 +4,32 @@
|
||||
Linux Guides
|
||||
============
|
||||
|
||||
.. note:: Please see Linux's :ref:`Known Limitations<lim-linux>` to understand what is currently not possible on these devices
|
||||
.. tip:: Please see Linux's :ref:`Known Limitations<lim-linux>` to understand what is currently not possible on these devices
|
||||
|
||||
LAN Setup (Connectivity, Performance)
|
||||
-------------------------------------
|
||||
.. topic-box::
|
||||
:title: LAN Setup (Connectivity, Performance)
|
||||
:link: https://start9.com/latest/support/user-manual/configuration/lan-setup/lan-linux
|
||||
:anchor: Setup
|
||||
|
||||
`Setup LAN Access <https://docs.start9.com/support/user-manual/configuration/lan-setup/lan-linux>`_ for a fast and secure connection while on your Embassy's local network.
|
||||
For a fast and secure connection while on your Embassy's local network
|
||||
|
||||
Tor Setup (Connectivity)
|
||||
------------------------
|
||||
.. topic-box::
|
||||
:title: Tor Setup (Connectivity)
|
||||
:link: https://start9.com/latest/support/user-manual/configuration/tor-setup/tor-os/tor-linux
|
||||
:anchor: Setup
|
||||
|
||||
`Setup Tor <https://docs.start9.com/support/user-manual/configuration/tor-setup/tor-os/tor-linux>`_ to run natively (in the background) on your device. This will allow you to use applications on your Linux machine via the :ref:`Tor Network<tor>` so they can communicate with your Embassy.
|
||||
Run Tor natively (in the background) on your device. This will allow you to use applications on your Windows machine via the Tor Network so they can communicate with your Embassy.
|
||||
|
||||
Tor Firefox Config (Connectivity)
|
||||
---------------------------------
|
||||
.. topic-box::
|
||||
:title: Tor Firefox Config (Connectivity)
|
||||
:link: https://start9.com/latest/support/user-manual/configuration/tor-setup/tor-firefox/torff-linux
|
||||
:anchor: Configure
|
||||
|
||||
`Configure Firefox <https://docs.start9.com/support/user-manual/configuration/tor-setup/tor-firefox/torff-linux>`_ to be able to use the :ref:`Tor Network<tor>` so that you can reach ``.onion`` sites without needing to change browsers.
|
||||
Configure Firefox to use the Tor Network so that you can reach ``.onion`` sites without needing to change browsers.
|
||||
|
||||
Embassy Backups (Reliability)
|
||||
-----------------------------
|
||||
.. topic-box::
|
||||
:title: Embassy Backups (Resilience)
|
||||
:link: https://start9.com/latest/support/user-manual/walkthrough/backup/backup-lin
|
||||
:anchor: Backup
|
||||
|
||||
`Configure Remote Backup <https://docs.start9.com/support/user-manual/walkthrough/backup/backup-lin>`_ of your Embassy to your Linux machine. **Backups are supremely important** as they ensure redundancy of your data for convenience, as well as preventing loss in case of disaster.
|
||||
Configure remote backups of your Embassy to your Windows machine. **Backups are supremely important** as they ensure redundancy of your data for convenience, as well as preventing loss in case of disaster.
|
||||
|
||||
@@ -4,24 +4,32 @@
|
||||
Mac
|
||||
===
|
||||
|
||||
.. note:: Please see Mac's :ref:`Known Limitations<lim-mac>` to understand what is currently not possible on these devices
|
||||
.. tip:: Please see Mac's :ref:`Known Limitations<lim-mac>` to understand what is currently not possible on these devices
|
||||
|
||||
LAN Setup (Connectivity, Performance)
|
||||
-------------------------------------
|
||||
.. topic-box::
|
||||
:title: LAN Setup (Connectivity, Performance)
|
||||
:link: https://start9.com/latest/support/user-manual/configuration/lan-setup/lan-mac
|
||||
:anchor: Setup
|
||||
|
||||
`Setup LAN Access <https://docs.start9.com/support/user-manual/configuration/lan-setup/lan-mac>`_ for a fast and secure connection while on your Embassy's local network.
|
||||
For a fast and secure connection while on your Embassy's local network
|
||||
|
||||
Tor Setup (Connectivity)
|
||||
------------------------
|
||||
.. topic-box::
|
||||
:title: Tor Setup (Connectivity)
|
||||
:link: https://start9.com/latest/support/user-manual/configuration/tor-setup/tor-os/tor-mac
|
||||
:anchor: Setup
|
||||
|
||||
`Setup Tor <https://docs.start9.com/support/user-manual/configuration/tor-setup/tor-os/tor-mac>`_ to run natively (in the background) on your device. This will allow you to use applications on your Mac via the :ref:`Tor Network<tor>` so they can communicate with your Embassy.
|
||||
Run Tor natively (in the background) on your device. This will allow you to use applications on your Windows machine via the Tor Network so they can communicate with your Embassy.
|
||||
|
||||
Tor Firefox Config (Connectivity)
|
||||
---------------------------------
|
||||
.. topic-box::
|
||||
:title: Tor Firefox Config (Connectivity)
|
||||
:link: https://start9.com/latest/support/user-manual/configuration/tor-setup/tor-firefox/torff-mac
|
||||
:anchor: Configure
|
||||
|
||||
`Configure Firefox <https://docs.start9.com/support/user-manual/configuration/tor-setup/tor-firefox/torff-mac>`_ to be able to use the :ref:`Tor Network<tor>` so that you can reach ``.onion`` sites without needing to change browsers.
|
||||
Configure Firefox to use the Tor Network so that you can reach ``.onion`` sites without needing to change browsers.
|
||||
|
||||
Embassy Backups (Reliability)
|
||||
-----------------------------
|
||||
.. topic-box::
|
||||
:title: Embassy Backups (Resilience)
|
||||
:link: https://start9.com/latest/support/user-manual/walkthrough/backup/backup-mac
|
||||
:anchor: Backup
|
||||
|
||||
`Configure Remote Backup <https://docs.start9.com/support/user-manual/walkthrough/backup/backup-mac>`_ of your Embassy to your Mac device. **Backups are supremely important** as they ensure redundancy of your data for convenience, as well as preventing loss in case of disaster.
|
||||
Configure remote backups of your Embassy to your Windows machine. **Backups are supremely important** as they ensure redundancy of your data for convenience, as well as preventing loss in case of disaster.
|
||||
@@ -4,7 +4,7 @@
|
||||
Windows
|
||||
=======
|
||||
|
||||
.. note:: Please see Window's :ref:`Known Limitations<lim-windows>` to understand what is currently not possible on these devices.
|
||||
.. tip:: Please see Window's :ref:`Known Limitations<lim-windows>` to understand what is currently not possible on these devices.
|
||||
|
||||
.. topic-box::
|
||||
:title: LAN Setup (Connectivity, Performance)
|
||||
|
||||
Reference in New Issue
Block a user