mirror of
https://github.com/Start9Labs/documentation.git
synced 2026-03-26 02:11:55 +00:00
Added podcast, Brave ssl
This commit is contained in:
@@ -1,34 +1,31 @@
|
||||
# ToDo
|
||||
|
||||
- [ ] Refactor and update Roadmap
|
||||
- [ ] Footer links need update (or removal?)
|
||||
- [ ] Add screenshots and details
|
||||
- [ ] Verify ALL links (especially in device guides as they are all external)
|
||||
- [ ] Check all menus behave and display as expected (issues cut)
|
||||
- [ ] Verify all TOCs, etc
|
||||
- [ ] Add / verify ALL links in the **UI** go to the right place in docs
|
||||
- [ ] Add / verify ALL links in the **UI** go to the right place in docs
|
||||
- [ ] Update all guides in service repos
|
||||
- [ ] Address build errors
|
||||
- [ ] Launch versioned site/docs to start9.com
|
||||
- [ ] There are many issues that should be closed by 0.3 docs release, check that this is the case (some issues await new processes in order to test)
|
||||
- [ ] Below checklist (wiped as completed)
|
||||
|
||||
- Getting Started
|
||||
- [ ] There are many issues that should be closed by 0.3 docs release (some issues await new processes in order to test)
|
||||
- [ ] Getting Started
|
||||
- Initial Setup
|
||||
- Device-specific Guides <connectivity, performance, resilience and/or tuning>
|
||||
- (after release) create badges for topic boxes
|
||||
- Configuration
|
||||
- [ ] Configuration
|
||||
- LAN Setup
|
||||
- Android - Screenshots of LAN setup and verify steps on an Android 12+ device
|
||||
- Brave
|
||||
- Chrome
|
||||
- Firefox
|
||||
- Tunin
|
||||
- [ ] Tuning
|
||||
- DIY Guide
|
||||
- Advanced Config
|
||||
- SSH over Tor
|
||||
- Service-specific Guides
|
||||
# Developer Documentation
|
||||
- [ ] Developer Documentation
|
||||
- embassy-sdk
|
||||
- Service Packaging Spec
|
||||
- Service Packaging Walkthrough (Hello-World Example)
|
||||
@@ -36,14 +33,14 @@
|
||||
- Contributing
|
||||
- Service Packaging
|
||||
|
||||
- Alt Market Build Guide
|
||||
- Mission / values
|
||||
- Backups
|
||||
- [ ] Alt Market Build Guide
|
||||
- [ ] Mission / values
|
||||
- [ ] Backups
|
||||
- CIFS
|
||||
- OS guides for CIFS (screens)
|
||||
- Local
|
||||
- Restore from backup
|
||||
- Migrations
|
||||
- Possible sounds in troubleshooting (and walkthrough?)
|
||||
- Verify LAN setup steps on a Mac
|
||||
- Verify Tor setup steps on a Mac
|
||||
- [ ] Migrations
|
||||
- [ ] Possible sounds in troubleshooting (and walkthrough?)
|
||||
- [ ] Verify LAN setup steps on a Mac
|
||||
- [ ] Verify Tor setup steps on a Mac
|
||||
|
||||
BIN
site/source/_static/images/ssl/browser/brave_security.svg
Normal file
BIN
site/source/_static/images/ssl/browser/brave_security.svg
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 182 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 180 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 160 KiB |
BIN
site/source/_static/images/ssl/browser/brave_settings.svg
Normal file
BIN
site/source/_static/images/ssl/browser/brave_settings.svg
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 56 KiB |
|
Before Width: | Height: | Size: 176 KiB After Width: | Height: | Size: 176 KiB |
@@ -6,6 +6,14 @@ Podcasts
|
||||
|
||||
Podcasts featuring Start9 Labs and/or Embassy
|
||||
|
||||
.. topic-box::
|
||||
:title: January 25, 2022 - On The Record with Start9
|
||||
:link: https://www.youtube.com/watch?v=jMV_DWAMtmc
|
||||
:image: https://i3.ytimg.com/vi/jMV_DWAMtmc/maxresdefault.jpg
|
||||
:anchor: On The Record
|
||||
|
||||
Start9 demo the latest version of EmbassyOS
|
||||
|
||||
.. topic-box::
|
||||
:title: November 29, 2021 - Episode #101: Securing your own data with Matt Hill of Start9
|
||||
:link: https://www.agoristnexus.com/securing-your-own-data-with-matt-hill-of-start9-episode-101/
|
||||
|
||||
@@ -4,26 +4,36 @@
|
||||
Brave
|
||||
=====
|
||||
|
||||
#. Navigate to your Brave Settings in a new tab.
|
||||
.. caution:: You will first need to complete :ref:`LAN Setup<lan-os>` for your device before continuing.
|
||||
|
||||
#. On the left hand sidebar, navigate to *Additional Settings > Privacy and Security*.
|
||||
#. Open a new tab in Brave and Navigate to ``Settings`` from the top-right hamburger menu.
|
||||
|
||||
#. Add the bottom of the section, select "Manage Certificates".
|
||||
.. figure:: /_static/images/ssl/browser/brave_settings.svg
|
||||
:width: 30%
|
||||
:alt: Brave settings page
|
||||
|
||||
.. figure:: /_static/images/ssl/browser/brave_security_settings.png
|
||||
:width: 90%
|
||||
:alt: Brave privacy and security 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
|
||||
: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
|
||||
:width: 60%
|
||||
:alt: Brave Security settings page
|
||||
|
||||
#. If you see a trusted “Embassy Local Root CA”, open a new tab to apply the certificate. If this does not work, quit and restart Brave.
|
||||
|
||||
#. If you do not see a trusted “Embassy Local Root CA” certificate in the list, ensure the certificate is properly set up on your computer system.
|
||||
|
||||
.. figure:: /_static/images/ssl/browser/brave_view_certs.png
|
||||
:width: 90%
|
||||
:alt: Brave Manage Certificates sub-menu on MacOS
|
||||
.. figure:: /_static/images/ssl/browser/brave_view_certs.svg
|
||||
:width: 60%
|
||||
:alt: Brave Manage Certificates sub-menu on MacOS
|
||||
|
||||
#. Obtain the LAN address provided in the Setup App and enter it in a new tab.
|
||||
#. Obtain the LAN address that was provided at the end of your initial Embassy setup, or from the :ref:`Embassy tab<embassy-tab>` -> ``About`` (Under ``Insights``) and enter it in a new tab.
|
||||
|
||||
#. You can now securely navigate to your Embassy over HTTPS!
|
||||
|
||||
#. Additionally, you can start a Brave private window with Tor to visit the Tor address over HTTPS (unnecessary in principle, but will circumvent annoying browser warnings).
|
||||
.. note:: Additionally, you can start a Brave private window with Tor to visit the Tor address over HTTPS (unnecessary in principle, but will circumvent annoying browser warnings).
|
||||
@@ -27,7 +27,7 @@ Once Tor is setup on your system, you can proceed to setup Firefox:
|
||||
|
||||
5. Search for ``network.proxy.autoconfig_url``, and set the value to ``file:///storage/emulated/0/Download/proxy.pac``.
|
||||
|
||||
.. note:: For newer Android's, and those running CalyxOS, 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``. Please reach out to support if you have issues.
|
||||
.. 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
|
||||
:width: 50%
|
||||
|
||||
@@ -15,43 +15,42 @@ By popular demand, we are pleased to present this "Do it Yourself" (DIY) guide f
|
||||
Motivation
|
||||
----------
|
||||
|
||||
There are four reasons you might prefer to build your own Embassy instead of purchasing one from us.
|
||||
There are several reasons you might prefer to build your own Embassy instead of purchasing one from us:
|
||||
|
||||
#. You already own the necessary hardware and would like to re-purpose it.
|
||||
|
||||
#. You live outside the US and want to save on shipping costs.
|
||||
|
||||
#. You do not trust Start9's supply chain.
|
||||
|
||||
#. You do not want to share your shipping address.
|
||||
|
||||
#. You just like building things.
|
||||
#. You already own the necessary hardware and would like to re-purpose it.
|
||||
#. You live outside the US and want to save on shipping costs.
|
||||
#. You do not trust Start9's supply chain.
|
||||
#. You do not want to share your shipping address.
|
||||
#. You just like building things.
|
||||
|
||||
Building an Embassy
|
||||
-------------------
|
||||
|
||||
The first thing you'll need to do is gather the hardware and assemble it.
|
||||
|
||||
Hardware: Components
|
||||
....................
|
||||
|
||||
#. `Raspberry Pi 4B (8GB) <https://raspberrypi.org/products/raspberry-pi-4-model-b/?variant=raspberry-pi-4-model-b-8gb>`_
|
||||
#. `Power supply for Raspberry Pi 4B <https://raspberrypi.org/products/type-c-power-supply/>`_ Make sure this is at minimum 15w and 3.5a.
|
||||
#. Case for Raspberry Pi 4B (`passive cooling recommended <https://www.amazon.com/Geekworm-Raspberry-Aluminum-Passive-Heatsink/dp/B07Z6FYHCH/>`_ `*`)
|
||||
#. Case for Raspberry Pi 4B (`passive cooling <https://www.amazon.com/Geekworm-Raspberry-Aluminum-Passive-Heatsink/dp/B07Z6FYHCH/>`_ is recommended). This means no moving parts and no noise, as a fan is not required.
|
||||
|
||||
.. caution:: If you prefer to use a fan, **DO NOT** use the official Raspberry Pi fan, as it requires the same GPIO pins as the audio speaker. Instead, we recommend `this fan <https://www.amazon.com/Raspberry-iUniker-30x30x7mm-Brushless-RetroFlag/dp/B076H3TKBP/>`_.
|
||||
|
||||
#. A `16GB microSD card <https://amazon.com/SanDisk-Endurance-microSDXC-Adapter-Monitoring/dp/B07NY23WBG/>`_ (no need for bigger). If you have ABSOLUTELY NO data to migrate, you may choose to re-use the card already in your Embassy.
|
||||
#. `GPIO mini speaker/buzzer <https://www.amazon.com/Corporate-Computer-Motherboard-Internal-Speaker/dp/B01527H4W2/>`_ (These often sell out, please let us know if this link needs to be refreshed)
|
||||
#. Ethernet cable
|
||||
#. MicroSD → USB adapter (or you may have a microSD port on your computer)
|
||||
#. An external drive (1TB minimum, 2TB SSD recommended), or an `internal drive <https://www.amazon.com/Crucial-MX500-NAND-SATA-Internal/dp/B078211KBB>`_ with an `USB enclosure <https://www.amazon.com/gp/product/B07T9D8F6C>`_, as sold with our upgrade kits. MUST CONNECT OVER USB 3.0
|
||||
|
||||
`*` If you use a fan, **DO NOT** use the official Raspberry Pi fan, as it requires the same GPIO pins as the audio speaker. Instead, we recommend `this fan <https://www.amazon.com/Raspberry-iUniker-30x30x7mm-Brushless-RetroFlag/dp/B076H3TKBP/>`_.
|
||||
|
||||
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
|
||||
:width: 60%
|
||||
:alt: Speaker board spec
|
||||
.. figure:: /_static/images/diy/pins.svg
|
||||
:width: 60%
|
||||
:alt: Speaker board spec
|
||||
|
||||
#. Place the Raspberry Pi 4 board (with speaker attached), into its case.
|
||||
#. Plug in the external drive to one of the USB 3.0 (blue) slots
|
||||
@@ -59,35 +58,40 @@ Hardware: Assembly
|
||||
Getting EmbassyOS
|
||||
-----------------
|
||||
|
||||
After building your device, you need a copy of EmbassyOS.
|
||||
|
||||
Getting EmbassyOS: Purchasing
|
||||
.............................
|
||||
|
||||
You can purchase EmbassyOS `here <https://store.start9.com/collections/embassy/products/embassyos-software-download>`_. This is by far the easiest path to get up and running.
|
||||
- You can purchase EmbassyOS `here <https://store.start9.com/collections/embassy/products/embassyos-software-download>`_. This is by far the easiest path to get up and running.
|
||||
|
||||
Depending on your Internet speed, the download should take between 5 and 30 minutes.
|
||||
- Depending on your Internet speed, the download should take between 5 and 30 minutes.
|
||||
|
||||
Getting EmbassyOS: Building from Source
|
||||
.......................................
|
||||
|
||||
If you prefer to build EmbassyOS from source, you can do so following our guide on the `Start9 GitHub <https://github.com/Start9Labs/embassy-os/tree/master/build>`_.
|
||||
- If you prefer to build EmbassyOS from source, you can do so following our guide on the `Start9 GitHub <https://github.com/Start9Labs/embassy-os/tree/master/build>`_.
|
||||
|
||||
Installing EmbassyOS
|
||||
--------------------
|
||||
|
||||
Whether you purchase EmbassyOS from us or build it yourself, you need to flash it onto a microSD card.
|
||||
Whether you purchase EmbassyOS from us or build it yourself, you'll need to flash it onto a microSD card.
|
||||
|
||||
#. Download `balenaEtcher <https://www.balena.io/etcher/>`_ onto your Mac, Windows, or Linux computer.
|
||||
#. Insert the microSD card into your computer, either directly or using an adapter.
|
||||
#. Open balenaEtcher.
|
||||
#. Click `Select Image`, then find and select your copy of EmbassyOS.
|
||||
#. Click `Select Target`, then find and select your micro SD card.
|
||||
|
||||
.. warning:: BE CERTAIN YOU SELECT THE CORRECT DISK AS IT WILL BE ERASED AND WRITTEN OVER
|
||||
|
||||
#. 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
|
||||
:width: 60%
|
||||
:alt: Balena Etcher Dashboard
|
||||
.. figure:: /_static/images/diy/balena.svg
|
||||
:width: 60%
|
||||
:alt: Balena Etcher Dashboard
|
||||
|
||||
#. Once the image is flashed and verified, you may remove the micro SD, insert it into your Embassy, and power up the device.
|
||||
#. The Embassy is now ready for use, and you may following the normal :ref:`setup <initial-setup>` instructions. ``*``
|
||||
#. The Embassy is now ready for use, and you may continue following the normal :ref:`Initial Setup <initial-setup>` instructions.
|
||||
|
||||
``*`` The first time you power it on, your Embassy will make more noises than future attempts, and it may take several minutes to finally complete.
|
||||
.. note:: The first time you power on your Embassy it may take 10-20 minutes to initialize.
|
||||
|
||||
Reference in New Issue
Block a user