Several updates

This commit is contained in:
kn0wmad
2021-12-10 18:02:31 -07:00
committed by Lucy Cifferello
parent c6bcd20c68
commit adaf0854a0
19 changed files with 450 additions and 150 deletions

View File

@@ -25,3 +25,9 @@ Whether you purchase a device, download an image, or build yourself from source,
If you purchase a device from us, this is printed on the bottom of your Embassy. If you purchase a download, we provide you the key. If you build from source, the key is created during the build.
The first and foremost use of the Product Key is to encrypt data that is sent to Embassy at :ref:`Initial Setup<initial-setup>`. There are several other usecases. Start9 keeps an anonymous database of all Product Keys that have been purchased by us (ZERO additional data is associated) so that we can verify someone is a "paid user." Currently this is just to allow someone to get a new copy of the EOS image if they have a problem, but in future we intend to give added bonuses to customers who have chosen to pay us for a copy of the software.
.. _services:
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.

View File

@@ -1,13 +1,13 @@
.. _networks:
********
========
Networks
********
========
.. _lan:
LAN
===
---
A Local Area Network (LAN) is a computer network that interconnects computers within a limited area such as a residence, school, laboratory, university campus, or office building.
@@ -20,7 +20,7 @@ Your Embassy hosts itself on the LAN and is reachable by visiting its ``embassy.
.. _mdns:
MDNS
====
----
Multicast Domain Name System (MDNS) is a protocol that resolves a human-readable hostname to an IP address on a small network, such as the home or office network you might host your Embassy on.
@@ -31,7 +31,7 @@ This domain is not broadcast outside of your local network, so it is as private
.. _ssl:
SSL
===
---
Visiting websites on the Tor network is slow. We wanted to provide a better option to access the Embassy at home. Thats why we created an address for the Embassy that can be accessed on your Local Area Network.
@@ -51,7 +51,7 @@ For more information on how to setup your devices to enable this feature visit :
.. _tor:
Tor
===
---
The Onion Router, or Tor, is a free and open source software that enables anonymous communication. By routing Internet traffic though a worldwide, volunteer overlay network of nodes, requests are bundled in layers of encryption like the layers of an onion. The request is relayed across nodes, decrypting a layer only to reveal the next relay destination, until the request meets its final destination, without revealing the source IP address.
@@ -63,11 +63,19 @@ Furthermore, every service on the Embassy has a different Tor address, including
Here's an introductory video on `Tor <https://www.youtube.com/watch?v=6czcc1gZ7Ak>`__.
.. _tor-browser:
Tor Browser
-----------
The Tor Browser is a version of Firefox specifically made for use with the Tor Network. Tor Browser has Tor built-in, so that you do not need to be running Tor natively in order to use the network. This makes it a great browser for use with your Embassy.
.. caution:: Tor Browser has some advanced security and privacy settings, which can be useful, but please keep in mind that if you raise them from the standard level, you may be unable to use some websites, such as your Embassy UI.
.. _hidden-service:
Tor Hidden Service
==================
------------------
A Tor Hidden Service is essentially just software or a website that is only broadcast on the Tor network. These are identified by a long, random public key, and end with the ``.onion`` suffix. For example, you can visit http://privacy34kn4ez3y3nijweec6w4g54i3g54sdv7r5mr6soma3w4begyd.onion to view the Start9 homepage on Tor.

View File

@@ -1,10 +1,13 @@
.. _basic-config:
*******************
Basic Configuration
*******************
===================
Basic Configuration - ***NEEDS UPDATE / SCREENS***
===================
Click "Config". Here you can set custom configurations for your Embassy. Currently, you can change the "Device Name" and enable/disable "Auto Check for Updates."
Set Device Name
---------------
Here you can change the name of your Embassy!
.. figure:: /_static/images/embassy_config.png
:width: 90%

View File

@@ -1,8 +1,8 @@
*********
=========
Tor Setup
*********
=========
An overview of EmbassyOS general capabilities.
Setup :ref:`Tor<tor>` to run on your devices, either natively (in the background), or by configuring an application, such as Firefox.
.. toctree::
:maxdepth: 2

View File

