Start9/documentation
2
0
Fork 0
mirror of https://github.com/Start9Labs/documentation.git synced 2026-03-26 10:21:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

rename all svgs to pngs for proper display

Browse Source
This commit is contained in:
Lucy Cifferello
2022-02-07 16:43:55 -07:00
parent 6ba309d885
commit a65ec251fb
159 changed files with 135 additions and 135 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
site/source/support/dev-docs/dev-tools/service-container.rst
View File

@@ -10,10 +10,10 @@ For simplicity, EmbassyOS is designed to be completely operated via the :ref:`We
This guide assumes you already have :ref:`SSH Access<ssh-setup>` setup on your machine.
Open a terminal, ssh into your device, and enter the following command, replacing ``<SERVICE>`` with the name of the service you are trying to access. You can list the services with ``embassy-cli package list`` (you will need to be logged in under ``embassy-cli`` for this). You will need to either be ``root`` or use ``sudo``.
Open a terminal, ssh into your device, and enter the following command, replacing ``<package-id>`` with the name of the service you are trying to access. You can list the services with ``embassy-cli package list`` (you will need to be logged in under ``embassy-cli`` for this). You will need to either be ``root`` or use ``sudo``.
.. code-block:: bash
docker exec -it <SERVICE>.embassy sh
docker exec -it <package-id>.embassy sh
This will give you a shell within the container. Reminder that nothing you do in here is supported, please be careful!

6
site/source/support/dev-docs/packaging-example.rst
View File

@@ -492,11 +492,11 @@ These are stored in ``assets/compat/`` for 0.2.x compatibility, and in ``/assets
We essentially have 2 config options (homepage and subdomains), with all of their specifications nested below them. Looking at the homepage, it contains a ``union`` type, which is a necessary dependency, which can be of 5 variants (welcome, index, filebrowser, redirect, or fuck-off). The below images show how this is displayed in the UI.
.. figure:: /_static/images/dev/pages0.svg
.. figure:: /_static/images/dev/pages0.png
:width: 60%
:alt: Pages Config
.. figure:: /_static/images/dev/pages1.svg
.. figure:: /_static/images/dev/pages1.png
:width: 60%
:alt: Pages Union
@@ -524,7 +524,7 @@ Instructions
Instructions are the basic directions or any particular details that you would like to convey to the user to help get them on their way. Each wrapper repo should contain a ``docs`` directory which can include anything you'd like, but specifically if you include an ``instructions.md`` file, formatted in Markdown language, it will be displayed simply for the user as shown below.
.. figure:: /_static/images/dev/instructions.svg
.. figure:: /_static/images/dev/instructions.png
:width: 60%
:alt: Instructions

4
site/source/support/dev-docs/service-packaging/config.rst
View File

@@ -29,7 +29,7 @@ Config Spec
Overview
========
.. figure:: /_static/images/services/service5.svg
.. figure:: /_static/images/services/service5.png
:width: 80%
:alt: Synapse Config
@@ -42,7 +42,7 @@ This file defines the structure of configuration options your service depends on
The neat part about this file is that each ValueSpec type gets translated into a specific front end component. For instance, boolean values display as a toggle button, such as in the Synapse exmple of ``Enable Registration``.
.. figure:: /_static/images/services/synapseconfig.svg
.. figure:: /_static/images/services/synapseconfig.png
:width: 80%
:alt: Example boolean toggle

2
site/source/support/dev-docs/service-packaging/instructions.rst
View File

@@ -8,7 +8,7 @@ Within each wrapper repository should exist a ``docs`` directory. This folder sh
If an ``instructions.md`` file is included, this markdown formatted file will be rendered in the "Instructions" section within the service page on EmbassyOS:
.. figure:: /_static/images/services/service-instruct.svg
.. figure:: /_static/images/services/service-instruct.png
:width: 80%
:alt: Embassy Pages Instructions

2
site/source/support/dev-docs/service-packaging/properties.rst
View File

@@ -6,7 +6,7 @@ Properties
The output of this step is a file titled ``stats.yaml``. This file contains a mapping of the values that will be displayed in the ``Properties`` section in a service's menu.
.. figure:: /_static/images/services/service-properties.svg
.. figure:: /_static/images/services/service-properties.png
:width: 80%
:alt: Service Properties

2
site/source/support/user-manual/configuration/backup-setup/backup-lin.rst
View File

@@ -27,7 +27,7 @@ The following will guide you through the prerequisite configuration to backup to
#. That's it! Now you can make encrypted backups to your own, private "cloud" by using the :ref:`Backup flow<backups>` in the Embassy UI.
.. figure:: /_static/images/TODO.svg
.. figure:: /_static/images/TODO.png
.. group-tab:: Other Linux

4
site/source/support/user-manual/configuration/basic-config.rst
View File

@@ -15,7 +15,7 @@ You are asked at first setup if you would like to provide bug reports to Start9.
#. Click ``Auto Report Bugs`` and either ``Enable`` or ``Disable``
.. figure:: /_static/images/config/basic-config3.svg
.. figure:: /_static/images/config/basic-config3.png
:width: 60%
:alt: Automatically Report Bugs
@@ -30,6 +30,6 @@ Automatic check for updates enables you to choose whether you want to be informe
#. Click ``Automatically Check for Updates`` and either ``Enable`` or ``Disable``
.. figure:: /_static/images/config/basic-config4.svg
.. figure:: /_static/images/config/basic-config4.png
:width: 60%
:alt: Automatically Report Bugs

8
site/source/support/user-manual/configuration/lan-setup/lan-browser/lan-brave.rst
View File

@@ -8,19 +8,19 @@ Brave
#. Open a new tab in Brave and Navigate to ``Settings`` from the top-right hamburger menu.
.. figure:: /_static/images/ssl/browser/brave_settings.svg
.. figure:: /_static/images/ssl/browser/brave_settings.png
:width: 30%
:alt: Brave settings page
#. On the left hand sidebar, select the Security and Privacy section, then the Security menu item.
.. figure:: /_static/images/ssl/browser/brave_security.svg
.. figure:: /_static/images/ssl/browser/brave_security.png
:width: 60%
:alt: Brave Security and Privacy settings
#. At the bottom of the section, select "Manage Certificates".
.. figure:: /_static/images/ssl/browser/brave_security_settings.svg
.. figure:: /_static/images/ssl/browser/brave_security_settings.png
:width: 60%
:alt: Brave Security settings page
@@ -31,7 +31,7 @@ Brave
#. If you do not see "org-Start9"in the list, ensure the certificate is properly set up on your computer system. Otherwise, click “Import” and open the downloaded ``Embassy Local Root CA.crt`` file on your device. If you cannot find this, make sure you completed the :ref:`device setup steps <lan-os>`.
.. figure:: /_static/images/ssl/browser/brave_view_certs.svg
.. figure:: /_static/images/ssl/browser/brave_view_certs.png
:width: 60%
:alt: Brave Manage Certificates sub-menu on MacOS

10
site/source/support/user-manual/configuration/lan-setup/lan-browser/lan-chrome.rst
View File

@@ -10,19 +10,19 @@ Chrome
#. Open a new tab in Chrome and navigate to ``chrome://settings/certificates``.
.. figure:: /_static/images/ssl/browser/chrome_settings.svg
.. figure:: /_static/images/ssl/browser/chrome_settings.png
:width: 60%
:alt: Chrome Certificates Settings page
#. Click on the "Authorities" tab.
.. figure:: /_static/images/ssl/browser/chrome_authorities.svg
.. figure:: /_static/images/ssl/browser/chrome_authorities.png
:width: 60%
:alt: Chrome Certificate Authorities page
#. You will **EITHER** see "org-Start9" with a trusted “Embassy Local Root CA” listed under it,
.. figure:: /_static/images/ssl/browser/chrome_s9ca.svg
.. figure:: /_static/images/ssl/browser/chrome_s9ca.png
:width: 60%
:alt: Start9 Certificate Authority
@@ -32,7 +32,7 @@ Chrome
#. If you do not see "org-Start9"in the list, ensure the certificate is properly set up on your computer system. Otherwise, click “Import” and open the downloaded ``Embassy Local Root CA.crt`` file on your device. If you cannot find this, make sure you completed the :ref:`device setup steps <lan-os>`.
.. figure:: /_static/images/ssl/browser/chrome_trust.svg
.. figure:: /_static/images/ssl/browser/chrome_trust.png
:width: 60%
:alt: Trust the CA
@@ -42,7 +42,7 @@ Chrome
.. tip:: You may need to restart the browser
.. figure:: /_static/images/ssl/browser/chrome_https.svg
.. figure:: /_static/images/ssl/browser/chrome_https.png
:width: 60%
:alt: Success

6
site/source/support/user-manual/configuration/lan-setup/lan-browser/lan-ff.rst
View File

@@ -6,7 +6,7 @@ Firefox
#. Open Firefox and in a new tab select ``Settings`` from the right-hand hamburger menu:
.. figure:: /_static/images/tor/os_ff_settings.svg
.. figure:: /_static/images/tor/os_ff_settings.png
:width: 30%
:alt: Firefox options screenshot
@@ -14,7 +14,7 @@ Firefox
#. Scroll all the way to the bottom of the page and select “View Certificates”.
.. figure:: /_static/images/ssl/browser/firefox_security_settings.svg
.. figure:: /_static/images/ssl/browser/firefox_security_settings.png
:width: 80%
:alt: Firefox security settings
@@ -26,7 +26,7 @@ Firefox
#. When prompted, check “Trust this CA to identity websites” and select “OK”.
.. figure:: /_static/images/ssl/browser/firefox_view_certs.svg
.. figure:: /_static/images/ssl/browser/firefox_view_certs.png
:width: 80%
:alt: Firefox import cert

8
site/source/support/user-manual/configuration/lan-setup/lan-os/lan-android.rst
View File

@@ -10,13 +10,13 @@ If you are running Android 12+ (not yet available on Calyx/Graphene), you can se
#. Either use the Root CA you downloaded at the completion of :ref:`Initial Setup<initial-setup>`, or visit your Embassy at its Tor Address (for security purposes), and navigate to the :ref:`Embassy tab<embassy-tab>` -> LAN
.. figure:: /_static/images/ssl/embassy_lan_setup.svg
.. figure:: /_static/images/ssl/embassy_lan_setup.png
:width: 60%
:alt: LAN setup menu item
#. Click "Download Root CA". This will prompt a download to save the certificate file to your machine
.. figure:: /_static/images/ssl/embassy_lan_setup0.svg
.. figure:: /_static/images/ssl/embassy_lan_setup0.png
:width: 60%
:alt: LAN setup page
@@ -24,13 +24,13 @@ If you are running Android 12+ (not yet available on Calyx/Graphene), you can se
#. Go to Settings -> Security -> Advanced -> Encryption and Credentials -> Install a Certificate and select the cert you downloaded from the file system
.. figure:: /_static/images/ssl/android/droidLAN0.svg
.. figure:: /_static/images/ssl/android/droidLAN0.png
:width: 30%
:alt: Install certificate
#. To setup in Firefox, enter ``about:config`` in URL bar, search for "security.enterprise_roots.enabled", and set to ``true``
.. figure:: /_static/images/ssl/android/droidLAN1.svg
.. figure:: /_static/images/ssl/android/droidLAN1.png
:width: 30%
:alt: Firefox about:config

16
site/source/support/user-manual/configuration/lan-setup/lan-os/lan-ios.rst
View File

@@ -14,13 +14,13 @@ iOS
#. In the ``Embassy`` tab in your Embassy, under ``Settings`` -> ``LAN``
.. figure:: /_static/images/ssl/embassy_lan_setup.svg
.. figure:: /_static/images/ssl/embassy_lan_setup.png
:width: 60%
:alt: LAN setup menu item
#. Select ``Download Root CA``. Clicking this will prompt you to “Save to device”.
.. figure:: /_static/images/ssl/embassy_lan_setup0.svg
.. figure:: /_static/images/ssl/embassy_lan_setup0.png
:width: 60%
:alt: LAN setup page
@@ -29,7 +29,7 @@ iOS
.. 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.
.. figure:: /_static/images/ssl/ios/ssl_certificate_install_page.svg
.. figure:: /_static/images/ssl/ios/ssl_certificate_install_page.png
:width: 40%
:alt: Certificate install page
@@ -37,17 +37,17 @@ iOS
#. Go to Settings on your iOS device.
.. figure:: /_static/images/ssl/ios/ssl_ipad_general_settings.svg
.. figure:: /_static/images/ssl/ios/ssl_ipad_general_settings.png
:width: 40%
:alt: General settings
#. Navigate to *General > Profile(s) > Downloaded Profile > Install*.
.. figure:: /_static/images/ssl/ios/ssl_ipad_profiles.svg
.. figure:: /_static/images/ssl/ios/ssl_ipad_profiles.png
:width: 40%
:alt: Profiles
.. figure:: /_static/images/ssl/ios/ssl_ipad_install_profile.svg
.. figure:: /_static/images/ssl/ios/ssl_ipad_install_profile.png
:width: 40%
:alt: Install profile
@@ -57,7 +57,7 @@ iOS
#. Next, navigate to *General > About > Certificate Trust Settings*.
.. figure:: /_static/images/ssl/ios/ssl_ipad_cert_trust_settings.svg
.. figure:: /_static/images/ssl/ios/ssl_ipad_cert_trust_settings.png
:width: 40%
:alt: Certificate trust settings
@@ -65,7 +65,7 @@ iOS
#. Enable full trust for root certificates.
.. figure:: /_static/images/ssl/ios/ssl_ipad_cert_trust.svg
.. figure:: /_static/images/ssl/ios/ssl_ipad_cert_trust.png
:width: 40%
:alt: Enable full trust

4
site/source/support/user-manual/configuration/lan-setup/lan-os/lan-linux.rst
View File

@@ -12,13 +12,13 @@ Nothing specific needs to be configured for the Linux environment, so you just n
#. Navigate to the :ref:`Embassy tab<embassy-tab>` -> Settings -> LAN
.. figure:: /_static/images/ssl/embassy_lan_setup.svg
.. figure:: /_static/images/ssl/embassy_lan_setup.png
:width: 60%
:alt: LAN setup menu item
#. Click "Download Root CA". This will prompt a download to save the certificate file to your machine.
.. figure:: /_static/images/ssl/embassy_lan_setup0.svg
.. figure:: /_static/images/ssl/embassy_lan_setup0.png
:width: 60%
:alt: LAN setup page

12
site/source/support/user-manual/configuration/lan-setup/lan-os/lan-mac.rst
View File

@@ -6,25 +6,25 @@ Mac
#. Visit your Embassy at its Tor Address (for security purposes), and navigate to the :ref:`Embassy tab<embassy-tab>` -> LAN
.. figure:: /_static/images/ssl/embassy_lan_setup.svg
.. figure:: /_static/images/ssl/embassy_lan_setup.png
:width: 60%
:alt: LAN setup menu item
#. Click "Download Root CA". This will prompt a download to save the certificate file to your machine.
.. figure:: /_static/images/ssl/embassy_lan_setup0.svg
.. figure:: /_static/images/ssl/embassy_lan_setup0.png
:width: 60%
:alt: LAN setup page
#. Select the option to ``Open with`` "Keychain Access" and select ``OK``. If you choose to save the file, double click on it once downloaded.
.. figure:: /_static/images/ssl/embassy_lan_setup1.svg
.. figure:: /_static/images/ssl/embassy_lan_setup1.png
:width: 60%
:alt: LAN setup prompt
#. Enter your computer password when prompted. It will be imported into your mac's keychain.
.. figure:: /_static/images/ssl/macos/certificate_untrusted.svg
.. figure:: /_static/images/ssl/macos/certificate_untrusted.png
:width: 60%
:alt: Keychain access import menu
@@ -36,7 +36,7 @@ Mac
#. Open the “Trust” dropdown and select “Always Trust” from the dropdown next to “When using this certificate”.
.. figure:: /_static/images/ssl/macos/always_trust.svg
.. figure:: /_static/images/ssl/macos/always_trust.png
:width: 60%
:alt: Keychain submenu
@@ -46,7 +46,7 @@ Mac
#. The “Embassy Local Root CA” cert will now read “This certificate is marked as trusted for all users” in Keychain Access.
.. figure:: /_static/images/ssl/macos/certificate_trusted.svg
.. figure:: /_static/images/ssl/macos/certificate_trusted.png
:width: 60%
:alt: Keychain menu trusted certificate

20
site/source/support/user-manual/configuration/lan-setup/lan-os/lan-windows.rst
View File

@@ -22,13 +22,13 @@ Unfortunately, Windows does not have mDNS support built-in, which is necessary i
#. Navigate to the :ref:`Embassy tab<embassy-tab>` -> Settings -> LAN
.. figure:: /_static/images/ssl/embassy_lan_setup.svg
.. figure:: /_static/images/ssl/embassy_lan_setup.png
:width: 90%
:alt: LAN setup menu item
#. Click "Download Root CA". This will prompt a download to save the certificate file to your machine.
.. figure:: /_static/images/ssl/embassy_lan_setup0.svg
.. figure:: /_static/images/ssl/embassy_lan_setup0.png
:width: 90%
:alt: LAN setup page
@@ -36,7 +36,7 @@ Unfortunately, Windows does not have mDNS support built-in, which is necessary i
#. Type in “mmc” and click “OK”. When prompted on the “User Account Control” window, select “Yes” to allow this program to run.
.. figure:: /_static/images/ssl/windows/1_windows_mmc.svg
.. figure:: /_static/images/ssl/windows/1_windows_mmc.png
:width: 90%
:alt: Windows MMC
@@ -44,7 +44,7 @@ Unfortunately, Windows does not have mDNS support built-in, which is necessary i
#. When the Management Console opens, navigate to *File > Add/Remove Snap-in*.
.. figure:: /_static/images/ssl/windows/2_windows_console_root.svg
.. figure:: /_static/images/ssl/windows/2_windows_console_root.png
:width: 90%
:alt: Windows Console Root
@@ -52,7 +52,7 @@ Unfortunately, Windows does not have mDNS support built-in, which is necessary i
#. Select “Certificates” in the left side menu, then “Add”. This will open another window.
.. figure:: /_static/images/ssl/windows/3_windows_add_certificates.svg
.. figure:: /_static/images/ssl/windows/3_windows_add_certificates.png
:width: 90%
:alt: Add Certificates
@@ -62,7 +62,7 @@ Unfortunately, Windows does not have mDNS support built-in, which is necessary i
#. When you return to the “Add or Remove Snap-ins” page, ensure “Certificates (Local Computer)” exists under “Console Root” in the “Selected snap-ins” section, then click “OK”.
.. figure:: /_static/images/ssl/windows/4_windows_selected_snapin.svg
.. figure:: /_static/images/ssl/windows/4_windows_selected_snapin.png
:width: 90%
:alt: Snap-in Selected
@@ -70,7 +70,7 @@ Unfortunately, Windows does not have mDNS support built-in, which is necessary i
#. In the left hand menu of the Management Console, navigate to Certificates (Local Computer) > Trusted Root Certification Authorities > Certificates.
.. figure:: /_static/images/ssl/windows/5_windows_trusted_certificate_menu.svg
.. figure:: /_static/images/ssl/windows/5_windows_trusted_certificate_menu.png
:width: 90%
:alt: Certificates in Management Console
@@ -78,7 +78,7 @@ Unfortunately, Windows does not have mDNS support built-in, which is necessary i
#. Right click on “Certificates”, then navigate to *All Tasks > Import*.
.. figure:: /_static/images/ssl/windows/6_windows_import_cert.svg
.. figure:: /_static/images/ssl/windows/6_windows_import_cert.png
:width: 90%
:alt: Import certificate
@@ -86,7 +86,7 @@ Unfortunately, Windows does not have mDNS support built-in, which is necessary i
#. Click “Next” on the first page of the Certificate Import Wizard, then browse to the location where you saved the downloaded certificate and click “Open”.
.. figure:: /_static/images/ssl/windows/7_windows_import_cert_wizard.svg
.. figure:: /_static/images/ssl/windows/7_windows_import_cert_wizard.png
:width: 90%
:alt: Import cert wizard
@@ -98,7 +98,7 @@ Unfortunately, Windows does not have mDNS support built-in, which is necessary i
#. Verify the Embassy Local Root CA certificate is in the “Certificates” folder.
.. figure:: /_static/images/ssl/windows/8_windows_successful_cert_install.svg
.. figure:: /_static/images/ssl/windows/8_windows_successful_cert_install.png
:width: 90%
:alt: Successful cert install

10
site/source/support/user-manual/configuration/tor-setup/tor-firefox/torff-android.rst
View File

@@ -15,13 +15,13 @@ Once Tor is setup on your system, you can proceed to setup Firefox:
3. Navigate to ``about:config`` in the Firefox URL bar.
.. figure:: /_static/images/tor/about_config.svg
.. figure:: /_static/images/tor/about_config.png
:width: 50%
:alt: Firefox about config
4. You are going to have to change a few options in here. First, type ``network.proxy.type`` into the search bar, and set the value to ``2``.
.. figure:: /_static/images/tor/network_proxy_type.svg
.. figure:: /_static/images/tor/network_proxy_type.png
:width: 50%
:alt: Firefox network proxy type setting screenshot
@@ -29,19 +29,19 @@ Once Tor is setup on your system, you can proceed to setup Firefox:
.. caution:: For some platforms, such as Calyx/Graphene on a Pixel 5/6, it may be necessary to place the file within the application's ``data`` folder, such as ``file:///storage/emulated/0/Android/data/org.mozilla.firefox_beta/files/Download/proxy.pac``. Furthermore, the stock file explorer app may not let you do this, so you might have to get a new one, such as `Explorer <https://play.google.com/store/apps/details?id=com.speedsoftware.explorer&hl=en_US&gl=US>`_. Please reach out to support if you have issues.
.. figure:: /_static/images/tor/autoconfig_url.svg
.. figure:: /_static/images/tor/autoconfig_url.png
:width: 50%
:alt: Firefox autoconfig url setting screenshot
6. Search for ``network.proxy.socks_remote_dns``, and set the value to ``true``.
.. figure:: /_static/images/tor/socks_remote_dns.svg
.. figure:: /_static/images/tor/socks_remote_dns.png
:width: 50%
:alt: Firefox socks remote dns setting screenshot
7. Search for ``dom.securecontext.whitelist_onions`` and set the value to ``true``.
.. figure:: /_static/images/tor/firefox_whitelist_mobile.svg
.. figure:: /_static/images/tor/firefox_whitelist_mobile.png
:width: 50%
:alt: Firefox whitelist onions screenshot

