mirror of
https://github.com/Start9Labs/documentation.git
synced 2026-03-26 02:11:55 +00:00
About, Contribute, concepts, other edits
This commit is contained in:
kn0wmad
@@ -1,3 +1,11 @@
|
||||
- Jobs
|
||||
- Update principles, privacy, about, etc
|
||||
- Footer links need update or removal?
|
||||
- Lots of screenshots and details
|
||||
- Left sidebar empty, figure out how that is populated
|
||||
- Warrant canary
|
||||
- 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)
|
||||
|
||||
# User Manual
|
||||
- Getting Started
|
||||
- Introduction
|
||||
|
||||
@@ -20,6 +20,9 @@ Telegram
|
||||
|
||||
https://t.me/start9_labs
|
||||
|
||||
Social Media
|
||||
------------
|
||||
|
||||
Mastodon
|
||||
========
|
||||
|
||||
@@ -30,6 +33,11 @@ Twitter
|
||||
|
||||
https://twitter.com/start9labs
|
||||
|
||||
GitHub
|
||||
======
|
||||
|
||||
https://github.com/start9labs
|
||||
|
||||
Email
|
||||
-----
|
||||
|
||||
|
||||
@@ -4,7 +4,8 @@
|
||||
Start9 Software License
|
||||
=======================
|
||||
|
||||
# START9 PERSONAL USE LICENSE v1.0
|
||||
START9 PERSONAL USE LICENSE v1.0
|
||||
--------------------------------
|
||||
|
||||
This license governs the use of the accompanying Software. If you use the Software, you accept this license. If you do not accept the license, do not use the Software.
|
||||
|
||||
@@ -29,3 +30,5 @@ This license governs the use of the accompanying Software. If you use the Softwa
|
||||
4. **Contributions.** You hereby grant to Licensor a perpetual, irrevocable, worldwide, non-exclusive, royalty-free license to use and exploit any modifications or derivative works based on the Source Code of which you are the author.
|
||||
|
||||
5. **Disclaimer.** THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. LICENSOR HAS NO OBLIGATION TO SUPPORT RECIPIENTS OF THE SOFTWARE.
|
||||
|
||||
.. note:: Last updated Dec 17, 2020, please see `Github <https://github.com/Start9Labs/embassy-os/blob/master/LICENSE.md>`_ for latest edits
|
||||
|
||||
@@ -22,4 +22,4 @@ Online Purchases
|
||||
|
||||
When you purchase Products from our website, we necessarily collect certain personal information, such as name, email, shipping address, and payment details, in order to facilitate the transaction and conduct shipment. We do not use the information for any other purpose. Start9 relies on third party payment processors and shipping partners to conduct transactions, and have no control over their collection or usage of your information.
|
||||
|
||||
This Privacy Policy was last updated on July 28, 2020
|
||||
.. note:: This Privacy Policy was last updated on July 28, 2020
|
||||
|
||||
@@ -1,5 +1,10 @@
|
||||
<h2 style="font-size: calc(1.5vw + 16px);">Decentralize</h2>
|
||||
<p>EmbassyOS allows users to swap Marketplaces in case they want a service not offered in the official Start9 Marketplace.</p>
|
||||
<ul>
|
||||
<li>In order to change to an unofficial Marketplace, you can see our documentaion here</li>
|
||||
<li>If you'd like to run your own Marketplace, and help decentralize the ecosystem, please see our guide here</li>
|
||||
.. _decentralize:
|
||||
|
||||
============
|
||||
Decentralize - **ALT MARKET GUIDE NEEDS WRITTEN**
|
||||
============
|
||||
|
||||
EmbassyOS allows users to swap to an alternative Marketplace in case they want a service not offered in the official `Start9 Marketplace <https://marketplace.start9.com>`_, would like a backup registry, or have for some reason lost trust in :ref:`Start9 <start9>`.
|
||||
|
||||
- In order to change to an unofficial Marketplace, you can see our documentaion :ref:`here <alt-marketplace>`.
|
||||
- If you'd like to run your own Marketplace, and help decentralize the ecosystem, please see our guide `here <https://github.com/Start9Labs/registry>`_.
|
||||
|
||||
@@ -1,6 +1,11 @@
|
||||
<h2 style="font-size: calc(1.5vw + 16px);">Promote</h2>
|
||||
<p>If you have an audience of any kind, you could qualify for Start9's affiliate program.</p>
|
||||
<ul>
|
||||
<li>Get a unique affilitate code to pass along to your audience</li>
|
||||
<li>A discount for your audience, and a kickback for you, if you choose</li>
|
||||
<li>Email us at <a href="mailto:affiliate@start9labs.com">affiliate@start9labs.com</a> for more information</li>
|
||||
.. _promote:
|
||||
|
||||
=======
|
||||
Promote
|
||||
=======
|
||||
|
||||
If you have an audience of any kind, you could qualify for Start9's affiliate program.
|
||||
|
||||
- Get a unique affilitate code to pass along to your audience.
|
||||
- A discount for your audience, and a kickback for you, if you choose.
|
||||
- Email us at affiliate@start9labs.com for more information.
|
||||
|
||||
@@ -1,6 +1,11 @@
|
||||
<h2 style="font-size: calc(1.5vw + 16px);">Provide Support</h2>
|
||||
<p>We aim to offer world-class support, but we need all the help we can get!</p>
|
||||
<ul>
|
||||
<li>If you see a question in one of our Community Channels that has not been answered yet, answer it! We ask that you please be certain that you know the correct answer</li>
|
||||
<li>Participate in our Github <a href="https://github.com/Start9Labs/embassy-os/discussions">Discussions</a> channel</li>
|
||||
<li>If you would like to take on a more significant role in Support, please reach out to us at <a href="mailto:support@start9labs.com">support@start9labs.com</a>, or in our Community Channels</li>
|
||||
.. _provide-support:
|
||||
|
||||
===============
|
||||
Provide Support
|
||||
===============
|
||||
|
||||
We aim to offer world-class support, but we need all the help we can get!
|
||||
|
||||
- If you see a question in one of our :ref:`Community Channels <contact>` that has not been answered yet, answer it! We ask that you please be certain that you know the correct answer. You can always verify with a team member first or direct the inquirer to the relevant section of these docs.
|
||||
- Participate in our `Github Discussions <https://github.com/Start9Labs/embassy-os/discussions>`_ channel.
|
||||
- If you would like to take on a more significant role in Support, please reach out to us at support@start9labs.com, or in one of our :ref:`Community Channels <contact>`.
|
||||
|
||||
@@ -1,6 +1,11 @@
|
||||
<h2 style="font-size: calc(1.5vw + 16px);">Educate</h2>
|
||||
<p>One of the most important things an individual can do is to get the word out about sovereign computing and help teach others how to declare their own independence.</p>
|
||||
<ul>
|
||||
<li>Write blog posts on Medium, Substack, Reddit, etc.</li>
|
||||
<li>Contribute to our <a href="https://github.com/Start9Labs/documentation">Documentation</a>, whether you find a typo, have an FAQ to add, or tutorial to improve</li>
|
||||
<li>Create videos - how-tos, comparisons, unboxings, and reviews are all helpful</li>
|
||||
.. _teach:
|
||||
|
||||
=====
|
||||
Teach
|
||||
=====
|
||||
|
||||
One of the most important things an individual can do to help the movement is to get the word out about sovereign computing and help others learn how to declare their own independence.
|
||||
|
||||
- Write reviews or blog posts on Medium, Substack, Reddit, Mastodon, Twitter, etc.
|
||||
- Contribute to our `Documentation <https://github.com/Start9Labs/documentation">`_, whether you find a typo, have an FAQ to add, or tutorial to improve. You can also find a link to submit a fix or report an issue near the top of this page (labeled ``Contribute``).
|
||||
- Create videos - how-tos, comparisons, unboxings, and reviews are all helpful.
|
||||
|
||||
@@ -100,7 +100,7 @@
|
||||
:class: large-3
|
||||
:anchor: Learn more
|
||||
|
||||
Explore Start9's mission, history and future
|
||||
Explore Start9's mission, history, and future
|
||||
|
||||
.. raw:: html
|
||||
|
||||
@@ -118,3 +118,4 @@
|
||||
user-manual/index
|
||||
knowledge-base/index
|
||||
dev-docs/index
|
||||
|
||||
|
||||
@@ -33,3 +33,9 @@ The first and foremost use of the Product Key is to encrypt data that is sent to
|
||||
Services
|
||||
--------
|
||||
The server-side software available on EmbassyOS are referred to as "Services." It's important to distinguish the difference between *services* and *applications*. Applications are generally *client-side*. This means that they are either standalone software, or they reach out to a server in order to operate. Services are *server-side*. These generally run 24/7, waiting for commands from a user via an application.
|
||||
|
||||
.. _webui:
|
||||
|
||||
Web User Interface (UI)
|
||||
-----------------------
|
||||
A User Interface, or UI, is as the name suggests, the way in which the user interacts with some software, typically in our context it will be a graphical interface (GUI). A WebUI is basically a website that is served (often by your Embassy) specifically for a user to issue commands or view data. A great example of this is EmbassyOS itself, which serves a WebUI for the user to add/remove services, make configurations, etc. This is your main point of contact with EOS.
|
||||
|
||||
@@ -25,7 +25,7 @@
|
||||
|
||||
.. topic-box::
|
||||
:title: Concepts
|
||||
:link: concepts/index
|
||||
:link: concepts
|
||||
:icon: scylla-icon scylla-icon--knowledge-base
|
||||
:class: large-4
|
||||
:anchor: Learn
|
||||
@@ -34,7 +34,7 @@
|
||||
|
||||
.. topic-box::
|
||||
:title: FAQ
|
||||
:link: faq/index
|
||||
:link: ../support/faq
|
||||
:icon: scylla-icon scylla-icon--monitoring
|
||||
:class: large-4
|
||||
:anchor: Get Answers
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
.. _faq-contributing:
|
||||
|
||||
============
|
||||
Contributing
|
||||
Contributing - **EXPAND**
|
||||
============
|
||||
|
||||
We ❤️ contributions!
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
:local:
|
||||
|
||||
=====================
|
||||
Service Packaging FAQ
|
||||
Service Packaging FAQ - **EXPAND**
|
||||
=====================
|
||||
|
||||
Do I need programming experience to package a service for EmbassyOS?
|
||||
|
||||
@@ -25,7 +25,7 @@
|
||||
|
||||
.. topic-box::
|
||||
:title: User Manual
|
||||
:link: user-manual/index
|
||||
:link: user-manual
|
||||
:icon: scylla-icon scylla-icon--knowledge-base
|
||||
:class: large-4
|
||||
:anchor: View
|
||||
@@ -34,16 +34,16 @@
|
||||
|
||||
.. topic-box::
|
||||
:title: FAQ
|
||||
:link: faq/index
|
||||
:link: faq
|
||||
:icon: scylla-icon scylla-icon--monitoring
|
||||
:class: large-4
|
||||
:anchor: Get Answers
|
||||
|
||||
Answers to Frequently Asked Questions from Embassy users.
|
||||
Answers to Frequently Asked Questions from Embassy users
|
||||
|
||||
.. topic-box::
|
||||
:title: Developer Documentation
|
||||
:link: dev-docs/index
|
||||
:link: dev-docs
|
||||
:icon: scylla-icon scylla-icon--open-source
|
||||
:class: large-4
|
||||
:anchor: Build
|
||||
@@ -52,7 +52,7 @@
|
||||
|
||||
.. topic-box::
|
||||
:title: Community Channels
|
||||
:link: dev-docs/index
|
||||
:link: ../about/contact
|
||||
:icon: scylla-icon scylla-icon--networking
|
||||
:class: large-4
|
||||
:anchor: Join us
|
||||
@@ -75,3 +75,4 @@
|
||||
user-manual/index
|
||||
faq/index
|
||||
dev-docs/index
|
||||
|
||||
|
||||
@@ -4,31 +4,6 @@
|
||||
Basic Configuration - ***NEEDS BUG REPORT LINK***
|
||||
===================
|
||||
|
||||
.. _device-name:
|
||||
|
||||
Set Device Name
|
||||
---------------
|
||||
|
||||
Here you can change the name of your Embassy!
|
||||
|
||||
1. Go to the ``Embassy`` tab on the main menu on the left side of the UI
|
||||
|
||||
.. figure:: /_static/images/config/basic-config0.png
|
||||
:width: 60%
|
||||
:alt: Embassy Tab
|
||||
|
||||
2. Under the ``Settings`` section, click ``Preferences``
|
||||
|
||||
.. figure:: /_static/images/config/basic-config1.png
|
||||
:width: 60%
|
||||
:alt: Preferences
|
||||
|
||||
3. Then click ``Device Name``, set to desired name, and click ``Save``
|
||||
|
||||
.. figure:: /_static/images/config/basic-config2.png
|
||||
:width: 60%
|
||||
:alt: Rename Embassy
|
||||
|
||||
.. _auto-reporting:
|
||||
|
||||
Automatically Report Bugs
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
Configuration
|
||||
=============
|
||||
|
||||
Configuration, setup guides, and known limitations are provided here by device
|
||||
Configuration, setup guides, and known limitations are provided here by device.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
@@ -4,4 +4,4 @@
|
||||
Mac Known Limitations
|
||||
=====================
|
||||
|
||||
MacOS has no known limitations in regard to Embassy.
|
||||
MacOS has no known limitations in regard to Embassy at this time.
|
||||
|
||||
@@ -3,3 +3,7 @@
|
||||
=========================
|
||||
Windows Known Limitations
|
||||
=========================
|
||||
|
||||
Windows10 has no known limitations in regard to Embassy at this time.
|
||||
|
||||
No testing has been done with other versions, such as Windows 7 or 11.
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
Android - ***NEEDS UPDATED***
|
||||
=======
|
||||
|
||||
.. warning::
|
||||
.. caution::
|
||||
This guide assumes you have completed :ref:`setting up Tor for Android<tor-android>`. Please visit this section before proceeding as it is required for Firefox to properly work with Tor.
|
||||
|
||||
Once Tor is setup on your system, you can proceed to setup Firefox:
|
||||
|
||||
@@ -1,17 +1,9 @@
|
||||
.. _torff-ios:
|
||||
|
||||
===
|
||||
iOS -***NEEDS UPDATED***
|
||||
iOS
|
||||
===
|
||||
|
||||
NO TOR FOR YOU
|
||||
|
||||
.. _firefox-tor-ios:
|
||||
|
||||
**********************************
|
||||
Setting up Firefox with Tor on iOS
|
||||
**********************************
|
||||
|
||||
Unfortunately, Apple does not allow tor to be run natively on iOS. This means that Firefox cannot be configured to use tor. This leaves the following options for iOS users:
|
||||
Unfortunately, Apple does not allow tor to be run natively on iOS. This means that Firefox cannot be configured to use tor. This leaves the following options:
|
||||
|
||||
You can use Start9's own Consulate Browser, which is available `here <https://apps.apple.com/us/app/start9-consulate-browser/id1528124570>`_, or you can select another Tor Browser by searching the `App Store <https://www.apple.com/us/search/onion-browser?src=serp>`_.
|
||||
|
||||
@@ -4,8 +4,7 @@
|
||||
Linux - ***NEEDS UPDATED***
|
||||
=====
|
||||
|
||||
|
||||
.. warning::
|
||||
.. caution::
|
||||
This guide assumes you have completed :ref:`setting up Tor<running-tor>`. Please visit this section first before you proceed as it is required for Firefox to properly work with Tor.
|
||||
|
||||
1. Open Firefox.
|
||||
|
||||
@@ -1,11 +1,10 @@
|
||||
.. _torff-mac:
|
||||
|
||||
===
|
||||
Mac - ***NEEDS UPDATED***
|
||||
Mac
|
||||
===
|
||||
|
||||
|
||||
.. warning::
|
||||
.. caution::
|
||||
This guide assumes you have completed :ref:`setting up Tor<running-tor>`. Please visit this section first before you proceed as it is required for Firefox to properly work with Tor.
|
||||
|
||||
1. Open Firefox.
|
||||
|
||||
@@ -1,96 +1,53 @@
|
||||
.. _torff-windows:
|
||||
|
||||
=======
|
||||
Windows - *** NEEDS UPDATED***
|
||||
Windows
|
||||
=======
|
||||
|
||||
|
||||
.. warning::
|
||||
.. caution::
|
||||
This guide assumes you have completed :ref:`setting up Tor<running-tor>`. Please visit this section first before you proceed as it is required for Firefox to properly work with Tor.
|
||||
|
||||
1. Open Firefox.
|
||||
#. Open Firefox and enter ``about:config`` in the URL bar. Accept any warnings that may appear about accessing advanced settings.
|
||||
|
||||
2. 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``.
|
||||
|
||||
3. Search for ``dom.securecontext.whitelist_onions`` and set the value to ``true``.
|
||||
.. figure:: /_static/images/tor/firefox_whitelist.png
|
||||
:width: 80%
|
||||
:alt: Firefox whitelist onions screenshot
|
||||
|
||||
.. figure:: /_static/images/tor/firefox_whitelist.png
|
||||
:width: 80%
|
||||
:alt: Firefox whitelist onions screenshot
|
||||
#. Download a `Proxy Auto Config` file to inform Firefox how to use the Tor daemon running on your computer. You can get Start9's standard file by following instructions below:
|
||||
|
||||
4. Download a `Proxy Auto Config` file to inform Firefox how to use the Tor daemon running on your computer. You can get Start9's standard file by following the OS-specific instructions below:
|
||||
Windows:
|
||||
|
||||
Click `here <https://registry.start9labs.com/sys/proxy.pac>`_ to get the file and save the file somewhere you won’t delete it. Please remember the location you save the file in if you do not use our example location. For this example:
|
||||
- Click `here <https://registry.start9labs.com/sys/proxy.pac>`_ to get the file and save the file somewhere you won’t delete it. Please remember the location you save the file in if you do not use our example location. For this example:
|
||||
|
||||
.. code-block::
|
||||
|
||||
C:\Program Files\Tor Browser\proxy.pac
|
||||
|
||||
Mac:
|
||||
#. Now open your Firefox web browser, and select ``Settings -> Options``:
|
||||
|
||||
Open the ``Terminal`` App on your Mac. You can find it in your list of Applications. In the terminal, enter:
|
||||
|
||||
.. code-block::
|
||||
|
||||
brew install wget
|
||||
|
||||
And then:
|
||||
|
||||
.. code-block::
|
||||
|
||||
wget -P /usr/local/etc/tor https://registry.start9labs.com/sys/proxy.pac
|
||||
|
||||
Linux:
|
||||
|
||||
From a terminal, enter:
|
||||
|
||||
.. code-block::
|
||||
|
||||
sudo wget -P /etc/tor https://registry.start9labs.com/sys/proxy.pac
|
||||
.. figure:: /_static/images/tor/firefox_options_windows.png
|
||||
:width: 80%
|
||||
:alt: Firefox options screenshot
|
||||
|
||||
|
||||
5. Now open your Firefox web browser, and select options (Windows), or preferences (Mac/Linux):
|
||||
#. 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_options_windows.png
|
||||
:width: 80%
|
||||
:alt: Firefox options screenshot
|
||||
.. figure:: /_static/images/tor/firefox_search.png
|
||||
:width: 80%
|
||||
:alt: Firefox search screenshot
|
||||
|
||||
Select :menuselection:``Settings --> Options``
|
||||
|
||||
|
||||
6. 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.png
|
||||
:width: 80%
|
||||
:alt: Firefox search screenshot
|
||||
|
||||
7. This should open a menu that will allow you to configure your proxy settings. Select ``Automatic proxy configuration URL`` and paste in the path to your PAC file from earlier, prefixed with ``file://``. For example:
|
||||
Windows:
|
||||
#. This should open a menu that will allow you to configure your proxy settings. Select ``Automatic proxy configuration URL`` and paste in the path to your PAC file from earlier, prefixed with ``file://``. For example:
|
||||
|
||||
.. code-block::
|
||||
|
||||
file://C:/Program Files/Tor Browser/proxy.pac
|
||||
|
||||
Mac:
|
||||
#. Then, check the box labeled ``Proxy DNS when using SOCKS v5``:
|
||||
|
||||
.. code-block::
|
||||
.. figure:: /_static/images/tor/firefox_proxy.png
|
||||
:width: 80%
|
||||
:alt: Firefox proxy settings screenshot
|
||||
|
||||
file:///usr/local/etc/tor/proxy.pac
|
||||
|
||||
Linux:
|
||||
|
||||
.. code-block::
|
||||
|
||||
file:///etc/tor/proxy.pac
|
||||
|
||||
8. Then, check the box labeled ``Proxy DNS when using SOCKS v5``:
|
||||
|
||||
.. figure:: /_static/images/tor/firefox_proxy.png
|
||||
:width: 80%
|
||||
:alt: Firefox proxy settings screenshot
|
||||
|
||||
9. Click ``OK`` and then restart Firefox for the changes to take effect.
|
||||
|
||||
10. You’re all set! You should now be able to navigate to ``.onion`` URLs in Firefox. This means you can bookmark Cups Messenger, and use your Bitwarden Tor address in the `Bitwarden Firefox Plugin <https://addons.mozilla.org/en-US/firefox/addon/bitwarden-password-manager/>`_.
|
||||
#. Click ``OK`` and then restart Firefox for the changes to take effect.
|
||||
|
||||
#. You're all set! You should now be able to navigate to ``.onion`` URLs in Firefox. You can test by going to Start9's ``.onion`` homepage, `here <http://privacy34kn4ez3y3nijweec6w4g54i3g54sdv7r5mr6soma3w4begyd.onion/>`_. This means you can access tor-only service :ref:`WebUIs <webui>`, such as Cups Messenger, and use your Bitwarden Tor address in the `Bitwarden Firefox Plugin <https://addons.mozilla.org/en-US/firefox/addon/bitwarden-password-manager/>`_.
|
||||
|
||||
@@ -29,8 +29,8 @@ Install the Tor proxy service to your system. To do so, open your terminal and r
|
||||
|
||||
sudo systemctl restart tor
|
||||
|
||||
Arch
|
||||
----
|
||||
Arch / Manjaro
|
||||
--------------
|
||||
|
||||
Simply install Tor with:
|
||||
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
.. _wifi:
|
||||
|
||||
===============
|
||||
Setting up WiFi - ***VERIFY CONNECTION BEHAVIOR***
|
||||
Setting up WiFi - ***VERIFY CONNECTION BEHAVIOR and UPDATE FINAL SCREEN***
|
||||
===============
|
||||
|
||||
You can connect your Embassy with a wireless connection if you prefer. Follow the directions below to connect to a WiFi network, or save your credentials for later to connect to a network you are not currently in proximity to.
|
||||
|
||||
@@ -1,15 +1,27 @@
|
||||
.. _recover:
|
||||
|
||||
===============
|
||||
Recover Embassy
|
||||
===============
|
||||
=========================
|
||||
Recover / Migrate Embassy
|
||||
=========================
|
||||
|
||||
.. _recover-02x:
|
||||
|
||||
Recover Embassy from version series 0.2.x
|
||||
-----------------------------------------
|
||||
Migrate Embassy Series 0.2.x Data
|
||||
---------------------------------
|
||||
|
||||
Additional Hardware
|
||||
...................
|
||||
|
||||
Instructions
|
||||
............
|
||||
|
||||
.. _recover-03x:
|
||||
|
||||
Recover Embassy from Version Series 0.3.x
|
||||
-----------------------------------------
|
||||
Migrate Embassy Series 0.3.x Data
|
||||
---------------------------------
|
||||
|
||||
Recover From Remote Backup
|
||||
..........................
|
||||
|
||||
Recover From Local (External Drive) Backup
|
||||
..........................................
|
||||
|
||||
@@ -27,6 +27,6 @@ User Manual
|
||||
* :doc:`Getting Started <getting-started/index>` - Initial setup and device-specific guides to connect with your Embassy.
|
||||
* :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:`Configuration <configuration/index>` - Configure your Embassy to your preference.
|
||||
* :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 @@
|
||||
.. _managing-services:
|
||||
|
||||
=================
|
||||
Managing Services
|
||||
Managing Services - *** UPDATE SCREENS ***
|
||||
=================
|
||||
|
||||
.. _managing-dependencies:
|
||||
|
||||
@@ -4,7 +4,12 @@
|
||||
Marketplace
|
||||
===========
|
||||
|
||||
LINK TO MARKETPLACE
|
||||
FIND A PLACE TO LINK S9 ALTWEB SERVICE MOST WANTED LIST
|
||||
Embassy Marketplace
|
||||
-------------------
|
||||
|
||||
ROADMAP NEEDS A HOME
|
||||
LINK TO MARKETPLACE
|
||||
|
||||
Community Wishlist
|
||||
------------------
|
||||
|
||||
`Embassy: Voice <https://s9.altweb.me/>`_ unofficial feedback forum.
|
||||
|
||||
@@ -1,8 +1,12 @@
|
||||
.. _alt-marketplace:
|
||||
|
||||
=======================
|
||||
Alternative Marketplace
|
||||
=======================
|
||||
|
||||
.. caution:: EmbassyOS supports accessing alternative marketplaces. Start9 is not responsible for issues encountered when downloading services from alternative marketplaces, and cannot provide support for Services that are not from our offical marketplace. Here be dragons!!
|
||||
EmbassyOS supports accessing alternative marketplaces.
|
||||
|
||||
.. caution:: Start9 is not responsible for issues encountered when downloading services from alternative marketplaces, and cannot provide support for services that are not from our offical marketplace. Here be dragons!!
|
||||
|
||||
After SSH-ing into the Embassy, run the following command, replacing ``<url>`` with your desired marketplace URL:
|
||||
|
||||
|
||||
@@ -6,12 +6,12 @@ SSH Setup
|
||||
|
||||
.. warning:: This is an advanced feature and should be used with caution. Start9 is not responsible for any damage you might cause through SSH access.
|
||||
|
||||
Connecting via CLI
|
||||
------------------
|
||||
Connecting via CLI (Linux / Mac)
|
||||
--------------------------------
|
||||
|
||||
#. Navigate to the ``Embassy`` tab, then under ``Settings``, click ``SSH``
|
||||
#. Click the ``+ Add New Key`` button
|
||||
#. Paste in your SSH key and hit ``Submit``
|
||||
#. Paste in your SSH public key and hit ``Submit``
|
||||
#. You can now access your Embassy from the command line (Linux and Mac) using:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
@@ -1,13 +1,33 @@
|
||||
.. _tune-embassy-os:
|
||||
|
||||
=====================
|
||||
Customizing EmbassyOS
|
||||
Customizing EmbassyOS - *** NEEDS SCREENS FOR REORDER ***
|
||||
=====================
|
||||
|
||||
Rename Device
|
||||
-------------
|
||||
.. _device-name:
|
||||
|
||||
Duplicate in walkthrough, probably move to here
|
||||
Set Device Name
|
||||
---------------
|
||||
|
||||
Here you can change the name of your Embassy!
|
||||
|
||||
1. Go to the ``Embassy`` tab on the main menu on the left side of the UI
|
||||
|
||||
.. figure:: /_static/images/config/basic-config0.png
|
||||
:width: 60%
|
||||
:alt: Embassy Tab
|
||||
|
||||
2. Under the ``Settings`` section, click ``Preferences``
|
||||
|
||||
.. figure:: /_static/images/config/basic-config1.png
|
||||
:width: 60%
|
||||
:alt: Preferences
|
||||
|
||||
3. Then click ``Device Name``, set to desired name, and click ``Save``
|
||||
|
||||
.. figure:: /_static/images/config/basic-config2.png
|
||||
:width: 60%
|
||||
:alt: Rename Embassy
|
||||
|
||||
Reorder Service Page
|
||||
--------------------
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
.. _bitcoin:
|
||||
|
||||
=======
|
||||
Bitcoin
|
||||
Bitcoin - **NEED GUIDES WRITTEN (in bitcoind repo?)**
|
||||
=======
|
||||
|
||||
Here you will find guides on how to connect different kinds of Bitcoin wallets (hardware and software) to your Embassy node, to complete your sovereign Bitcoin stack!
|
||||
@@ -37,6 +37,8 @@ and then enter ``bitcoin-cli`` commands. When you are finished, simply type ``e
|
||||
Electrum
|
||||
--------
|
||||
|
||||
**UNTESTED**
|
||||
|
||||
.. _fully-noded:
|
||||
|
||||
FullyNoded
|
||||
@@ -44,6 +46,8 @@ FullyNoded
|
||||
|
||||
.. note:: Mac only
|
||||
|
||||
**UNTESTED**
|
||||
|
||||
.. _samourai:
|
||||
|
||||
Samourai
|
||||
@@ -51,26 +55,38 @@ Samourai
|
||||
|
||||
.. note:: Android only
|
||||
|
||||
**UNTESTED**
|
||||
|
||||
.. _sparrow:
|
||||
|
||||
Sparrow
|
||||
-------
|
||||
|
||||
**UNTESTED**
|
||||
|
||||
.. _specter:
|
||||
|
||||
Specter
|
||||
-------
|
||||
|
||||
Current - https://github.com/Start9Labs/bitcoind-wrapper/tree/master/docs/integrations/specter
|
||||
|
||||
**UNTESTED**
|
||||
|
||||
.. _trezor:
|
||||
|
||||
Trezor Suite
|
||||
------------
|
||||
|
||||
.. note:: Built for use with Trezor hardware devices
|
||||
.. tip:: Built for use with Trezor hardware devices
|
||||
|
||||
**UNTESTED**
|
||||
|
||||
.. _ledger:
|
||||
|
||||
Ledger Live
|
||||
-----------
|
||||
|
||||
.. note:: Built for use with Ledger hardware devices
|
||||
.. tip:: Built for use with Ledger hardware devices
|
||||
|
||||
**UNTESTED**
|
||||
|
||||
@@ -1,14 +1,21 @@
|
||||
.. _lightning:
|
||||
|
||||
=========
|
||||
Lightning
|
||||
Lightning - **NEED GUIDES WRITTEN (in lnd/c-lightning repos?)**
|
||||
=========
|
||||
|
||||
|
||||
Check out our `Getting Started with Lightning video <https://www.youtube.com/watch?v=KhU_sTiaN8w>`_ for an introduction to the Lightning Network using LND and RTL on Embassy!
|
||||
|
||||
.. youtube:: KhU_sTiaN8w
|
||||
|
||||
.. _rtl:
|
||||
|
||||
Ride the Lightning
|
||||
------------------
|
||||
|
||||
See the video at the top of this page for an intro to Lightning using RTL.
|
||||
|
||||
.. _spark:
|
||||
|
||||
Spark
|
||||
@@ -27,4 +34,7 @@ Zap
|
||||
.. _zeus:
|
||||
|
||||
Zeus
|
||||
----
|
||||
----
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -4,4 +4,11 @@
|
||||
Matrix
|
||||
======
|
||||
|
||||
https://www.youtube.com/watch?v=PtwQsybFapo
|
||||
.. _matrix-setup:
|
||||
|
||||
Guides
|
||||
------
|
||||
|
||||
Check out our `Synapse video <https://www.youtube.com/watch?v=PtwQsybFapo>`_ for features and setup!
|
||||
|
||||
.. youtube:: PtwQsybFapo
|
||||
|
||||
@@ -4,4 +4,11 @@
|
||||
Vaultwarden
|
||||
===========
|
||||
|
||||
https://www.youtube.com/watch?v=YcxxVHpm9j0
|
||||
.. _vaultwarden-setup:
|
||||
|
||||
Guides
|
||||
------
|
||||
|
||||
Check out our `Vaultwarden video <https://www.youtube.com/watch?v=YcxxVHpm9j0>`_ for features and setup!
|
||||
|
||||
.. youtube:: YcxxVHpm9j0
|
||||
|
||||
@@ -13,3 +13,5 @@ An overview of EmbassyOS general capabilities.
|
||||
updates
|
||||
backup/index
|
||||
password
|
||||
|
||||
|
||||
|
||||
@@ -11,7 +11,8 @@ SSH/Linux
|
||||
|
||||
If you already have :ref:`SSH keys registered with your Embassy<ssh-setup>` **OR** you have access to a Linux computer, you can reset your Embassy password without losing any data.
|
||||
|
||||
* SSH:
|
||||
SSH
|
||||
===
|
||||
|
||||
* Use the command line to gain SSH access to your Embassy::
|
||||
|
||||
@@ -39,7 +40,8 @@ If you already have :ref:`SSH keys registered with your Embassy<ssh-setup>` **OR
|
||||
|
||||
.. warning:: Running setup process will generate new certificate and Tor address for your Embassy.
|
||||
|
||||
* Linux computer:
|
||||
Linux
|
||||
=====
|
||||
|
||||
* Shut down your Embassy, disconnect from power, and remove the microSD card.
|
||||
* Insert the microSD card into your Linux computer and mount the drive::
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
Updating
|
||||
========
|
||||
|
||||
Keeping current on Updates ensures a fast and secure system.
|
||||
Keeping current on Updates ensures a secure and performant system.
|
||||
|
||||
.. _update-eos:
|
||||
|
||||
@@ -22,7 +22,7 @@ Enable Auto Check for Updates
|
||||
#. Click "Auto Check for Updates" and click Enable
|
||||
#. If there is an update available, you will be prompted to install it.
|
||||
#. While updating, your Embassy will emit a gentle chime every 20 seconds.
|
||||
#. You can also enable automatic check for updates in the :ref:`Embassy config <auto-update>` tab.
|
||||
#. You can also enable :ref:`automatic update checks<auto-update>` in the ``Embassy`` tab -> Settings -> Preferences.
|
||||
|
||||
.. note:: Ensure you have a stable Internet connection, and do not unplug your Embassy during an update. Updates usually complete within a few minutes, but depending on the size of the update and your Internet bandwidth, they can sometimes take up to an hour.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user