@@ -1,5 +1,83 @@
.. _tor-android:
*******
=======
Android
*******
=======
Some apps, such as :ref:`Tor Browser<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
Running Orbot
-------------
Orbot is a system wide proxy for your Android or Graphene device that enables communications over Tor.
1. Download Orbot from the `Play Store <https://play.google.com/store/apps/details?id=org.torproject.android>`_ , or from `F-Droid <https://f-droid.org/packages/org.torproject.android>`_.
2. Launch Orbot.
3. Open the kebab menu in the upper right hand corner and select `Settings`:
.. 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.png
:width: 50%
:alt: Orbot settings
5. Go back, and tap start:
.. 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.png
:width: 50%
:alt: Orbot started
7. That's it. Certain apps, such as Firefox or DuckDuckGo will now just work. Other apps, however, require that Orbot be running VPN mode.
Orbot VPN mode
--------------
To utilize Tor, most apps require that Orbot be running in VPN mode.
1. Disable Private DNS on your device. To do so, navigate to:
``Settings > Network & Internet > Advanced > Private DNS > Off``
.. figure:: /_static/images/tor/private_dns_off.png
:width: 50%
:alt: Private DNS off
Toggle Private DNS to "off"
2. Launch Orbot and toggle VPN Mode on:
.. figure:: /_static/images/tor/orbot_vpn.png
:width: 50%
:alt: Orbot vpn mode
Toggle VPN Mode to "on"
Under `Tor-Enabled Apps`, click the gear icon and add apps you want to utilize Tor.
.. figure:: /_static/images/tor/orbot_apps.png
:width: 50%
:alt: Orbot apps
Examples of applications that need this feature are:
- Bitwarden
- Zeus
You can also add the following browsers to the Tor-Enabled Apps list to easily access Tor addresses (`.onion` URLs):
- Chrome
- Firefox

View File

@@ -1,7 +1,7 @@
.. _tor-ios:
***
===
iOS
***
===
No Tor on iOS. Get a different phone
No Tor for you

View File

@@ -1,5 +1,28 @@
.. _tor-linux:
*****
=====
Linux
*****
=====
Debian / Ubuntu
---------------
For Debian and Debian-based systems, such as Mint, PopOS etc.
#. Install the Tor proxy service to your system. To do so, open your terminal and run the following command:
.. code-block:: bash
sudo apt update && sudo apt install tor
#. That's it! Your Linux machine is now setup to natively use Tor.
Arch
----
Simply install Tor with:
.. code-block:: bash
sudo pacman -S tor

View File

@@ -1,15 +1,98 @@
.. _tor-mac:
***
Mac
***
===
Mac - ***SIMPLIFY M1 INSTRUCTION***
===
.. _tor-new-mac:
For macOS running on ARM chips (ie. newer macs):
================================================
Newer Mac (M1)
==============
Install Homebrew
----------------
.. _tor-old-mac:
.. warning:: macOS Homebrew running natively on M1/Apple Silicon/ARM has partial functionality. Therefore, some additional steps are needed to setup Homebrew.
Older Mac
=========
#. Open a command line editor (Terminal), and run the following commands:
.. code-block::
softwareupdate --install-rosetta
arch -x86_64 /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)"
Install Tor
-----------
.. warning:: If you have the Tor Browser open, close it and quit the application.
#. In the command line, install Tor:
.. code-block::
arch -x86_64 brew install tor
#. Then start Tor:
.. code-block::
arch -x86_64 brew services start tor
This will start Tor and ensure that it is always running, even after a restart. See the `Tor Project <https://2019.www.torproject.org/docs/tor-doc-osx.html.en>`_ for more details.
For macOS Big Sur/Catalina:
===========================
Install Homebrew
----------------
1. If you do not have Homebrew installed, follow the installation instructions `here <https://brew.sh/>`_.
TLDR: Open the command line editor (Terminal) and paste the following line:
.. code-block::
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)"
2. You will be prompted for your system password before installation; proceed with entering your password:
.. figure:: /_static/images/tor/install_homebrew.png
:width: 80%
:alt: Homebrew installation
Enter your password
3. You will be notified which directories Homebrew is going to create, hit :code:`RETURN`:
.. figure:: /_static/images/tor/install_homebrew1.png
:width: 80%
:alt: Homebrew installation
Homebrew creates the directories and downloads any other files it needs e.g. “Command Line Tool for Xcode” and “Homebrew”.
Wait a few minutes while it downloads and installs what it needs.
.. warning:: Surprisingly, Homebrew uses Google Analytics to collect anonymous usage data. You can deselect the option to share usage data by `opting out <https://docs.brew.sh/Analytics#opting-out>`_.
Install Tor
-----------
.. warning:: If you have the Tor Browser open, close it and quit the application.
#. In the command line, install Tor:
.. code-block::
brew install tor
Once it is finished you have the following options:
.. figure:: /_static/images/tor/install_tor.png
:width: 80%
:alt: Tor installation
#. Then run Tor with:
.. code-block::
brew services start tor
This will start Tor and ensure that it is always running, even after a restart. See the `Tor Project <https://2019.www.torproject.org/docs/tor-doc-osx.html.en>`_ for more details.