8
site/source/support/user-manual/configuration/tor-setup/tor-firefox/torff-linux.rst
View File

@@ -11,7 +11,7 @@ Linux
#. Search for ``dom.securecontext.whitelist_onions`` and set the value to ``true``.
.. figure:: /_static/images/tor/firefox_whitelist.svg
.. figure:: /_static/images/tor/firefox_whitelist.png
:width: 60%
:alt: Firefox whitelist onions screenshot
@@ -24,13 +24,13 @@ Linux
#. Now, back in your Firefox web browser, select ``Settings`` from the right-hand hamburger menu:
.. figure:: /_static/images/tor/os_ff_settings.svg
.. figure:: /_static/images/tor/os_ff_settings.png
:width: 30%
:alt: Firefox options screenshot
#. Search for the term “proxy” in the search bar in the upper right, then select the button that says ``Settings…``:
.. figure:: /_static/images/tor/firefox_search.svg
.. figure:: /_static/images/tor/firefox_search.png
:width: 60%
:alt: Firefox search screenshot
@@ -42,7 +42,7 @@ Linux
#. Then, check the box labeled ``Proxy DNS when using SOCKS v5``:
.. figure:: /_static/images/tor/firefox_proxy.svg
.. figure:: /_static/images/tor/firefox_proxy.png
:width: 60%
:alt: Firefox proxy settings screenshot

