diff --git a/site/source/_static/images/config/basic-config0.png b/site/source/_static/images/config/basic-config0.png new file mode 100644 index 0000000..b6d27e0 Binary files /dev/null and b/site/source/_static/images/config/basic-config0.png differ diff --git a/site/source/_static/images/config/basic-config1.png b/site/source/_static/images/config/basic-config1.png new file mode 100644 index 0000000..1da7bf1 Binary files /dev/null and b/site/source/_static/images/config/basic-config1.png differ diff --git a/site/source/_static/images/config/basic-config2.png b/site/source/_static/images/config/basic-config2.png new file mode 100644 index 0000000..6489e88 Binary files /dev/null and b/site/source/_static/images/config/basic-config2.png differ diff --git a/site/source/_static/images/config/basic-config3.png b/site/source/_static/images/config/basic-config3.png new file mode 100644 index 0000000..6f23dd4 Binary files /dev/null and b/site/source/_static/images/config/basic-config3.png differ diff --git a/site/source/_static/images/config/basic-config4.png b/site/source/_static/images/config/basic-config4.png new file mode 100644 index 0000000..1e3ac9e Binary files /dev/null and b/site/source/_static/images/config/basic-config4.png differ diff --git a/site/source/_static/images/config/wifi0.png b/site/source/_static/images/config/wifi0.png new file mode 100644 index 0000000..e8f0740 Binary files /dev/null and b/site/source/_static/images/config/wifi0.png differ diff --git a/site/source/_static/images/config/wifi1.png b/site/source/_static/images/config/wifi1.png new file mode 100644 index 0000000..6cca137 Binary files /dev/null and b/site/source/_static/images/config/wifi1.png differ diff --git a/site/source/_static/images/config/wifi2.png b/site/source/_static/images/config/wifi2.png new file mode 100644 index 0000000..e3948ef Binary files /dev/null and b/site/source/_static/images/config/wifi2.png differ diff --git a/site/source/_static/images/config/wifi3.png b/site/source/_static/images/config/wifi3.png new file mode 100644 index 0000000..c6aa71e Binary files /dev/null and b/site/source/_static/images/config/wifi3.png differ diff --git a/site/source/_static/images/setup/setup0.png b/site/source/_static/images/setup/setup0.png new file mode 100644 index 0000000..58df9e5 Binary files /dev/null and b/site/source/_static/images/setup/setup0.png differ diff --git a/site/source/_static/images/setup/setup1.png b/site/source/_static/images/setup/setup1.png new file mode 100644 index 0000000..5c148bd Binary files /dev/null and b/site/source/_static/images/setup/setup1.png differ diff --git a/site/source/_static/images/setup/setup2.png b/site/source/_static/images/setup/setup2.png new file mode 100644 index 0000000..bd1bb30 Binary files /dev/null and b/site/source/_static/images/setup/setup2.png differ diff --git a/site/source/_static/images/setup/setup3.png b/site/source/_static/images/setup/setup3.png new file mode 100644 index 0000000..d471b11 Binary files /dev/null and b/site/source/_static/images/setup/setup3.png differ diff --git a/site/source/_static/images/setup/setup4.png b/site/source/_static/images/setup/setup4.png new file mode 100644 index 0000000..40bf7a2 Binary files /dev/null and b/site/source/_static/images/setup/setup4.png differ diff --git a/site/source/_static/images/setup/setup5.png b/site/source/_static/images/setup/setup5.png new file mode 100644 index 0000000..b4797d3 Binary files /dev/null and b/site/source/_static/images/setup/setup5.png differ diff --git a/site/source/dev-docs/dev-faq/faq-contributing.rst b/site/source/dev-docs/dev-faq/faq-contributing.rst index 86811e5..32e0a77 100644 --- a/site/source/dev-docs/dev-faq/faq-contributing.rst +++ b/site/source/dev-docs/dev-faq/faq-contributing.rst @@ -12,13 +12,18 @@ Do I need to be a professional developer or have coding experience to contribute --------------------------------------------------------------------------------- Absolutely not! Contributions can be as simple as finding a typo in our docs, making a suggestion on GitHub, creating educational or promotional content, and the list goes on! Everyone that wants to contribute can do so in some unique way. Please don't hesitate to ***CONTACT LINK*** us for ideas if you're not sure where to begin. +The guide says that a Makefile is optional, why is this? +-------------------------------------------------------- +The ``Makefile`` simplifies the development process by putting all your build steps into one place so that you can simply use the ``make`` to build with. A ``Makefile`` is not required however, and you may instead choose to use something like ``nix``, ``bash``, ``perl``, ``python``, or ``ruby`` for your build orchestration. + Expound the following into FAQs move to other dev-faq section if necessary: --------------------------------------------------------------------------- - Release notes need to be in quotations? As it is a string? (they aren’t by default) – this is a yaml thing and SOMETIMES they are required and SOMETIMES NOT -- Ports in manifest – can leave as default (80), as it is a docker container?? - Sure -- Type definitions – is this just for dependencies? Can a blurb be added here for extra clarity? - Alerts in LND example are not wrapped in quotes, same with CUPS release notes – yaml thing +- Ports in manifest – can leave as default (80), as it is a docker container?? - Sure + +- Type definitions – is this just for dependencies? Can a blurb be added here for extra clarity? - Config spec – Admin pass? - Makefile - Not required, but simplifies dev process diff --git a/site/source/dev-docs/dev-faq/faq-service-packaging.rst b/site/source/dev-docs/dev-faq/faq-service-packaging.rst index d76027e..ec9dba0 100644 --- a/site/source/dev-docs/dev-faq/faq-service-packaging.rst +++ b/site/source/dev-docs/dev-faq/faq-service-packaging.rst @@ -1,5 +1,9 @@ .. _faq-service-packaging: +.. contents:: + :depth: 3 + :local: + ===================== Service Packaging FAQ ===================== diff --git a/site/source/dev-docs/dev-faq/index.rst b/site/source/dev-docs/dev-faq/index.rst index 529b339..3e4876d 100644 --- a/site/source/dev-docs/dev-faq/index.rst +++ b/site/source/dev-docs/dev-faq/index.rst @@ -7,7 +7,7 @@ Developer FAQ Frequently Asked Questions by and for developers. If you have a suggestion, please use the Github link at the top of the page. .. toctree:: - :hidden: + :maxdepth: 3 faq-contributing faq-service-packaging diff --git a/site/source/dev-docs/index.rst b/site/source/dev-docs/index.rst index 6d70fc2..407c0d9 100644 --- a/site/source/dev-docs/index.rst +++ b/site/source/dev-docs/index.rst @@ -1,8 +1,11 @@ +.. _dev-docs: + +============== Developer Docs ============== .. toctree:: - :maxdepth: 2 + :maxdepth: 3 :hidden: dev-faq/index @@ -14,6 +17,6 @@ Developer Docs :id: "dev-docs" :class: my-panel - * :doc:`Developer FAQ ` - Frequently asked questions for developers. - * :doc:`Service Packaging ` - Guides on how to package a service for EmbassyOS. - * :doc:`Package Example ` - An example based guide on how to package a service. + * :doc:`Developer FAQ ` - Frequently asked questions by developers in regard to EmbassyOS and packaging services. + * :doc:`Service Packaging ` - The full specification for packaging a service. + * :doc:`Package Example ` - A walkthrough of how to package a service using an example. diff --git a/site/source/knowledge-base/concepts/embassy.rst b/site/source/knowledge-base/concepts/embassy.rst index 1723c70..8a8915f 100644 --- a/site/source/knowledge-base/concepts/embassy.rst +++ b/site/source/knowledge-base/concepts/embassy.rst @@ -8,7 +8,9 @@ Embassy and EmbassyOS Embassy ------- -Embassy is the plug 'n' play hardware device sold by Start9. The current iteration is a Raspberry Pi with an internal speaker in a custom, passively cooled case. The Embassy comes pre-loaded with EmbassyOS. +Embassy is the plug 'n' play hardware device sold by Start9. The current iteration is a Raspberry Pi with an internal speaker in a custom, passively cooled case. The Embassy comes pre-loaded with EmbassyOS. Check out the video below to get a brief overview: + +.. youtube:: GfMvXJxYamw .. _embassy-os: diff --git a/site/source/knowledge-base/concepts/self-hosting.rst b/site/source/knowledge-base/concepts/self-hosting.rst index b5ad50b..7ab6d66 100644 --- a/site/source/knowledge-base/concepts/self-hosting.rst +++ b/site/source/knowledge-base/concepts/self-hosting.rst @@ -1,12 +1,17 @@ .. _self-hosting: -================ -Hosting Software -================ +======= +Hosting +======= Client-Server Model ------------------- +The Internet is not so great atm... Self-Hosting ------------ + +blah blah self-host ya shmuck. For an overview of this idea in relation to EmbassyOS, please check out the video below: + +.. youtube:: dc741XwqlyU diff --git a/site/source/knowledge-base/faq/index.rst b/site/source/knowledge-base/faq/index.rst index 3fa7c3e..b345c7e 100644 --- a/site/source/knowledge-base/faq/index.rst +++ b/site/source/knowledge-base/faq/index.rst @@ -2,7 +2,7 @@ FAQ === -Frequently Asked Questions from Embassy users +Answers to Frequently Asked Questions from Embassy users .. toctree:: :maxdepth: 2 @@ -13,4 +13,4 @@ Frequently Asked Questions from Embassy users faq-embassy faq-services faq-bitcoin - faq-lightning \ No newline at end of file + faq-lightning diff --git a/site/source/knowledge-base/index.rst b/site/source/knowledge-base/index.rst index 890b5c9..9b7735e 100644 --- a/site/source/knowledge-base/index.rst +++ b/site/source/knowledge-base/index.rst @@ -1,3 +1,6 @@ +.. _knowledge-base: + +============== Knowledge Base ============== @@ -13,5 +16,5 @@ Knowledge Base :id: "knowledge-base" :class: my-panel - * :doc:`Concepts ` - An overview of concepts that will aid in understanding the Start9 Embassy. - * :doc:`FAQ ` - The complete guide of frequently asked questions by our users. + * :doc:`Concepts ` - An overview of the ideas and technologies surrounding Start9 Labs and Embassy. + * :doc:`FAQ ` - Answers to Frequently Asked Questions from Embassy users. diff --git a/site/source/user-manual/configuration/basic-config.rst b/site/source/user-manual/configuration/basic-config.rst index c51a549..b6e4a01 100644 --- a/site/source/user-manual/configuration/basic-config.rst +++ b/site/source/user-manual/configuration/basic-config.rst @@ -1,24 +1,58 @@ .. _basic-config: =================== -Basic Configuration - ***NEEDS UPDATE / SCREENS*** +Basic Configuration - ***NEEDS BUG REPORT LINK*** =================== +.. _device-name: + Set Device Name --------------- Here you can change the name of your Embassy! -.. figure:: /_static/images/embassy_config.png - :width: 90% - :alt: Embassy Config View +1. Go to the ``Embassy`` tab on the main menu on the left side of the UI + +.. figure:: /_static/images/config/basic-config0.png + :width: 60% + :alt: Embassy Tab + +2. Under the ``Settings`` section, click ``Preferences`` + +.. figure:: /_static/images/config/basic-config1.png + :width: 60% + :alt: Preferences + +3. Then click ``Device Name``, set to desired name, and click ``Save`` + +.. figure:: /_static/images/config/basic-config2.png + :width: 60% + :alt: Rename Embassy + +.. _auto-reporting: + +Automatically Report Bugs +------------------------- + +You are asked at first setup if you would like to provide bug reports to Start9. You can edit that setting here if you change your mind. This data is anonymous and you can see exactly what is collected `here<>`. + +1. As in the :ref:`Set Device Name` steps above, go to the ``Embasssy`` tab, then under ``Settings``, click ``Preferences`` +2. Click ``Auto Report Bugs`` and either ``Enable`` or ``Disable`` + +.. figure:: /_static/images/config/basic-config3.png + :width: 60% + :alt: Automatically Report Bugs .. _auto-update: +Automatically Check for Updates +------------------------------- + Automatic check for updates enables you to choose whether you want to be informed of EmbassyOS updates. Enabling this feature makes a request to the Start9 Marketplace to see if a new OS version has been released, and notifies you if so. This request is only made when you log into a new session or refresh your current session. -.. figure:: /_static/images/embassy_auto_check_updates.png - :width: 90% - :alt: Embassy Config View +1. As in the :ref:`Set Device Name` steps above, go to the ``Embasssy`` tab, then under ``Settings``, click ``Preferences`` +2. Click ``Automatically Check for Updates`` and either ``Enable`` or ``Disable`` - View of Embassy Config +.. figure:: /_static/images/config/basic-config4.png + :width: 60% + :alt: Automatically Report Bugs diff --git a/site/source/user-manual/configuration/lan-setup/lan-ios.rst b/site/source/user-manual/configuration/lan-setup/lan-ios.rst index ff74025..7590585 100644 --- a/site/source/user-manual/configuration/lan-setup/lan-ios.rst +++ b/site/source/user-manual/configuration/lan-setup/lan-ios.rst @@ -1,10 +1,10 @@ .. _lan-ios: === -iOS +iOS - ***UPDATE SCREENS*** === -#. Navigate back to the `Start9 Setup App `_. +#. Navigate back to the `Start9 Setup App `_. #. Select your claimed Embassy to view the setup results. @@ -24,7 +24,7 @@ iOS Setup App advanced menu -#. You will be directed to a page in your default browser indicating next steps and that the profile has been successfully downloaded. +#. You will be directed to a page in your default browser indicating next steps and that the profile has been successfully downloaded. .. note:: If you have changed the default browser from Safari to Brave, the following auto save certificate to device flow will *not* work. Safari, Firefox, and Chrome work as expected. We recommend you temporarily use one of these browsers to complete this action. @@ -77,4 +77,4 @@ iOS Toggle to enable full trust for root certificates. "Continue" when warning prompts. -#. Test that this process worked successfully by navigating to the LAN address provided in the Setup App. You should no longer see warnings about the security of this site in your browser. We recommend using Start9’s own `Consulate browser `_ for a faster and better experience. \ No newline at end of file +#. Test that this process worked successfully by navigating to the LAN address provided in the Setup App. You should no longer see warnings about the security of this site in your browser. We recommend using Start9’s own `Consulate browser `_ for a faster and better experience. diff --git a/site/source/user-manual/configuration/lan-setup/lan-linux.rst b/site/source/user-manual/configuration/lan-setup/lan-linux.rst index 9310257..80b84e5 100644 --- a/site/source/user-manual/configuration/lan-setup/lan-linux.rst +++ b/site/source/user-manual/configuration/lan-setup/lan-linux.rst @@ -1,7 +1,7 @@ .. _lan-linux: ===== -Linux +Linux - ***UPDATE SCREENS*** ===== Nothing specific needs to be configured for this environment, so you just need the certificate from your Embassy. diff --git a/site/source/user-manual/configuration/lan-setup/lan-mac.rst b/site/source/user-manual/configuration/lan-setup/lan-mac.rst index 1e60564..d5d78c0 100644 --- a/site/source/user-manual/configuration/lan-setup/lan-mac.rst +++ b/site/source/user-manual/configuration/lan-setup/lan-mac.rst @@ -1,7 +1,7 @@ .. _lan-mac: === -Mac +Mac - ***UPDATE SCREENS*** === #. Visit your Embassy at its Tor Address. @@ -62,4 +62,4 @@ Mac Trusted Embassy Local CA certificate -#. Open your favorite browser to import this certificate and follow the steps for :ref:`browser setup `. \ No newline at end of file +#. Open your favorite browser to import this certificate and follow the steps for :ref:`browser setup `. diff --git a/site/source/user-manual/configuration/lan-setup/lan-windows.rst b/site/source/user-manual/configuration/lan-setup/lan-windows.rst index 4a77fa1..c9fa606 100644 --- a/site/source/user-manual/configuration/lan-setup/lan-windows.rst +++ b/site/source/user-manual/configuration/lan-setup/lan-windows.rst @@ -1,7 +1,7 @@ .. _lan-windows: ======= -Windows +Windows - ***UPDATE SCREENS*** ======= #. Install `Bonjour Print Services `_ on your Windows machine. This is necessary in order to visit .local addresses on Windows. diff --git a/site/source/user-manual/configuration/limitations/lim-ios.rst b/site/source/user-manual/configuration/limitations/lim-ios.rst index e50ef65..f9a81d1 100644 --- a/site/source/user-manual/configuration/limitations/lim-ios.rst +++ b/site/source/user-manual/configuration/limitations/lim-ios.rst @@ -14,7 +14,7 @@ The only way to use Tor on iOS is with apps that come with Tor built-in, such as Matrix ------ -The lack of Tor support on iOS means that Element/Matrix cannot be run on an iPhone in conjunction with your Embassy Matrix server, as that currently requires a Tor connection. This will be fixed if `Element ` builds Tor into their app. +The lack of Tor support on iOS means that Element/Matrix cannot be run on an iPhone in conjunction with your Embassy Matrix server, as that currently requires a Tor connection. This will be fixed when `Element `_ builds Tor into their app. An issue specifically in regard to this can be found `here `_. Workarounds ........... diff --git a/site/source/user-manual/configuration/limitations/lim-linux.rst b/site/source/user-manual/configuration/limitations/lim-linux.rst index b8f8502..8bb1122 100644 --- a/site/source/user-manual/configuration/limitations/lim-linux.rst +++ b/site/source/user-manual/configuration/limitations/lim-linux.rst @@ -4,4 +4,4 @@ Linux Known Limitations ======================= -Linux has no known limitations in regard to Embassy. Congratulations, Master Race... +Currently, Linux has no known limitations in regard to Embassy. Congratulations, Master Race... diff --git a/site/source/user-manual/configuration/tor-setup/tor-os/tor-android.rst b/site/source/user-manual/configuration/tor-setup/tor-os/tor-android.rst index d4910ee..d99a05b 100644 --- a/site/source/user-manual/configuration/tor-setup/tor-os/tor-android.rst +++ b/site/source/user-manual/configuration/tor-setup/tor-os/tor-android.rst @@ -75,6 +75,7 @@ Under `Tor-Enabled Apps`, click the gear icon and add apps you want to utilize T Examples of applications that need this feature are: - Bitwarden +- Element (Matrix) - Zeus You can also add the following browsers to the Tor-Enabled Apps list to easily access Tor addresses (`.onion` URLs): diff --git a/site/source/user-manual/configuration/tor-setup/tor-os/tor-ios.rst b/site/source/user-manual/configuration/tor-setup/tor-os/tor-ios.rst index c05d0b1..32c0443 100644 --- a/site/source/user-manual/configuration/tor-setup/tor-os/tor-ios.rst +++ b/site/source/user-manual/configuration/tor-setup/tor-os/tor-ios.rst @@ -4,4 +4,4 @@ iOS === -No Tor for you +Unforutnately, Tor it is not currently possible to run Tor natively on iOS. Please see :ref:`iOS Limitations` for details. diff --git a/site/source/user-manual/configuration/tor-setup/tor-os/tor-linux.rst b/site/source/user-manual/configuration/tor-setup/tor-os/tor-linux.rst index a268c60..5acb708 100644 --- a/site/source/user-manual/configuration/tor-setup/tor-os/tor-linux.rst +++ b/site/source/user-manual/configuration/tor-setup/tor-os/tor-linux.rst @@ -9,12 +9,26 @@ Debian / Ubuntu For Debian and Debian-based systems, such as Mint, PopOS etc. +.. note:: The following install is for the LTS (Long Term Support) version of Tor from Debian. If you would like the latest stable release, The Tor Project maintain their own Debian repository. The instructions to connect to this can be found `here `_. + Install the Tor proxy service to your system. To do so, open your terminal and run the following command: .. code-block:: bash sudo apt update && sudo apt install tor +.. tip:: You can check that Tor is running with: + + .. code-block:: bash + + systemctl status tor + + In the rare event that Tor is having connectivity issues, you can reset your connection with: + + .. code-block:: bash + + sudo systemctl restart tor + Arch ---- @@ -23,3 +37,52 @@ Simply install Tor with: .. code-block:: bash sudo pacman -S tor + + +.. tip:: You can check that Tor is running with: + + .. code-block:: bash + + systemctl status tor + + In the rare event that Tor is having connectivity issues, you can reset your connection with: + + .. code-block:: bash + + sudo systemctl restart tor + +CentOS / Fedora / RHEL +---------------------- + +1. Configure the Tor Package repository. Add the following to ``/etc/yum.repos.d/tor.repo``: + + - CentOS / RHEL: + + .. code-block:: bash + + [Tor] + name=Tor for Enterprise Linux $releasever - $basearch + baseurl=https://rpm.torproject.org/centos/$releasever/$basearch + enabled=1 + gpgcheck=1 + gpgkey=https://rpm.torproject.org/centos/public_gpg.key + cost=100 + + + - Fedora: + + .. code-block:: bash + + [Tor] + name=Tor for Fedora $releasever - $basearch + baseurl=https://rpm.torproject.org/fedora/$releasever/$basearch + enabled=1 + gpgcheck=1 + gpgkey=https://rpm.torproject.org/fedora/public_gpg.key + cost=100 + +2. Then install the Tor package: + +.. code-block:: bash + + sudo dnf install tor diff --git a/site/source/user-manual/configuration/tor-setup/tor-os/tor-mac.rst b/site/source/user-manual/configuration/tor-setup/tor-os/tor-mac.rst index 5350b7d..7d326ee 100644 --- a/site/source/user-manual/configuration/tor-setup/tor-os/tor-mac.rst +++ b/site/source/user-manual/configuration/tor-setup/tor-os/tor-mac.rst @@ -1,52 +1,13 @@ .. _tor-mac: === -Mac - ***SIMPLIFY M1 INSTRUCTION*** +Mac === -For macOS running on ARM chips (ie. newer macs): -================================================ - Install Homebrew ---------------- -.. warning:: macOS Homebrew running natively on M1/Apple Silicon/ARM has partial functionality. Therefore, some additional steps are needed to setup Homebrew. - -#. Open a command line editor (Terminal), and run the following commands: - - .. code-block:: - - softwareupdate --install-rosetta - arch -x86_64 /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)" - -Install Tor ------------ - -.. warning:: If you have the Tor Browser open, close it and quit the application. - -#. In the command line, install Tor: - - .. code-block:: - - arch -x86_64 brew install tor - -#. Then start Tor: - - .. code-block:: - - arch -x86_64 brew services start tor - -This will start Tor and ensure that it is always running, even after a restart. See the `Tor Project `_ for more details. - -For macOS Big Sur/Catalina: -=========================== - -Install Homebrew ----------------- - -1. If you do not have Homebrew installed, follow the installation instructions `here `_. - - TLDR: Open the command line editor (Terminal) and paste the following line: +1. If you do not have Homebrew installed, follow the installation instructions `here `_. TLDR: Open the Terminal and paste the following line: .. code-block:: diff --git a/site/source/user-manual/configuration/tor-setup/tor-os/tor-windows.rst b/site/source/user-manual/configuration/tor-setup/tor-os/tor-windows.rst index 31e6aa1..964a95c 100644 --- a/site/source/user-manual/configuration/tor-setup/tor-os/tor-windows.rst +++ b/site/source/user-manual/configuration/tor-setup/tor-os/tor-windows.rst @@ -32,24 +32,13 @@ Windows .. code-block:: - sc create tor start= auto binPath= "\Browser\TorBrowser\Tor\tor.exe -nt-service" - - .. code-block:: - - sc start tor + sc create tor start= auto binPath= "\Browser\TorBrowser\Tor\tor.exe -nt-service" .. tip:: If you get the error "Access denied," please ensure you are running the command prompt in Administrator mode. You can tell because the prompt will show C:\\Users\\YOUR-USERNAME> if you are NOT in admin mode, and it will show C:\\WINDOWS\\system32 if you ARE in admin mode. - .. note:: If you get the error "The specified service already exists," complete the following steps: + .. code-block:: - 1. Run the command: - - .. code-block:: - - sc delete tor - - 1. Uninstall the Tor Browser, following `these steps `_. - 2. Begin this guide again from the beginning. + sc start tor #. When you run this, it should look something like this: @@ -59,4 +48,14 @@ Windows Replace highlighted section with noted destination folder + .. note:: If you get the error "The specified service already exists," complete the following steps: + + 1. Run the command: + + .. code-block:: + + sc delete tor + 2. Uninstall the Tor Browser, following `these steps `_. + 3. Begin this guide again from the beginning. + #. That's it! Your Windows computer is now setup to natively use Tor. diff --git a/site/source/user-manual/configuration/wifi.rst b/site/source/user-manual/configuration/wifi.rst index 9d02564..8c20c4e 100644 --- a/site/source/user-manual/configuration/wifi.rst +++ b/site/source/user-manual/configuration/wifi.rst @@ -1,21 +1,32 @@ .. _wifi: =============== -Setting up WiFi - ***UPDATE SCREENS*** +Setting up WiFi - ***VERIFY CONNECTION BEHAVIOR*** =============== -#. On the Embassy Tab, Under "Settings", Click "WiFi". -#. Click the ``+`` button in the lower right corner. -#. Select the appropriate country. -#. Enter your WiFi SSID and password. +You can connect your Embassy with a wireless connection if you prefer. Follow the directions below to connect to a WiFi network, or save your credentials for later to connect to a network you are not currently in proximity to. - .. figure:: /_static/images/embassy_wifi.png - :width: 90% - :alt: Add WiFi +#. On the ``Embassy`` tab, Under ``Settings``, Click ``WiFi`` +#. Select the appropriate region at the top - Add WiFi Network options + .. figure:: /_static/images/config/wifi0.png + :width: 60% + :alt: Select Region -#. Save - * Clicking *Add* will save the network credentials but not try to connect immediately. This is useful, for example, if you are connected over Ethernet at home and want to add your office WiFi credentials. - * `Add and Connect`. -#. The saved network will appear in the list when successfully added. If you are successfully connected, the WiFi symbol will be green, at which point, you can safely disconnect the Embassy from your router. +#. Click the ``+ Add new network`` + + .. figure:: /_static/images/config/wifi1.png + :width: 60% + :alt: Add WiFi Network + +#. Enter your WiFi SSID and password and either select ``Save for Later`` or ``Save and Connect`` to connect immediately + + .. figure:: /_static/images/config/wifi2.png + :width: 60% + :alt: Enter Credentials + +#. The saved network will appear in the list when successfully added. Click on it for connection options. If you are successfully connected, the WiFi symbol will be green, at which point, you can safely disconnect the Embassy from your router. + + .. figure:: /_static/images/config/wifi3.png + :width: 60% + :alt: Connect diff --git a/site/source/user-manual/getting-started/index.rst b/site/source/user-manual/getting-started/index.rst index d78a718..6d0ef12 100644 --- a/site/source/user-manual/getting-started/index.rst +++ b/site/source/user-manual/getting-started/index.rst @@ -1,3 +1,5 @@ +.. _getting-started: + =============== Getting Started =============== @@ -10,4 +12,5 @@ Take your first steps! introduction purchasing initial-setup + recover device-guides/index diff --git a/site/source/user-manual/getting-started/initial-setup.rst b/site/source/user-manual/getting-started/initial-setup.rst index c8a6936..9d36ab6 100644 --- a/site/source/user-manual/getting-started/initial-setup.rst +++ b/site/source/user-manual/getting-started/initial-setup.rst @@ -1,13 +1,15 @@ .. _initial-setup: ============= -Initial Setup - ***NEEDS COMPACTING / SIMPLIFYING*** +Initial Setup - ***COMPACT / SIMPLIFY??*** ============= -.. youtube:: DmTlwp5_zvY +Connect and Power Up +-------------------- -Power On --------- +Check out our quick setup video below, and follow along with the steps in this guide: + +.. youtube:: DmTlwp5_zvY 1. Connect your Embassy to power and Internet, normally using an ethernet port on your home Internet router. @@ -29,12 +31,32 @@ Setup Your Embassy 2. Visit ``embassy.local`` from your web browser. You will be prompted to enter your :ref:`Product Key`. This is found on the bottom side of your device. +.. figure:: /_static/images/setup/setup0.png + :width: 60% + :alt: Enter Product Key + .. admonition:: Explanation :class: toggle expand The product key is used to discover your Embassy's IP address on the Local Area Network using a hashing function and a protocol named :ref:`MDNS (or Zeroconf) `. -3. Create your *permanent* master password and complete setup. +3. Next, select "Start Fresh" if this is your first time using an Embassy. If you'd like to "Recover" from an existing Embassy, please follow that guide :ref:`here`. + +.. figure:: /_static/images/setup/setup1.png + :width: 60% + :alt: Fresh Install + +4. Select your storage drive. You should only have one drive plugged into your Embassy at this time, but always verify it is what you expect before clicking (such as, is it a 1TB drive?) + +.. figure:: /_static/images/setup/setup2.png + :width: 60% + :alt: Select Drive + +5. Create your *permanent* master password and complete setup. + +.. figure:: /_static/images/setup/setup3.png + :width: 60% + :alt: Enter a New Password .. admonition:: Explanation :class: toggle expand @@ -49,13 +71,27 @@ Setup Your Embassy .. warning:: There is also currently no way to change your password. Choose a strong master password. Write it down. Store it somewhere safe. DO NOT LOSE IT. If you lose this password, you may be forced to reset the device, resulting in permanent loss of data. **This one responsibility is the price of sovereignty.** +6. That's it! + +.. figure:: /_static/images/setup/setup4.png + :width: 60% + :alt: Setup Complete + +Your Embassy is now hosted on the private web! After setup is complete you will be presented with connection information. You can view and manage your Embassy by visiting its unique Tor Address from any Tor-enabled browser, or by accessing it's ``.local`` address from your LAN (see :ref:`LAN Setup` for assistance). + Enjoy! ------ -Your Embassy is now hosted on the private web! After setup is complete you will be presented with connection information. You can view and manage your Embassy by visiting its unique Tor Address from any Tor-enabled browser, or by accessing it's ``.local`` address from your LAN. +.. figure:: /_static/images/setup/setup5.png + :width: 60% + :alt: Fresh Embassy +Upon accessing your Embassy for the first time, you will be greeted with an empty Services page. Start9 firmly believe that the only software that should be on your device is the software you choose to be on there. So go ahead and visit the Marketplace to get your first Service!! -.. admonition:: Troubleshooting +Troubleshooting +--------------- + +Try these steps if you have any issues with setup. #. Confirm that the Embassy is plugged into both power and Ethernet, with the USB drive in a USB 3.0 (blue) slot. #. Confirm the Embassy emitted two sounds when powering on: a bep and a chime. @@ -64,5 +100,8 @@ Your Embassy is now hosted on the private web! After setup is complete you will #. Confirm your device is not using a VPN. #. Try to refresh the ``embassy.local`` page. #. Very rarely, a router may not support mDNS. In this case: - * On your desktop or laptop computer, navigate to your router configuration settings within the browser. This is usually an IP address such as 192.168.1.1. A simple web search will usually reveal how to access the router configuration settings for a particular brand. - * Once in the router config settings, find the section that lists the devices on your network. You should see an item labeled "embassy". Take note of the associated IP address and enter it into your browser's URL field to enter the setup. + + - On your desktop or laptop computer, navigate to your router configuration settings within the browser. This is usually an IP address such as 192.168.1.1. A simple web search will usually reveal how to access the router configuration settings for a particular brand. + - Once in the router config settings, find the section that lists the devices on your network. You should see an item labeled "embassy". Take note of the associated IP address and enter it into your browser's URL field to enter the setup. + +If you are still having issues, please reach out to us for :ref:`Assistance`. diff --git a/site/source/user-manual/getting-started/recover.rst b/site/source/user-manual/getting-started/recover.rst new file mode 100644 index 0000000..462a176 --- /dev/null +++ b/site/source/user-manual/getting-started/recover.rst @@ -0,0 +1,15 @@ +.. _recover: + +=============== +Recover Embassy +=============== + +.. _recover-02x: + +Recover Embassy from version series 0.2.x +----------------------------------------- + +.. _recover-03x: + +Recover Embassy from Version Series 0.3.x +----------------------------------------- diff --git a/site/source/user-manual/index.rst b/site/source/user-manual/index.rst index 391730e..a4dd29b 100644 --- a/site/source/user-manual/index.rst +++ b/site/source/user-manual/index.rst @@ -1,5 +1,8 @@ +.. _user-manual: + +=========== User Manual -============= +=========== .. toctree:: :maxdepth: 2 @@ -17,11 +20,11 @@ User Manual :id: "getting-started" :class: my-panel - EmbassyOS is designed to work out of the box with a minimal setup and immediate practicality. That being said, there are a great many different use-cases and utilities that can be added at your convenience. You can get started right away with :ref:`Initial Setup `. In the `User Manual `, you will find information on what EmbassyOS can do for you, as well as configuration and customization options. Use our `Knowledgebase ` to learn more about the technologies behind Embassy, including Frequently Asked Questions. When you're ready to build, please check out our `Developer Docs `. Please don't hestitate to `Contact Us `_ if you have any issues, questions, or suggestions that are not covered here. + EmbassyOS is designed to work out of the box with a minimal setup and immediate practicality. That being said, there are a great many different use-cases and utilities that can be added at your convenience. You can get started right away with :ref:`Initial Setup `. In the :ref:`User Manual `, you will find information on what EmbassyOS can do for you, as well as configuration and customization options. Use our :ref:`Knowledge Base ` to learn more about the technologies behind Embassy, including Frequently Asked Questions. When you're ready to build, please check out our :ref:`Developer Docs `. Please don't hestitate to `Contact Us `_ if you have any issues, questions, or suggestions that are not covered here. - * :doc:`Getting Started ` - Get started with understanding your Embassy device. - * :doc:`Configuration Options ` - Configuration options for EmbassyOS. - * :doc:`Troubleshooting ` - Help to resolve common issues. - * :doc:`Tuning ` - Customize with advanced configurations. - * :doc:`Services ` - Overview of services available on EmbassyOS. - * :doc:`Walkthrough ` - Overview of Embassy capabilities. + * :doc:`Getting Started ` - Initial setup and device-specific guides to connect with your Embassy. + * :doc:`Configuration Options ` - Configuration your Embassy. + * :doc:`Troubleshooting ` - Resolve any common issues you may encounter. + * :doc:`Tuning ` - Customize your Embassy with advanced configuration and external service integrations. + * :doc:`Services ` - Overview of featured Services and general usage on EmbassyOS. + * :doc:`Walkthrough ` - A guided tour of EmbassyOS. diff --git a/site/source/user-manual/troubleshooting/shoot-embassy.rst b/site/source/user-manual/troubleshooting/shoot-embassy.rst index 3aeff73..340568b 100644 --- a/site/source/user-manual/troubleshooting/shoot-embassy.rst +++ b/site/source/user-manual/troubleshooting/shoot-embassy.rst @@ -1,7 +1,7 @@ .. _shoot-embassy: ======================= -Troubleshooting Embassy +Troubleshooting Embassy - ***ADD LIST OF SOUNDS*** ======================= Hardware @@ -11,7 +11,7 @@ Embassy is making noises ........................ The plug and play Embassy sold by Start9 has no moving parts, so the only noises it should ever make would come from its internal speaker. The following is a list of all possible sounds: -#. +#. Embassy will not boot ..................... @@ -22,4 +22,4 @@ Software I'm having an issue with a particular Service ............................................. -If a Service is crashing or acting up in some way, check the `Documentation` and `FAQ` for that particular Service. You can also check the `Logs` of a service, which might tell you what the problem is. If that is not helpful, try to restart the service to see if that clears up the issue. If you are still having issues, please reach out in one of our `Community Channels` for immediate assistance, or email support@start9labs.com for help during business hours. \ No newline at end of file +If a Service is crashing or acting up in some way, check the `Documentation` and `FAQ` for that particular Service. You can also check the `Logs` of a service, which might tell you what the problem is. If that is not helpful, try to restart the service to see if that clears up the issue. If you are still having issues, please reach out in one of our `Community Channels` for immediate assistance, or email support@start9labs.com for help during business hours. diff --git a/site/source/user-manual/tuning/advanced-config/alt-marketplace.rst b/site/source/user-manual/tuning/advanced-config/alt-marketplace.rst index a4328e4..39934a8 100644 --- a/site/source/user-manual/tuning/advanced-config/alt-marketplace.rst +++ b/site/source/user-manual/tuning/advanced-config/alt-marketplace.rst @@ -1,21 +1,19 @@ ======================= -Alternative Marketplace - ***NEEDS UPDATED*** +Alternative Marketplace ======================= -EmbassyOS supports accessing alternative marketplaces by configuring a system file. Start9 is not responsible for issues encountered by downloading services from alternative marketplaces. +.. caution:: EmbassyOS supports accessing alternative marketplaces. Start9 is not responsible for issues encountered when downloading services from alternative marketplaces, and cannot provide support for Services that are not from our offical marketplace. Here be dragons!! -After SSH-ing into the Embassy, run the following commands:: +After SSH-ing into the Embassy, run the following command, replacing ```` with your desired marketplace URL: - sudo systemctl stop agent - sudo sh -c "echo '' > /root/agent/alt_registry_url.txt" - sudo systemctl start agent +.. code-block:: bash -The Embassy is now able to connect to the provided alternative registry. + embassy-cli server set-marketplace ----- +or to only change the marketplace for fetching packages, but not os updates: -To revert this change, simply delete the file:: +.. code-block:: bash - sudo systemctl stop agent - sudo rm /root/agent/alt_registry_url.txt - sudo systemctl start agent + embassy-cli package set-marketplace + +.. note:: Make sure you have the URL **EXACTLY CORRECT.** If you do not, your Embassy may crash. In this case, just reboot the device and try again. diff --git a/site/source/user-manual/tuning/advanced-config/ssh-setup.rst b/site/source/user-manual/tuning/advanced-config/ssh-setup.rst index ddb9f46..ed792a9 100644 --- a/site/source/user-manual/tuning/advanced-config/ssh-setup.rst +++ b/site/source/user-manual/tuning/advanced-config/ssh-setup.rst @@ -9,12 +9,16 @@ SSH Setup Connecting via CLI ------------------ -#. Navigate to *Developer Options > SSH Keys* -#. Click the ``+`` button in the lower right hand corner. -#. Paste in your SSH key. -#. You can now access your Embassy from the command line using:: +#. Navigate to the ``Embassy`` tab, then under ``Settings``, click ``SSH`` +#. Click the ``+ Add New Key`` button +#. Paste in your SSH key and hit ``Submit`` +#. You can now access your Embassy from the command line (Linux and Mac) using: - ssh pi@ + .. code-block:: bash + + ssh root@ + +Replacing ```` with your Embassy's LAN (``embassy-xxxxxxx.local``) address Connecting via SSH on Windows, using PuTTY ------------------------------------------ diff --git a/site/source/user-manual/tuning/diy.rst b/site/source/user-manual/tuning/diy.rst index 0fc0503..52a0500 100644 --- a/site/source/user-manual/tuning/diy.rst +++ b/site/source/user-manual/tuning/diy.rst @@ -1,7 +1,7 @@ .. _diy: ========= -DIY Guide +DIY Guide - ***UPDATE BUILD GUIDE LINK*** ========= .. figure:: /_static/images/diy/pi.png @@ -69,7 +69,7 @@ Depending on your Internet speed, the download should take between 5 and 30 minu Getting EmbassyOS: Building from Source ....................................... -***Placehodler for build guide - either link to GH or duplicate here. Probably duplicate to keep all docs centralized to this repo - https://github.com/Start9Labs/embassy-os/tree/integration/0.3.0/build*** +***Placehodler for build guide - https://github.com/Start9Labs/embassy-os/tree/integration/0.3.0/build*** Installing EmbassyOS --------------------