View File

@@ -1,5 +1,62 @@
.. _tor-windows:
*******
=======
Windows
*******
=======
#. Unfortunately, `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.png
:width: 80%
:alt: Tor download
Download Tor for Windows
#. Once it is downloaded, go ahead and run the installer. If you want to install the program outside of your user directory, you will have to right click and select `Run as Administrator`.
#. Once you have selected a language, you should see a menu like this:
.. figure:: /_static/images/tor/tor_windows_install.png
:width: 80%
:alt: Tor install wizard
Note Tor destination folder when installing
#. It does not matter where you set the destination folder; however, you need to make note of it for later. Go ahead and finish the installation.
#. Now you want to set up Tor to run as a service: to run in the background and keep itself running so you dont have to worry about it again. To do so, you need to open your Command Prompt as an administrator.
* In Windows 10, you can simply type ``cmd`` in the Windows search bar, right click on the first result, and select `Run as Administrator`.
#. Once it opens, you can run the following commands, inserting your destination folder (from above) in place of ``<PATH TO>``:
.. code-block::
sc create tor start= auto binPath= "<PATH TO>\Browser\TorBrowser\Tor\tor.exe -nt-service"
.. code-block::
sc start tor
.. tip:: If you get the error "Access denied," please ensure you are running the command prompt in Administrator mode. You can tell because the prompt will show C:\\Users\\YOUR-USERNAME> if you are NOT in admin mode, and it will show C:\\WINDOWS\\system32 if you ARE in admin mode.
.. note:: If you get the error "The specified service already exists," complete the following steps:
1. Run the command:
.. code-block::
sc delete tor
1. Uninstall the Tor Browser, following `these steps <https://tb-manual.torproject.org/uninstalling/>`_.
2. Begin this guide again from the beginning.
#. When you run this, it should look something like this:
.. figure:: /_static/images/tor/tor_windows_terminal.png
:width: 80%
:alt: Tor windows terminal
Replace highlighted section with noted destination folder
#. That's it! Your Windows computer is now setup to natively use Tor.

View File

@@ -1,8 +1,10 @@
***************
Setting up WiFi
***************
.. _wifi:
#. Click "WiFi".
===============
Setting up WiFi - ***UPDATE SCREENS***
===============
#. On the Embassy Tab, Under "Settings", Click "WiFi".
#. Click the ``+`` button in the lower right corner.
#. Select the appropriate country.
#. Enter your WiFi SSID and password.
@@ -16,4 +18,4 @@ Setting up WiFi
#. Save
* Clicking *Add* will save the network credentials but not try to connect immediately. This is useful, for example, if you are connected over Ethernet at home and want to add your office WiFi credentials.
* `Add and Connect`.
#. The saved network will appear in the list when successfully added. If you are successfully connected, the WiFi symbol will be green, at which point, you can safely disconnect the Embassy from your router.
#. The saved network will appear in the list when successfully added. If you are successfully connected, the WiFi symbol will be green, at which point, you can safely disconnect the Embassy from your router.

View File

@@ -1,6 +1,6 @@
********
Services
********
========
Services - ***NEEDS UPDATING / SCREENS***
========
An overview of EmbassyOS general capabilities.

View File