8
site/source/support/user-manual/configuration/tor-setup/tor-firefox/torff-mac.rst
View File

@@ -11,7 +11,7 @@ Mac
#. Search for ``dom.securecontext.whitelist_onions`` and set the value to ``true``.
.. figure:: /_static/images/tor/firefox_whitelist.svg
.. figure:: /_static/images/tor/firefox_whitelist.png
:width: 60%
:alt: Firefox whitelist onions screenshot
@@ -29,13 +29,13 @@ Mac
#. Now, back in your Firefox web browser, select ``Settings`` from the right-hand hamburger menu:
.. figure:: /_static/images/tor/os_ff_settings.svg
.. figure:: /_static/images/tor/os_ff_settings.png
:width: 30%
:alt: Firefox options screenshot
#. Search for the term “proxy” in the search bar in the upper right, then select the button that says ``Settings…``:
.. figure:: /_static/images/tor/firefox_search.svg
.. figure:: /_static/images/tor/firefox_search.png
:width: 60%
:alt: Firefox search screenshot
@@ -47,7 +47,7 @@ Mac
#. Then, check the box labeled ``Proxy DNS when using SOCKS v5``:
.. figure:: /_static/images/tor/firefox_proxy.svg
.. figure:: /_static/images/tor/firefox_proxy.png
:width: 60%
:alt: Firefox proxy settings screenshot

