mirror of
https://github.com/Start9Labs/documentation.git
synced 2026-04-04 14:29:45 +00:00
DG Backups, About init, minor edits
This commit is contained in:
kn0wmad
@@ -4,6 +4,8 @@
|
||||
Android
|
||||
=======
|
||||
|
||||
.. note:: Please see Android's :ref:`Known Limitations<lim-android>` to understand what is currently not possible on these devices
|
||||
|
||||
Tor Setup (Connectivity)
|
||||
------------------------
|
||||
|
||||
@@ -13,5 +15,3 @@ Tor Firefox Config (Connectivity)
|
||||
---------------------------------
|
||||
|
||||
`Configure Firefox <docs.start9.com/user-manual/configuration/tor-setup/tor-firefox/torff-android>`_ to be able to use the :ref:`Tor Network<tor>` so that you can reach ``.onion`` sites without needing to change browsers.
|
||||
|
||||
.. note:: Please see Android's :ref:`Known Limitations<lim-android>` to understand what is currently not possible on these devices
|
||||
@@ -4,9 +4,9 @@
|
||||
iOS
|
||||
===
|
||||
|
||||
.. note:: Please see iOS's :ref:`Known Limitations<lim-ios>` to understand what is currently not possible on these devices
|
||||
|
||||
LAN Setup (Connectivity, Performance)
|
||||
-------------------------------------
|
||||
|
||||
`Setup LAN Access <docs.start9.com/user-manual/configuration/lan-setup/lan-ios>`_ for a fast and secure connection while on your Embassy's local network.
|
||||
|
||||
.. note:: Please see iOS's :ref:`Known Limitations<lim-ios>` to understand what is currently not possible on these devices
|
||||
@@ -4,19 +4,24 @@
|
||||
Linux Guides
|
||||
============
|
||||
|
||||
.. note:: Please see Linux's :ref:`Known Limitations<lim-linux>` to understand what is currently not possible on these devices
|
||||
|
||||
LAN Setup (Connectivity, Performance)
|
||||
-------------------------------------
|
||||
|
||||
`Setup LAN Access <docs.start9.com/user-manual/configuration/lan-setup/lan-linux>`_ for a fast and secure connection while on your Embassy's local network.
|
||||
`Setup LAN Access <https://docs.start9.com/support/user-manual/configuration/lan-setup/lan-linux>`_ for a fast and secure connection while on your Embassy's local network.
|
||||
|
||||
Tor Setup (Connectivity)
|
||||
------------------------
|
||||
|
||||
`Setup Tor <docs.start9.com/user-manual/configuration/tor-setup/tor-os/tor-linux>`_ to run natively (in the background) on your device. This will allow you to use applications on your Linux machine via the :ref:`Tor Network<tor>` so they can communicate with your Embassy.
|
||||
`Setup Tor <https://docs.start9.com/support/user-manual/configuration/tor-setup/tor-os/tor-linux>`_ to run natively (in the background) on your device. This will allow you to use applications on your Linux machine via the :ref:`Tor Network<tor>` so they can communicate with your Embassy.
|
||||
|
||||
Tor Firefox Config (Connectivity)
|
||||
---------------------------------
|
||||
|
||||
`Configure Firefox <docs.start9.com/user-manual/configuration/tor-setup/tor-firefox/torff-linux>`_ to be able to use the :ref:`Tor Network<tor>` so that you can reach ``.onion`` sites without needing to change browsers.
|
||||
`Configure Firefox <https://docs.start9.com/support/user-manual/configuration/tor-setup/tor-firefox/torff-linux>`_ to be able to use the :ref:`Tor Network<tor>` so that you can reach ``.onion`` sites without needing to change browsers.
|
||||
|
||||
.. note:: Please see Linux's :ref:`Known Limitations<lim-linux>` to understand what is currently not possible on these devices
|
||||
Embassy Backups (Reliability)
|
||||
-----------------------------
|
||||
|
||||
`Configure Remote Backup <https://docs.start9.com/support/user-manual/walkthrough/backup/backup-lin>`_ of your Embassy to your Linux machine. **Backups are supremely important** as they ensure redundancy of your data for convenience, as well as preventing loss in case of disaster.
|
||||
|
||||
@@ -4,19 +4,24 @@
|
||||
Mac
|
||||
===
|
||||
|
||||
.. note:: Please see Mac's :ref:`Known Limitations<lim-mac>` to understand what is currently not possible on these devices
|
||||
|
||||
LAN Setup (Connectivity, Performance)
|
||||
-------------------------------------
|
||||
|
||||
`Setup LAN Access <docs.start9.com/user-manual/configuration/lan-setup/lan-mac>`_ for a fast and secure connection while on your Embassy's local network.
|
||||
`Setup LAN Access <https://docs.start9.com/support/user-manual/configuration/lan-setup/lan-mac>`_ for a fast and secure connection while on your Embassy's local network.
|
||||
|
||||
Tor Setup (Connectivity)
|
||||
------------------------
|
||||
|
||||
`Setup Tor <docs.start9.com/user-manual/configuration/tor-setup/tor-os/tor-mac>`_ to run natively (in the background) on your device. This will allow you to use applications on your Mac via the :ref:`Tor Network<tor>` so they can communicate with your Embassy.
|
||||
`Setup Tor <https://docs.start9.com/support/user-manual/configuration/tor-setup/tor-os/tor-mac>`_ to run natively (in the background) on your device. This will allow you to use applications on your Mac via the :ref:`Tor Network<tor>` so they can communicate with your Embassy.
|
||||
|
||||
Tor Firefox Config (Connectivity)
|
||||
---------------------------------
|
||||
|
||||
`Configure Firefox <docs.start9.com/user-manual/configuration/tor-setup/tor-firefox/torff-mac>`_ to be able to use the :ref:`Tor Network<tor>` so that you can reach ``.onion`` sites without needing to change browsers.
|
||||
`Configure Firefox <https://docs.start9.com/support/user-manual/configuration/tor-setup/tor-firefox/torff-mac>`_ to be able to use the :ref:`Tor Network<tor>` so that you can reach ``.onion`` sites without needing to change browsers.
|
||||
|
||||
.. note:: Please see Mac's :ref:`Known Limitations<lim-mac>` to understand what is currently not possible on these devices
|
||||
Embassy Backups (Reliability)
|
||||
-----------------------------
|
||||
|
||||
`Configure Remote Backup <https://docs.start9.com/support/user-manual/walkthrough/backup/backup-mac>`_ of your Embassy to your Mac device. **Backups are supremely important** as they ensure redundancy of your data for convenience, as well as preventing loss in case of disaster.
|
||||
|
||||
@@ -4,19 +4,24 @@
|
||||
Windows
|
||||
=======
|
||||
|
||||
.. note:: Please see Window's :ref:`Known Limitations<lim-windows>` to understand what is currently not possible on these devices
|
||||
|
||||
LAN Setup (Connectivity, Performance)
|
||||
-------------------------------------
|
||||
|
||||
`Setup LAN Access <docs.start9.com/user-manual/configuration/lan-setup/lan-windows>`_ for a fast and secure connection while on your Embassy's local network.
|
||||
`Setup LAN Access <https://docs.start9.com/support/user-manual/configuration/lan-setup/lan-windows>`_ for a fast and secure connection while on your Embassy's local network.
|
||||
|
||||
Tor Setup (Connectivity)
|
||||
------------------------
|
||||
|
||||
`Setup Tor <docs.start9.com/user-manual/configuration/tor-setup/tor-os/tor-windows>`_ to run natively (in the background) on your device. This will allow you to use applications on your Windows machine via the :ref:`Tor Network<tor>` so they can communicate with your Embassy.
|
||||
`Setup Tor <https://docs.start9.com/support/user-manual/configuration/tor-setup/tor-os/tor-windows>`_ to run natively (in the background) on your device. This will allow you to use applications on your Windows machine via the :ref:`Tor Network<tor>` so they can communicate with your Embassy.
|
||||
|
||||
Tor Firefox Config (Connectivity)
|
||||
---------------------------------
|
||||
|
||||
`Configure Firefox <docs.start9.com/user-manual/configuration/tor-setup/tor-firefox/torff-windows>`_ to be able to use the :ref:`Tor Network<tor>` so that you can reach ``.onion`` sites without needing to change browsers.
|
||||
`Configure Firefox <https://docs.start9.com/support/user-manual/configuration/tor-setup/tor-firefox/torff-windows>`_ to be able to use the :ref:`Tor Network<tor>` so that you can reach ``.onion`` sites without needing to change browsers.
|
||||
|
||||
.. note:: Please see Window's :ref:`Known Limitations<lim-windows>` to understand what is currently not possible on these devices
|
||||
Embassy Backups (Reliability)
|
||||
-----------------------------
|
||||
|
||||
`Configure Remote Backup <https://docs.start9.com/support/user-manual/walkthrough/backup/backup-win>`_ of your Embassy to your Windows machine. **Backups are supremely important** as they ensure redundancy of your data for convenience, as well as preventing loss in case of disaster.
|
||||
|
||||
@@ -1,8 +1,10 @@
|
||||
.. _device-guides:
|
||||
|
||||
======================
|
||||
Device-Specific Guides
|
||||
Device-Specific Guides - ***NEED TO CHECK ALL LINKS AS THEY ARE NOT REFS (IN ORDER TO OPEN EXTERNALLY)***
|
||||
======================
|
||||
|
||||
An overview of EmbassyOS general capabilities.
|
||||
Guides to get connected with or improve your Embassy by device-type.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
@@ -9,10 +9,10 @@ User Manual
|
||||
:hidden:
|
||||
|
||||
getting-started/index
|
||||
walkthrough/index
|
||||
configuration/index
|
||||
troubleshooting/index
|
||||
tuning/index
|
||||
walkthrough/index
|
||||
services/index
|
||||
|
||||
.. panel-box::
|
||||
@@ -20,11 +20,13 @@ 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 <initial-setup>`. In the :ref:`User Manual <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 <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 <dev-docs>`. Please don't hestitate to `Contact Us <https://start9.com/contact>`_ 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 said, there are many use-cases and utilities that can be added and tweaked at your convenience, which are covered extensively in this manual. You can get started right away with :ref:`Initial Setup <initial-setup>`, head to our :doc:`Walkthrough <walkthrough/index>` for a guided tour, or learn about :doc:`Services <services/index>` and how to use them. In the :doc:`Configuration <configuration/index>` and :doc:`Tuning <tuning/index>` chapters, you can put your Embassy to work, and make it unique. Finally, you can cure common hiccups with :doc:`Troubleshooting <troubleshooting/index>`.
|
||||
|
||||
For further information, check out :ref:`Knowledge Base <knowledge-base>` to learn about the technologies behind Embassy, including Frequently Asked Questions. When you're ready to build, please check out our :ref:`Developer Docs <dev-docs>`. Please don't hestitate to :ref:`Contact Us <contact>` if you have any issues, questions, or suggestions.
|
||||
|
||||
* :doc:`Getting Started <getting-started/index>` - Initial setup and device-specific guides to connect with your Embassy.
|
||||
* :doc:`Configuration Options <configuration/index>` - Configuration your Embassy.
|
||||
* :doc:`Troubleshooting <troubleshooting/index>` - Resolve any common issues you may encounter.
|
||||
* :doc:`Tuning <tuning/index>` - Customize your Embassy with advanced configuration and external service integrations.
|
||||
* :doc:`Services <services/index>` - Overview of featured Services and general usage on EmbassyOS.
|
||||
* :doc:`Walkthrough <walkthrough/index>` - A guided tour of EmbassyOS.
|
||||
* :doc:`Services <services/index>` - Overview of featured Services and general usage on EmbassyOS.
|
||||
* :doc:`Configuration Options <configuration/index>` - Configuration your Embassy.
|
||||
* :doc:`Tuning <tuning/index>` - Customize your Embassy with advanced configuration and external service integrations.
|
||||
* :doc:`Troubleshooting <troubleshooting/index>` - Resolve any common issues you may encounter.
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
.. _diy:
|
||||
|
||||
=========
|
||||
DIY Guide - ***UPDATE BUILD GUIDE LINK***
|
||||
DIY Guide - ***CHECK BUILD GUIDE LINK WHEN ON MASTER, ADD PHOTOS OF HARDWARE SETUP***
|
||||
=========
|
||||
|
||||
.. figure:: /_static/images/diy/pi.png
|
||||
@@ -44,8 +44,8 @@ Hardware: Components
|
||||
|
||||
`*` 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 Instructions
|
||||
...............................
|
||||
Hardware: Assembly
|
||||
..................
|
||||
|
||||
#. Insert mini speaker/buzzer into GPIO pins 6/8/10/12 with the word "speaker" facing out, `away from the board`.
|
||||
|
||||
@@ -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 - https://github.com/Start9Labs/embassy-os/tree/integration/0.3.0/build***
|
||||
If you prefer to build EmbassyOS from source, you can do so following our guide `here <https://github.com/Start9Labs/embassy-os/tree/master/build>`_.
|
||||
|
||||
Installing EmbassyOS
|
||||
--------------------
|
||||
|
||||
@@ -42,6 +42,15 @@ Electrum
|
||||
FullyNoded
|
||||
----------
|
||||
|
||||
.. note:: Mac only
|
||||
|
||||
.. _samourai:
|
||||
|
||||
Samourai
|
||||
--------
|
||||
|
||||
.. note:: Android only
|
||||
|
||||
.. _sparrow:
|
||||
|
||||
Sparrow
|
||||
@@ -54,10 +63,14 @@ Specter
|
||||
|
||||
.. _trezor:
|
||||
|
||||
Trezor
|
||||
------
|
||||
Trezor Suite
|
||||
------------
|
||||
|
||||
.. note:: Built for use with Trezor hardware devices
|
||||
|
||||
.. _ledger:
|
||||
|
||||
Ledger Live
|
||||
-----------
|
||||
-----------
|
||||
|
||||
.. note:: Built for use with Ledger hardware devices
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
.. _service-guides:
|
||||
|
||||
=======================
|
||||
Service-Specific Guides
|
||||
=======================
|
||||
|
||||
@@ -29,4 +29,4 @@ Enable Auto Check for Updates
|
||||
Manually Checking Updates
|
||||
-------------------------
|
||||
|
||||
If you choose not to enable automatic updates, service updates will appear in the `Updates` tab of the Marketplace when ready.
|
||||
If you choose not to enable automatic update checks, service updates will still appear in the ``Updates`` tab of the Marketplace when ready.
|
||||
|
||||
Reference in New Issue
Block a user