diff --git a/site/03-todo.md b/site/03-todo.md index 917a4e7..8097a68 100644 --- a/site/03-todo.md +++ b/site/03-todo.md @@ -5,7 +5,6 @@ - Lightning Guides (Zeus) - Vaultwarden guide (screens) - Refactor and update Roadmap -- BLOCKED: Possible sounds in troubleshooting (and link in overview / upgrade pages) # AFTER PUBLISHING: - Add any new video content diff --git a/site/source/_static/images/ssl/browser/brave-authorities.png b/site/source/_static/images/ssl/browser/brave-authorities.png new file mode 100644 index 0000000..c51a7aa Binary files /dev/null and b/site/source/_static/images/ssl/browser/brave-authorities.png differ diff --git a/site/source/_static/sounds/BEETHOVEN.mp3 b/site/source/_static/sounds/BEETHOVEN.mp3 new file mode 100644 index 0000000..3028ff9 Binary files /dev/null and b/site/source/_static/sounds/BEETHOVEN.mp3 differ diff --git a/site/source/_static/sounds/BEP.mp3 b/site/source/_static/sounds/BEP.mp3 new file mode 100644 index 0000000..50c4059 Binary files /dev/null and b/site/source/_static/sounds/BEP.mp3 differ diff --git a/site/source/_static/sounds/CHIME.mp3 b/site/source/_static/sounds/CHIME.mp3 new file mode 100644 index 0000000..cffe710 Binary files /dev/null and b/site/source/_static/sounds/CHIME.mp3 differ diff --git a/site/source/_static/sounds/SHUTDOWN.mp3 b/site/source/_static/sounds/SHUTDOWN.mp3 new file mode 100644 index 0000000..544e89a Binary files /dev/null and b/site/source/_static/sounds/SHUTDOWN.mp3 differ diff --git a/site/source/learn/concepts/embassy.rst b/site/source/learn/concepts/embassy.rst index 315fd8f..29e20e8 100644 --- a/site/source/learn/concepts/embassy.rst +++ b/site/source/learn/concepts/embassy.rst @@ -11,6 +11,7 @@ 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. Check out the video below to get a brief overview: .. youtube:: GfMvXJxYamw + :width: 100% .. _embassy-os: @@ -18,6 +19,48 @@ EmbassyOS --------- EmbassyOS (EOS) is a Linux-based operating system custom built for self-hosting open source software. EOS has a range of features that allow anyone to run their own server software without needing all the traditionally required systems administration skills. Advanced dependency management, sensibly defaulted configuration with customization, and minimal reliance on the developers are just a few; all wrapped into a sleek GUI that anyone can operate. No command line required! +.. _sounds: + +Embassy Sounds +-------------- +EmbassyOS emits several sounds for user feedback and troubleshooting. Below are the current possible sounds and their meaning: + + .. raw:: HTML + + + + * "bep" - Starting up + + .. raw:: HTML + + + + * "chime" - Embassy is ready + + .. raw:: HTML + + + + * "shutdown" - Embassy is shutting down + + .. raw:: HTML + + + + * "Beethoven" - An error has occurred - check your Notifications for more info, or :ref:`Contact Support` + .. _product-key: EmbassyOS Product Key diff --git a/site/source/learn/concepts/self-hosting.rst b/site/source/learn/concepts/self-hosting.rst index 7ab6d66..b191544 100644 --- a/site/source/learn/concepts/self-hosting.rst +++ b/site/source/learn/concepts/self-hosting.rst @@ -12,6 +12,7 @@ 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: +For an overview of this idea in relation to EmbassyOS, please check out the video below: .. youtube:: dc741XwqlyU + :width: 100% diff --git a/site/source/learn/media/podcasts.rst b/site/source/learn/media/podcasts.rst index 8038c2f..e10b16d 100644 --- a/site/source/learn/media/podcasts.rst +++ b/site/source/learn/media/podcasts.rst @@ -6,6 +6,14 @@ Podcasts Podcasts featuring Start9 Labs and/or Embassy +.. topic-box:: + :title: February 24, 2022 - SLP352 Matt Hill + :link: https://stephanlivera.com/episode/352/ + :image: https://i0.wp.com/stephanlivera.com/wp-content/uploads/2022/02/SLP352-WP-Thumbnail.png + :anchor: Stephan Livera Podcast + + EmbassyOS & Making Self-Sovereignty Tech Cheaper Than The Alternatives + .. topic-box:: :title: January 25, 2022 - On The Record with Start9 :link: https://www.youtube.com/watch?v=jMV_DWAMtmc diff --git a/site/source/support/common-issues.rst b/site/source/support/common-issues.rst index 2633ae5..820ff1e 100644 --- a/site/source/support/common-issues.rst +++ b/site/source/support/common-issues.rst @@ -23,7 +23,7 @@ During initial setup, I am unable to connect to "embassy.local". * Confirm that your Embassy is plugged into both power and Ethernet. -* Confirm the Embassy emitted two sounds when powering on: a bep and a chime. +* Confirm the Embassy emitted two :ref:`sounds` when powering on: a bep and a chime. * Confirm your phone is **not** connected to a “Guest” network diff --git a/site/source/support/faq/faq-bitcoin.rst b/site/source/support/faq/faq-bitcoin.rst index 26a9118..ed49d1a 100644 --- a/site/source/support/faq/faq-bitcoin.rst +++ b/site/source/support/faq/faq-bitcoin.rst @@ -10,6 +10,7 @@ On first install, the Bitcoin service must verify the entire history of transact You can learn more about the Initial Block Download in `this video `_. .. youtube:: OrYDehC-8TU + :width: 100% Can the IBD (Initial Block Download) be made faster? Or can wait times be improved? ------------------------------------------------------------------------------------ @@ -56,7 +57,7 @@ Bitcoin Core is a full node that also contains wallet functionality. Some will You can use the wallet in Bitcoin Core, however it is for advanced users and is only available in the command line via SSH. It is helpful to think of the Bitcoin Core service on the Embassy as your own personal Bitcoin Server. This is your own verified source of truth of the Bitcoin ledger, that requires no permission for you to set up and own. The job of your Bitcoin server is to verify that the transactions you want to make and receive are valid. -There are modern wallets that have the ability to use your personal Bitcoin node as a source of truth, and with the advantages of additional security and advanced features. This also follows the Linux mantra of "do one thing and do it well." The recommended way to use Bitcoin with your Embassy’s Bitcoin node is with an external wallet. +There are modern wallets that have the ability to use your personal Bitcoin node as a source of truth, and with the advantages of additional security and advanced features. This also follows the Linux mantra of "do one thing and do it well." The recommended way to use Bitcoin with your Embassy’s Bitcoin node is with an external wallet. The available wallets are listed in the following FAQ. Which wallets can I use that sync with my Embassy Bitcoin and/or Lightning nodes? @@ -81,4 +82,4 @@ You would use your hardware signer with your wallet, then instruct that wallet t - Signers are for generating and storing keys, as well as signing transactions. -The reason there is so much confusion about these 3 concepts is that the Bitcoin Core Node comes with its own Wallet (which you should not use), and that wallet is also a signer. In fact, most wallets double as signers, and most wallets do NOT support connecting to your own node. So, most wallets are actually serving as a wallet, a node, and a signer, which might be convenient, but it is neither trustless nor maximally secure. Ideally, you are using a wallet that supports both integrating with a hardware signer (like Coldcard or Trezor) AND a backend node (like on the Embassy). \ No newline at end of file +The reason there is so much confusion about these 3 concepts is that the Bitcoin Core Node comes with its own Wallet (which you should not use), and that wallet is also a signer. In fact, most wallets double as signers, and most wallets do NOT support connecting to your own node. So, most wallets are actually serving as a wallet, a node, and a signer, which might be convenient, but it is neither trustless nor maximally secure. Ideally, you are using a wallet that supports both integrating with a hardware signer (like Coldcard or Trezor) AND a backend node (like on the Embassy). diff --git a/site/source/support/faq/faq-general.rst b/site/source/support/faq/faq-general.rst index 0e8f1f4..47162ec 100644 --- a/site/source/support/faq/faq-general.rst +++ b/site/source/support/faq/faq-general.rst @@ -31,6 +31,7 @@ When you install Bitwarden on your Embassy, by contrast, it's like building your This `podcast `_ may help expound upon why this is important. .. youtube:: aylDowaSdzU + :width: 100% How does Embassy work? ---------------------- @@ -57,7 +58,7 @@ EmbassyOS is a custom-built Linux distribution, which is a beefed up version of * Upgrade your Embassy software with the latest features and security updates * Backup services, and restore from backups if needed -It includes: +It includes: * a custom application management layer, specialized for installing, running, and backing up .s9pk packaged services * a layer responsible for Embassy specific operations, such as Tor, Backups, and Notifications @@ -121,4 +122,4 @@ I want to help, but I'm not a developer. Are there any ways for non-coders to c 3. Make tutorial videos 4. Write instruction manuals or commit to the docs -Check out the :ref:`Contribute` section of this site for more details. \ No newline at end of file +Check out the :ref:`Contribute` section of this site for more details. diff --git a/site/source/support/faq/faq-lightning.rst b/site/source/support/faq/faq-lightning.rst index 50470e3..0f4dbfb 100644 --- a/site/source/support/faq/faq-lightning.rst +++ b/site/source/support/faq/faq-lightning.rst @@ -13,6 +13,7 @@ How can I get started with Lightning and open my first channel? You can check out our `"Using Lightning" video `_ and learn the basics, including opening a channel with Start9. .. youtube:: KhU_sTiaN8w + :width: 100% Please remember to always open a "Private" channel with us, or your channel is likely to be closed. Please don't hesitate to reach out to us with any questions. diff --git a/site/source/user-manual/connecting/connecting-lan/lan-browser/lan-brave.rst b/site/source/user-manual/connecting/connecting-lan/lan-browser/lan-brave.rst index c8287b7..afa061c 100644 --- a/site/source/user-manual/connecting/connecting-lan/lan-browser/lan-brave.rst +++ b/site/source/user-manual/connecting/connecting-lan/lan-browser/lan-brave.rst @@ -24,6 +24,12 @@ Trust Embassy CA in Brave :width: 60% :alt: Brave Security settings page +#. Click the "Authorities" tab + + .. figure:: /_static/images/ssl/browser/brave-authorities.png + :width: 60% + :alt: Certificate Authorities + #. If you see "org-Start9" with a trusted “Embassy Local Root CA” listed under it, open a new tab to apply the certificate. If this does not work, quit and restart Brave. #. If you do not see "org-Start9" in the list, click "Import" and open the downloaded "Embassy Local Root CA.crt" file on your device. Check the box for "Trust this certificate for identifying websites" and click "OK". diff --git a/site/source/user-manual/connecting/connecting-tor/tor-firefox/torff-android.rst b/site/source/user-manual/connecting/connecting-tor/tor-firefox/torff-android.rst index e497d3c..b01c87f 100644 --- a/site/source/user-manual/connecting/connecting-tor/tor-firefox/torff-android.rst +++ b/site/source/user-manual/connecting/connecting-tor/tor-firefox/torff-android.rst @@ -39,7 +39,7 @@ Once Tor is setup on your system, you can proceed to setup Firefox: :width: 50% :alt: Firefox socks remote dns setting screenshot -7. Search for ``dom.securecontext.whitelist_onions`` and set the value to ``true``. +7. Search for ``dom.securecontext.allowlist_onions`` and set the value to ``true``. On some older versions, this may be called ``dom.securecontext.whitelist_onions``. .. figure:: /_static/images/tor/firefox_whitelist_mobile.png :width: 50% diff --git a/site/source/user-manual/connecting/connecting-tor/tor-firefox/torff-linux.rst b/site/source/user-manual/connecting/connecting-tor/tor-firefox/torff-linux.rst index fc23ccf..93d9a4c 100644 --- a/site/source/user-manual/connecting/connecting-tor/tor-firefox/torff-linux.rst +++ b/site/source/user-manual/connecting/connecting-tor/tor-firefox/torff-linux.rst @@ -9,7 +9,7 @@ Configuring Firefox for Tor on Linux #. Open Firefox and enter ``about:config`` in the URL bar. Accept any warnings that may appear about accessing advanced settings. -#. Search for ``dom.securecontext.whitelist_onions`` and set the value to ``true``. +#. Search for ``dom.securecontext.allowlist_onions`` and set the value to ``true``. On some older versions, this may be called ``dom.securecontext.whitelist_onions``. .. figure:: /_static/images/tor/firefox_whitelist.png :width: 60% diff --git a/site/source/user-manual/connecting/connecting-tor/tor-firefox/torff-mac.rst b/site/source/user-manual/connecting/connecting-tor/tor-firefox/torff-mac.rst index f206d4d..c91b3b9 100644 --- a/site/source/user-manual/connecting/connecting-tor/tor-firefox/torff-mac.rst +++ b/site/source/user-manual/connecting/connecting-tor/tor-firefox/torff-mac.rst @@ -9,7 +9,7 @@ Configuring Firefox for Tor on Mac #. Open Firefox and enter ``about:config`` in the URL bar. Accept any warnings that may appear about accessing advanced settings. -#. Search for ``dom.securecontext.whitelist_onions`` and set the value to ``true``. +#. Search for ``dom.securecontext.allowlist_onions`` and set the value to ``true``. On some older versions, this may be called ``dom.securecontext.whitelist_onions``. .. figure:: /_static/images/tor/firefox_whitelist.png :width: 60% diff --git a/site/source/user-manual/connecting/connecting-tor/tor-firefox/torff-windows.rst b/site/source/user-manual/connecting/connecting-tor/tor-firefox/torff-windows.rst index 82c913e..670f5c1 100644 --- a/site/source/user-manual/connecting/connecting-tor/tor-firefox/torff-windows.rst +++ b/site/source/user-manual/connecting/connecting-tor/tor-firefox/torff-windows.rst @@ -8,7 +8,7 @@ Configuring Firefox for Tor on Windows #. Open Firefox and enter ``about:config`` in the URL bar. Accept any warnings that may appear about accessing advanced settings. -#. Search for ``dom.securecontext.whitelist_onions`` and set the value to "true". +#. Search for ``dom.securecontext.allowlist_onions`` and set the value to "true". On some older versions, this may be called ``dom.securecontext.whitelist_onions``. .. figure:: /_static/images/tor/firefox_whitelist.png :width: 60% diff --git a/site/source/user-manual/connecting/connecting-tor/tor-os/tor-android.rst b/site/source/user-manual/connecting/connecting-tor/tor-os/tor-android.rst index f4fff82..d1c3824 100644 --- a/site/source/user-manual/connecting/connecting-tor/tor-os/tor-android.rst +++ b/site/source/user-manual/connecting/connecting-tor/tor-os/tor-android.rst @@ -7,6 +7,7 @@ Running Tor on Android Some apps, such as :ref:`Tor Browser`, have Tor built in. They do not require additional software or configurations to utilize Tor. Most apps, however, do not have Tor built in. They require an app called Orbot to be installed in order to utilize the Tor Network. .. youtube:: b__mVfN-BP8 + :width: 100% Running Orbot ------------- diff --git a/site/source/user-manual/initial-setup.rst b/site/source/user-manual/initial-setup.rst index 1b2dd68..8f82a72 100644 --- a/site/source/user-manual/initial-setup.rst +++ b/site/source/user-manual/initial-setup.rst @@ -7,6 +7,7 @@ Initial Setup Check out our quick setup video below, and follow along with the steps in this guide: .. youtube:: DmTlwp5_zvY + :width: 100% Powering On ----------- @@ -19,9 +20,24 @@ Powering On #. You will hear 2 distinct sounds: + .. raw:: HTML + + + * "bep" - Starting up + + .. raw:: HTML + + + * "chime" - Embassy is ready - + .. caution:: If you followed the DIY guide and built EmbassyOS from source code, it may take up to 20 minutes to first initialize. Claiming your Device diff --git a/site/source/user-manual/service-guides/lightning.rst b/site/source/user-manual/service-guides/lightning.rst index d38dd21..06a58f3 100644 --- a/site/source/user-manual/service-guides/lightning.rst +++ b/site/source/user-manual/service-guides/lightning.rst @@ -7,6 +7,7 @@ Lightning Check out our `Getting Started with Lightning video `_ for an introduction to the Lightning Network using LND and RTL on Embassy! .. youtube:: KhU_sTiaN8w + :width: 100% .. _blue-wallet-lightning: @@ -85,4 +86,4 @@ LND ... Spark -..... \ No newline at end of file +..... diff --git a/site/source/user-manual/service-guides/matrix.rst b/site/source/user-manual/service-guides/matrix.rst index 9f5d703..9fe197e 100644 --- a/site/source/user-manual/service-guides/matrix.rst +++ b/site/source/user-manual/service-guides/matrix.rst @@ -7,3 +7,4 @@ Matrix Check out our `Synapse video `_ for features and setup! .. youtube:: PtwQsybFapo + :width: 100% diff --git a/site/source/user-manual/service-guides/vaultwarden.rst b/site/source/user-manual/service-guides/vaultwarden.rst index 21f02ba..2b0cff1 100644 --- a/site/source/user-manual/service-guides/vaultwarden.rst +++ b/site/source/user-manual/service-guides/vaultwarden.rst @@ -9,7 +9,7 @@ Vaultwarden Check out our `Vaultwarden video `_ for basic features and setup! .. youtube:: YcxxVHpm9j0 - + :width: 100% Web Vault --------- @@ -89,12 +89,12 @@ Mac #. LAN #. First, be sure to :ref:`Setup LAN ` natively. - + #. For LAN access, follow the LAN setup in the instructions below. After completing setup, simply open Bitwarden and add your LAN address in the 'Settings' and login. #. Tor #. First, be sure to :ref:`Setup Tor ` natively. - + #. Run the program with the flag ` --proxy-server=socks5://127.0.0.1:9050` behind it. You can run this from a terminal, and if you'd like to use a shortcut, edit that shortcut file to include the flag. #. You can now log in to your vault. diff --git a/site/source/user-manual/upgrade-02.rst b/site/source/user-manual/upgrade-02.rst index 13ef120..818dfa3 100644 --- a/site/source/user-manual/upgrade-02.rst +++ b/site/source/user-manual/upgrade-02.rst @@ -33,6 +33,7 @@ Backing up If you're unsure how to do this - please follow `this `_ guide. .. youtube:: _QJXgnE90ko + :width: 100% With your Embassy safely backed up, it's time to proceed with the migration. diff --git a/sphinx-scylladb-theme b/sphinx-scylladb-theme index 8558b5f..3e0c910 160000 --- a/sphinx-scylladb-theme +++ b/sphinx-scylladb-theme @@ -1 +1 @@ -Subproject commit 8558b5f7704da1f4a0a52c40b390fc1ff7de290f +Subproject commit 3e0c910002565211409da09c35223ae0f6a45cb1