8
site/source/support/user-manual/configuration/tor-setup/tor-firefox/torff-windows.rst
View File

@@ -10,7 +10,7 @@ Windows
#. Search for ``dom.securecontext.whitelist_onions`` and set the value to ``true``.
.. figure:: /_static/images/tor/firefox_whitelist.svg
.. figure:: /_static/images/tor/firefox_whitelist.png
:width: 60%
:alt: Firefox whitelist onions screenshot
@@ -24,14 +24,14 @@ Windows
#. Now, back in your Firefox web browser, select ``Options`` from the right-hand hamburger menu:
.. figure:: /_static/images/tor/firefox_options_windows.svg
.. figure:: /_static/images/tor/firefox_options_windows.png
:width: 60%
:alt: Firefox options screenshot
#. Search for the term “proxy” in the search bar in the upper right, then select the button that says ``Settings…``:
.. figure:: /_static/images/tor/firefox_search.svg
.. figure:: /_static/images/tor/firefox_search.png
:width: 60%
:alt: Firefox search screenshot
@@ -43,7 +43,7 @@ Windows
#. Then, check the box labeled ``Proxy DNS when using SOCKS v5``:
.. figure:: /_static/images/tor/firefox_proxy.svg
.. figure:: /_static/images/tor/firefox_proxy.png
:width: 60%
:alt: Firefox proxy settings screenshot