@@ -1,13 +1,13 @@
.. _managing-services:
*****************
=================
Managing Services
*****************
=================
.. _managing-dependencies:
Dependencies
============
------------
Some services have dependencies on other services. A service may even require its dependency to be *configured* in a particular way.
@@ -22,7 +22,7 @@ Sometimes, a dependency can be satisfied in multiple ways. For example, Lightnin
.. note:: Some services have :ref:`dependencies<managing-dependencies>` on other services. Adding, updating, or removing a service can sometimes have requirements or consequences for other services. Your Embassy will inform you of these issues along the way.
Installing
==========
----------
To add a new service, find it's listing inside the Service Marketplace: *Marketplace > [Service Name] > Install*.
@@ -35,7 +35,7 @@ After installation, you can view the service's instructions by navigating to *Se
.. _updates:
Updating
========
--------
To see if an update is available for a service, you can click the *refresh* button inside the dashboard of the installed service or by visiting its listing in the Service Marketplace.
@@ -44,14 +44,14 @@ If an update is available, simply click "Update" and confirm the action.
.. _uninstalling:
Uninstalling
============
------------
To remove a service, navigate to *Services > [Service Name] > Uninstall*.
.. _instructions:
Instructions
============
------------
To view the instructions for a particular service, navigate to *Services > [Service Name] > Instructions*.
@@ -72,7 +72,7 @@ To view the instructions for a particular service, navigate to *Services > [Serv
.. _service-config:
Service Config
==============
--------------
Navigate to *Services > [Service Name] > Config*
@@ -85,7 +85,7 @@ Config options are defined by the service developer and can be almost anything.
.. _properties:
Properties
==========
----------
Navigate to *Services > [Service Name] > Properties*
@@ -100,17 +100,17 @@ Properties may be accompanied by one or more of the following:
.. _actions:
Actions
=======
-------
.. _interfaces:
Interfaces
==========
----------
.. _logs:
Logs
====
----
Naviage to *Services > [Service Name] > Logs*
@@ -119,4 +119,6 @@ Every service emits logs while it is in a *running* state. Logs give an *under-t
.. _donate:
Donate
======
------
This link is provided by the developer so that you may donate to them or the developer of the service they packaged directly.

View File

@@ -1,46 +1,57 @@
.. _backup:
******************
==================
Backing Up Embassy
******************
==================
There are 2 options for backing up your Embassy and all its service data. You can setup a shared folder on a remote machine, such as a laptop or desktop, or you can backup to a local drive, which must be externally powered or plugged into a powered USB hub before plugging into Embassy.
Remote Backups
==============
--------------
Linux
-----
=====
#. IYKYK
Mac
---
===
go to system settings
click sharing
click file sharing
click the + under shared folders
add a folder
click options
enable Windows file sharing for the user you would like to use to authenticate
click done
enter the name of your macbook, as shown in the computer name field at the top of the sharing page into the hostname field in embassy ui
enter the name of the folder as shown in the shared folders section as the path
enter your macbook username and password for the user that you enabled windows file sharing for
#. go to system settings
#. click sharing
#. click file sharing
#. click the + under shared folders
#. add a folder
#. click options
#. enable Windows file sharing for the user you would like to use to authenticate
#. click done
#. enter the name of your macbook, as shown in the computer name field at the top of the sharing page into the hostname field in embassy ui
#. enter the name of the folder as shown in the shared folders section as the path
#. enter your macbook username and password for the user that you enabled windows file sharing for
Windows
-------
=======
Create a folder
Right click the folder
select "properties"
click the share tab
click share...
select a user you want to use for login, or select everyone
click share
enter your computer name into the hostname field in embassy ui (the name is shown after a \\ in the windows ui)
enter the path that is shown after the hostname in the windows ui into the path field
enter your username for the windows computer
enter the password for the windows computer
#. Create a folder
#. Right click the folder
#. select "properties"
#. click the share tab
#. click share...
#. select a user you want to use for login, or select everyone
#. click share
#. enter your computer name into the hostname field in embassy ui (the name is shown after a \\ in the windows ui)
#. enter the path that is shown after the hostname in the windows ui into the path field
#. enter your username for the windows computer
#. enter the password for the windows computer
Local Backups
=============
-------------
Linux
=====
Mac
===
Windows
=======

View File

@@ -1,6 +1,6 @@
***********
===========
Walkthrough
***********
===========
An overview of EmbassyOS general capabilities.
@@ -8,7 +8,6 @@ An overview of EmbassyOS general capabilities.
:maxdepth: 2
overview
power
updating
updates
backup
password

View File

@@ -1,46 +1,80 @@
.. _overview:
*********************
Overview of EmbassyOS
*********************
=====================
Overview of EmbassyOS - ***NEED SCREENSHOTS / DETAILS***
=====================
.. _services-tab:
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.
Services
========
.. _embassy-tab:
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.
Backups
=======
Do the backups
Insights
========
Get the insights
Settings
========
Set the things
Power
=====
Restart
.......
#. Be patient while services shut down. A *tune* will play, indicating the shutdown is complete.
#. A gentle *bep* will sound when the Embassy is powered back on.
#. A *chime* will sound when the Embassy is ready to use. Please be patient as a Restart will take some time.
Shutdown
........
#. Be patient while services shut down. A *tune* will play, indicating the shutdown is complete.
#. It is now safe to unplug the Embassy from power and the ethernet cable, if connected.
.. note:: After a shutdown, the *only* way to turn your Embassy back on is to unplug it and plug it back in. As such, we do not recommend shutting down your Embassy when you are not physically near it. Instead, you should use the restart option.
.. _marketplace-tab:
Marketplace Tab
===============
---------------
The Marketplace Tab is obviously the home of the Marketplace, where you can install new Services, or manange existing ones.
Marketplace
===========
.. _notifications-tab:
Notifications Tab
=================
-----------------
You can view and manage your Notifications inside the "Notifications" tab in the main menu. They include:
The Notifications Tab is where you can view and manage Notifications produced by EOS and your Services
Notifications
=============
* successful or failed EmbassyOS updates
* successful or failed service installations
* successful or failed service backups
* successful or failed service updates
To delete a notification, slide the notification to the left and click the *trash* icon.
.. figure:: /_static/images/embassy_notifications.png
:width: 90%
:alt: Embassy Notifications
All notifications View
.. figure:: /_static/images/embassy_notification.png
:width: 90%
:alt: Embassy notification alert
Example notification alerts

View File

@@ -1,13 +1,13 @@
.. _forgot-password:
===============
Forgot Password
Forgot Password - ***NEEDS UPDATING***
===============
There is currently no way to reset you Embassy master password through a standard UI flow.
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.
@@ -21,7 +21,7 @@ If you already have :ref:`SSH keys registered with your Embassy<ssh-setup>` **OR
which sqlite3
sudo apt install sqlite3
* Access the sqlite3 terminal::
sudo sqlite3 /root/agent/start9_agent.sqlite3
@@ -71,6 +71,6 @@ If you already have :ref:`SSH keys registered with your Embassy<ssh-setup>` **OR
No SSH/Linux
============
------------
You must factory reset your device by re-installing EmbassyOS, resulting in permanent loss of data. Visit the `image downloader <https://images.start9labs.com/download>`_ to obtain a new EmbassyOS image, then follow the `installation instructions </getting-started/diy.html#installing-embassyos>`_.

View File

@@ -1,20 +0,0 @@
.. _power:
*****
Power
*****
Restart
=======
#. Be patient while services shut down. A *tune* will play, indicating the shutdown is complete.
#. A gentle *bep* will sound when the Embassy is powered back on.
#. A *chime* will sound when the Embassy is ready to use. Please be patient as a Restart will take some time.
Shutdown
========
#. Be patient while services shut down. A *tune* will play, indicating the shutdown is complete.
#. It is now safe to unplug the Embassy from power and the ethernet cable, if connected.
.. note:: After a shutdown, the *only* way to turn your Embassy back on is to unplug it and plug it back in. As such, we do not recommend shutting down your Embassy when you are not physically near it. Instead, you should use the restart option.

View File

@@ -0,0 +1,32 @@
.. _updates:
========
Updating
========
Keeping current on Updates ensures a fast and secure system.
.. _update-eos:
Updating EmbassyOS
------------------
When an Operating System update is available, a big, beautiful banner will appear in the Marketplace as an announcement. Simply click on this and follow the UI flow to update EmbassyOS. It is recommended to keep EOS up to date for the latest security and performance patches, as well as to take advantage of new features.
.. _auto-check-updates:
Enable Auto Check for Updates
-----------------------------
#. Navigate to the ``Embassy`` tab -> ``Preferences``
#. 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.
.. 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.
Manually Checking Updates
-------------------------
If you choose not to enable automatic updates, service updates will appear in the `Updates` tab of the Marketplace when ready.

View File

@@ -1,18 +0,0 @@
.. _updating:
==================
Updating EmbassyOS
==================
.. _update-eos:
Enable Auto Check for Updates
-----------------------------
#. Navigate to the ``Embassy`` tab -> ``Preferences``
#. Click "Check for Updates"
#. 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.
.. 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.