14
site/source/support/user-manual/configuration/tor-setup/tor-os/tor-android.rst
View File

@@ -21,25 +21,25 @@ Orbot is a system wide proxy for your Android device that enables communications
3. Open the kebab menu in the upper right hand corner and select `Settings`:
.. figure:: /_static/images/tor/orbot_menu.svg
.. figure:: /_static/images/tor/orbot_menu.png
:width: 50%
:alt: Orbot menu
4. Make sure the options for `Start Orbot on Boot` and `Allow Background Starts` are checked:
.. figure:: /_static/images/tor/orbot_settings.svg
.. figure:: /_static/images/tor/orbot_settings.png
:width: 50%
:alt: Orbot settings
5. Go back, and tap start:
.. figure:: /_static/images/tor/orbot_start.svg
.. figure:: /_static/images/tor/orbot_start.png
:width: 50%
:alt: Orbot start
6. Orbot will start up the Tor service. Once complete, you will see:
.. figure:: /_static/images/tor/orbot_started.svg
.. figure:: /_static/images/tor/orbot_started.png
:width: 50%
:alt: Orbot started
@@ -54,7 +54,7 @@ To utilize Tor, some apps require that Orbot be running in VPN mode. This means
``Settings > Network & Internet > Advanced > Private DNS > Off``
.. figure:: /_static/images/tor/private_dns_off.svg
.. figure:: /_static/images/tor/private_dns_off.png
:width: 50%
:alt: Private DNS off
@@ -62,7 +62,7 @@ To utilize Tor, some apps require that Orbot be running in VPN mode. This means
2. Launch Orbot and toggle VPN Mode on:
.. figure:: /_static/images/tor/orbot_vpn.svg
.. figure:: /_static/images/tor/orbot_vpn.png
:width: 50%
:alt: Orbot vpn mode
@@ -70,7 +70,7 @@ To utilize Tor, some apps require that Orbot be running in VPN mode. This means
Under `Tor-Enabled Apps`, click the gear icon and add apps you want to utilize Tor.
.. figure:: /_static/images/tor/orbot_apps.svg
.. figure:: /_static/images/tor/orbot_apps.png
:width: 50%
:alt: Orbot apps

6
site/source/support/user-manual/configuration/tor-setup/tor-os/tor-mac.rst
View File

@@ -17,13 +17,13 @@ Install Homebrew
#. You will be prompted for your system password before installation; proceed with entering your password. You may be asked more than once.
.. figure:: /_static/images/tor/install_homebrew.svg
.. figure:: /_static/images/tor/install_homebrew.png
:width: 80%
:alt: Homebrew installation
#. You will be notified which directories Homebrew is going to create, hit :code:`RETURN`:
.. figure:: /_static/images/tor/install_homebrew1.svg
.. figure:: /_static/images/tor/install_homebrew1.png
:width: 80%
:alt: Homebrew installation
@@ -46,7 +46,7 @@ Install Tor
Once it is finished you have the following options:
.. figure:: /_static/images/tor/install_tor.svg
.. figure:: /_static/images/tor/install_tor.png
:width: 80%
:alt: Tor installation

6
site/source/support/user-manual/configuration/tor-setup/tor-os/tor-windows.rst
View File

@@ -6,7 +6,7 @@ Windows
#. Unfortunately, `The Tor Project <https://torproject.org>`_ no longer publishes a standalone Tor binary for Windows, so the recommended way to get it is with the Tor Browser Bundle. You can download it `here <https://www.torproject.org/download/>`_.
.. figure:: /_static/images/tor/tor_download_windows.svg
.. figure:: /_static/images/tor/tor_download_windows.png
:width: 80%
:alt: Tor download
@@ -16,7 +16,7 @@ Windows
#. Once you have selected a language, you should see a menu like this:
.. figure:: /_static/images/tor/tor_windows_install.svg
.. figure:: /_static/images/tor/tor_windows_install.png
:width: 80%
:alt: Tor install wizard
@@ -42,7 +42,7 @@ Windows
#. When you run this, it should look something like this:
.. figure:: /_static/images/tor/tor_windows_terminal.svg
.. figure:: /_static/images/tor/tor_windows_terminal.png
:width: 80%
:alt: Tor windows terminal

12
site/source/support/user-manual/configuration/wifi.rst
View File

@@ -8,19 +8,19 @@ Although we highly recommend a wired (ethernet) connection for best performance,
#. On the ``Embassy`` tab, Under ``Settings``, Click ``WiFi``
.. figure:: /_static/images/config/wifi0.svg
.. figure:: /_static/images/config/wifi0.png
:width: 60%
:alt: Select Region
#. Select the appropriate region at the top
.. figure:: /_static/images/config/wifi1.svg
.. figure:: /_static/images/config/wifi1.png
:width: 60%
:alt: Select Region
#. Select the network you would like from the list of available networks. You will get an idea of signal strength on the right, from red (weak signal) to green (strong signal). If you can move your Embassy closer to the WiFi broadcasting device, you will get a better signal, and as a result, better performance.
.. figure:: /_static/images/config/wifi2.svg
.. figure:: /_static/images/config/wifi2.png
:width: 60%
:alt: Add WiFi Network
@@ -28,18 +28,18 @@ Although we highly recommend a wired (ethernet) connection for best performance,
#. Enter your WiFi password and either select ``Save for Later`` or ``Save and Connect`` to connect immediately.
.. figure:: /_static/images/config/wifi3.svg
.. figure:: /_static/images/config/wifi3.png
:width: 60%
:alt: Enter Credentials
#. If you saved the network, it will appear in the list when successfully added, but not show connected. If you connect immediately, you will receive a dialogue box and a green checkmark to show connection is live.
.. figure:: /_static/images/config/wifi4.svg
.. figure:: /_static/images/config/wifi4.png
:width: 60%
:alt: Connect
#. Click on a saved network for connection options. If you are successfully connected, you will receive a dialogue box and a green checkmark to show connection is live. At this point, you can safely disconnect the ethernet cable from your Embassy, if you wish to use WiFi.
.. figure:: /_static/images/config/wifi5.svg
.. figure:: /_static/images/config/wifi5.png
:width: 60%
:alt: Connect

12
site/source/support/user-manual/getting-started/initial-setup.rst
View File

@@ -31,7 +31,7 @@ Setup Your Embassy
2. Visit ``embassy.local`` from your web browser. You will be prompted to enter your :ref:`Product Key<product-key>`. This is found on the bottom side of your device.
.. figure:: /_static/images/setup/setup0.svg
.. figure:: /_static/images/setup/setup0.png
:width: 60%
:alt: Enter Product Key
@@ -42,19 +42,19 @@ Setup Your Embassy
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 the guide for :ref:`versions 0.2.x <recover-02x>` or :ref:`versions 0.3.x <recover-03x>`.
.. figure:: /_static/images/setup/setup1.svg
.. 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.svg
.. 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.svg
.. figure:: /_static/images/setup/setup3.png
:width: 60%
:alt: Enter a New Password
@@ -73,7 +73,7 @@ Setup Your Embassy
6. That's it!
.. figure:: /_static/images/setup/setup4.svg
.. figure:: /_static/images/setup/setup4.png
:width: 60%
:alt: Setup Complete
@@ -82,7 +82,7 @@ Your Embassy is now hosted on the private web! After setup is complete you will
Enjoy!
------
.. figure:: /_static/images/setup/setup5.svg
.. figure:: /_static/images/setup/setup5.png
:width: 60%
:alt: Fresh Embassy

2
site/source/support/user-manual/services/managing-services/service-actions.rst
View File

@@ -15,5 +15,5 @@ Un-installing
To remove a service, navigate to the :ref:`Services tab<services-tab>` *> [Service Name] > Actions > Uninstall*.
.. figure:: /_static/images/services/acts.svg
.. figure:: /_static/images/services/acts.png
:width: 60%

8
site/source/support/user-manual/services/managing-services/service-config.rst
View File

@@ -8,20 +8,20 @@ After installation or update, some services require configuration before they ca
Navigate to the `Services tab <services-tab>` *> [Service Name] > Config*
.. figure:: /_static/images/services/service-needs-config.svg
.. figure:: /_static/images/services/service-needs-config.png
:width: 60%
Traditionally, configuring services was a massive headache and a huge barrier to running a personal server. But no more! The Embassy's revolutionary service config system makes the process transparent, simple, and safe.
.. figure:: /_static/images/services/service4.svg
.. figure:: /_static/images/services/service4.png
:width: 60%
Config options are defined by the service developer and can be almost anything. They are represented as simple UI elements - such as toggles and drop downs - and they include explanations and validations, such that users understand their purpose and are prevented from making mistakes.
.. figure:: /_static/images/services/service5.svg
.. figure:: /_static/images/services/service5.png
:width: 60%
You can change your configuration at any time from a Service's main page:
.. figure:: /_static/images/services/config.svg
.. figure:: /_static/images/services/config.png
:width: 60%

2
site/source/support/user-manual/services/managing-services/service-donate.rst
View File

@@ -6,7 +6,7 @@ Donate
Currently, this is a link provided by the service package developer so that you may donate to them or the developer of the service they packaged directly. If this is not provided, a pop-up message will let you know this, and you will need to find the devs on their own platforms in order to donate.
.. figure:: /_static/images/services/donate.svg
.. figure:: /_static/images/services/donate.png
:width: 60%
.. topic-box::

10
site/source/support/user-manual/services/managing-services/service-install.rst
View File

@@ -8,25 +8,25 @@ Installing
To add a new service, simply find it's listing inside the :ref:`Service Marketplace <service-marketplace>` tab: *[Service Name] >* ``Install``. Let's install Synapse as an example:
.. figure:: /_static/images/services/service0.svg
.. figure:: /_static/images/services/service0.png
:width: 60%
.. figure:: /_static/images/services/service1.svg
.. figure:: /_static/images/services/service1.png
:width: 60%
Depending on the size of the service and your Internet connection, installation should take between 60 seconds and a few minutes.
.. figure:: /_static/images/services/service2.svg
.. figure:: /_static/images/services/service2.png
:width: 60%
You may click *View Service* at any time to view install progress, or after install to go to the Service page. Many services will need to be configured after install. You can use the default options, or change to your liking. See :ref:`configuration<service-config>` for details.
.. figure:: /_static/images/services/service3.svg
.. figure:: /_static/images/services/service3.png
:width: 60%
You will see a screen like the following when install is complete. Then you're ready to :ref:`configure <service-config>` your service!
.. figure:: /_static/images/services/service4.svg
.. figure:: /_static/images/services/service4.png
:width: 60%
.. note:: You can only use a service once its :ref:`dependencies <service-dependencies>` are met, its :ref:`configuration<service-config>` is complete, it has been started, and is in a *running* :ref:`status <service-status>`.

4
site/source/support/user-manual/services/managing-services/service-instructions.rst
View File

@@ -6,12 +6,12 @@ Instructions
To view the instructions for a particular service, navigate to the :ref:`Services tab <services-tab>` *> [Service Name] > Instructions*.
.. figure:: /_static/images/services/instruct.svg
.. figure:: /_static/images/services/instruct.png
:width: 60%
Instructions will provide you with service-specific direction, provided by the service package developer, on what to expect, and how to use your new service.
.. figure:: /_static/images/services/service-instruct.svg
.. figure:: /_static/images/services/service-instruct.png
:width: 60%
.. note:: For advanced instructions and integration guides, visit the wrapper repository for an `available service <https://marketplace.start9.com>`_.

4
site/source/support/user-manual/services/managing-services/service-interfaces.rst
View File

@@ -6,10 +6,10 @@ Interfaces
Interfaces are URLs that a :ref:`Service<services>` uses to communicate in various ways with other software. Many Services will only have one interface, perhaps with a Tor and LAN address, to denote where it is hosted / accessed. Other services, such as Bitcoin or Lightning Nodes, may have several interfaces for different use-cases.
.. figure:: /_static/images/services/service-ints.svg
.. figure:: /_static/images/services/service-ints.png
:width: 60%
To view the instructions for a particular service, navigate to the :ref:`Services tab <services-tab>` *> [Service Name] > Properties*. From there you can copy a URL to your clipboard for use with external software.
.. figure:: /_static/images/services/service-ints0.svg
.. figure:: /_static/images/services/service-ints0.png
:width: 60%

2
site/source/support/user-manual/services/managing-services/service-logs.rst
View File

@@ -8,5 +8,5 @@ Naviage to *Services > [Service Name] > Logs*
Every service emits logs while it is in a *running* state. Logs give an *under-the-hood* glimpse of a service and can be extremely useful for debugging purposes. To a non-technical user, logs may look like gibberish, and sometimes there is nothing to see at all. You can check here if you have an issue with a service, and if you are talking to support, they may ask you to screenshot or copy these logs to help discover the root of the problem.
.. figure:: /_static/images/services/logs.svg
.. figure:: /_static/images/services/logs.png
:width: 60%

4
site/source/support/user-manual/services/managing-services/service-overview.rst
View File

@@ -11,7 +11,7 @@ Services are very similar to Applications on a mobile device. The biggest diffe
The Service Page
----------------
.. figure:: /_static/images/services/service8.svg
.. figure:: /_static/images/services/service8.png
:width: 60%
The Service Page
@@ -20,7 +20,7 @@ In the image above, we see an example of a Service's homescreen, where you can a
Below, we highlight the quick, need-to-know information of a Service that a user will want to see right away.
.. figure:: /_static/images/services/service00.svg
.. figure:: /_static/images/services/service00.png
:width: 60%
.. _service-status:

2
site/source/support/user-manual/services/managing-services/service-properties.rst
View File

@@ -6,7 +6,7 @@ Properties
Properties can contain both static and dynamic information about a service. They could be almost anything: a default username/password, an invite code, or a list of peers - anything the service developer thought might be useful.
.. figure:: /_static/images/services/props.svg
.. figure:: /_static/images/services/props.png
:width: 60%
To view the instructions for a particular service, navigate to the :ref:`Services tab <services-tab>` *> [Service Name] > Properties*.

6
site/source/support/user-manual/tuning/diy.rst
View File

@@ -4,7 +4,7 @@
DIY Guide
=========
.. figure:: /_static/images/diy/pi.svg
.. figure:: /_static/images/diy/pi.png
:width: 40%
:alt: Raspberry Pi
@@ -52,7 +52,7 @@ Hardware: Assembly
#. Insert mini speaker/buzzer into GPIO pins 6/8/10/12 with the word "speaker" facing out, `away from the board`.
.. figure:: /_static/images/diy/pins.svg
.. figure:: /_static/images/diy/pins.png
:width: 60%
:alt: Speaker board spec
@@ -91,7 +91,7 @@ Whether you purchase EmbassyOS from us or build it yourself, you'll need to flas
#. Click `Flash!` You may be asked to (1) approve the unusually large disk target or (2) enter your password. Both are normal.
.. figure:: /_static/images/diy/balena.svg
.. figure:: /_static/images/diy/balena.png
:width: 60%
:alt: Balena Etcher Dashboard

10
site/source/support/user-manual/tuning/tune-embassy-os.rst
View File

@@ -13,19 +13,19 @@ Here you can change the name of your Embassy!
#. Go to the ``Embassy`` tab on the main menu on the left side of the UI
.. figure:: /_static/images/config/basic-config0.svg
.. figure:: /_static/images/config/basic-config0.png
:width: 60%
:alt: Embassy Tab
#. Under the ``Settings`` section, click ``Preferences``
.. figure:: /_static/images/config/basic-config1.svg
.. figure:: /_static/images/config/basic-config1.png
:width: 60%
:alt: Preferences
#. Then click ``Device Name``, set to desired name, and click ``Save``
.. figure:: /_static/images/config/basic-config2.svg
.. figure:: /_static/images/config/basic-config2.png
:width: 60%
:alt: Rename Embassy
@@ -38,12 +38,12 @@ You may customize the layout of your Services by re-arranging them to your likin
#. Simply visit the ``Services`` tab on the main menu on the left side of the UI, and select ``Reorder`` in the top right.
.. figure:: /_static/images/walkthrough/reorder0.svg
.. figure:: /_static/images/walkthrough/reorder0.png
:width: 60%
:alt: Reorder Button
#. You can now click and drag on each service to create the ordered list you desire. When satisfied, click ``Done`` in the top right to save.
.. figure:: /_static/images/walkthrough/reorder1.svg
.. figure:: /_static/images/walkthrough/reorder1.png
:width: 60%
:alt: Reorder Services

12
site/source/support/user-manual/walkthrough/backups.rst
View File

@@ -13,12 +13,12 @@ Remote Backups
#. Go to the :ref:`Embassy tab<embassy-tab>`, then click on ``Create Backup``.
.. figure:: /_static/images/config/embassy_backup.svg
.. figure:: /_static/images/config/embassy_backup.png
:width: 60%
#. Next, click on ``+ New Shared Folder`` to use your previously created backup folder.
.. figure:: /_static/images/config/embassy_backup0.svg
.. figure:: /_static/images/config/embassy_backup0.png
:width: 60%
#. Fill in the following fields:
@@ -28,24 +28,24 @@ Remote Backups
* Username - This is the user on the remote machine that you used to create the shared directory
* Password - This is your user (from above) password
.. figure:: /_static/images/config/embassy_backup1.svg
.. figure:: /_static/images/config/embassy_backup1.png
:width: 60%
Then click ``Save``
#. You will see a freshly created "cloud" backup location available, click it for options, and click ``Create Backup`` to begin.
.. figure:: /_static/images/config/embassy_backup2.svg
.. figure:: /_static/images/config/embassy_backup2.png
:width: 60%
#. You can continue to use your Embassy while the backup is in progress.
.. figure:: /_static/images/config/embassy_backup3.svg
.. figure:: /_static/images/config/embassy_backup3.png
:width: 60%
#. When the backup is complete you will be notified in the :ref:`Notifications tab<notifications-tab>`, and you will see the date and time of your most recent backup updated under ``Backups`` in the Embassy tab.
.. figure:: /_static/images/config/embassy_backup4.svg
.. figure:: /_static/images/config/embassy_backup4.png
:width: 60%
Local Backups

10
site/source/support/user-manual/walkthrough/overview.rst
View File

@@ -11,12 +11,12 @@ Services Tab
The Services Tab will show you all of your currently installed :ref:`Services<services>`, or in the case of a fresh install, no Services. You can reorder this layout to your liking with the ``Reorder`` button in the top right. You can see a demo of this :ref:`here<reorder>`.
.. figure:: /_static/images/walkthrough/servicestab.svg
.. figure:: /_static/images/walkthrough/servicestab.png
:width: 60%
Click on any service in order to see its :ref:`Service Page<service-page>`.
.. figure:: /_static/images/walkthrough/servicepage.svg
.. figure:: /_static/images/walkthrough/servicepage.png
:width: 60%
.. _embassy-tab:
@@ -26,7 +26,7 @@ Embassy Tab
The Embassy Tab is where you can perform :ref:`Backups<backups>`, get Insights into EOS, change some basic Settings, and Power cycle your device if necessary.
.. figure:: /_static/images/walkthrough/embassytab.svg
.. figure:: /_static/images/walkthrough/embassytab.png
:width: 60%
Backups
@@ -71,7 +71,7 @@ Marketplace Tab
The Marketplace Tab is obviously the home of the Marketplace, where you can search out and install new Services, or manange existing ones. You can view our live Marketplace `here <marketplace.start9.com>`_.
.. figure:: /_static/images/walkthrough/markettab.svg
.. figure:: /_static/images/walkthrough/markettab.png
:width: 60%
Marketplace
@@ -84,5 +84,5 @@ Notifications Tab
The Notifications Tab is where you can view and manage information produced by EOS and your Services that may need your attention. You can clear these individually, or all at once with ``Delete All`` in the top right.
.. figure:: /_static/images/walkthrough/notiftab.svg
.. figure:: /_static/images/walkthrough/notiftab.png
:width: 60%

2
site/source/support/user-manual/walkthrough/sessions.rst
View File

@@ -8,5 +8,5 @@ Every time a login is made with Embassy, such as from a web browser on your lapt
To end a session, simply click ``Kill`` to the right of your selection.
.. figure:: /_static/images/walkthrough/sessions0.svg
.. figure:: /_static/images/walkthrough/sessions0.png
:width: 60%