Dev tools init, config edits, misc edits

This commit is contained in:
kn0wmad
2022-01-16 00:28:31 -07:00
committed by Lucy Cifferello
parent 5c10c17204
commit a5fe40e84a
19 changed files with 286 additions and 82 deletions

View File

@@ -1,7 +1,7 @@
.. _lan-setup:
============
Local Access - **UPDATES REQUIRED**
Local Access
============
When you are on the same network as your Embassy (typically a home or small office), :ref:`Local Access<lan>` is much faster and will allow access to your data, even with no Internet connection. Begin by setting up :ref:`Devices<lan-os>` before setting up a :ref:`Browser<lan-browser>`.

View File

@@ -4,3 +4,6 @@
Android
=======
If you are running Android 12, you can setup :ref:`Local Access<lan>`, please see :ref:`Android Limitations <lim-android>` for more details on devices that have this capability.

View File

@@ -1,7 +1,7 @@
.. _lan-linux:
=====
Linux - ***UPDATE SCREENS***
Linux
=====
Nothing specific needs to be configured for this environment, so you just need the certificate from your Embassy.

View File

@@ -6,8 +6,8 @@ Android Known Limitations
Local Access
------------
Android does not have native support for :ref:`mDNS<mdns>` and therefore cannot resolve ``.local`` addresses. This issue has been long known by Google, and can be tracked `here <https://issuetracker.google.com/issues/140786115>`_ (Google account required to view).
Older versions of Android (previous to version 12, and some custom ROMs, such as Graphene/Calyx) do not have native support for :ref:`mDNS<mdns>` and therefore cannot resolve ``.local`` addresses. This issue has been long known by Google, and can be tracked `here <https://issuetracker.google.com/issues/140786115>`_ (Google account required to view).
Workarounds
...........
===========
An app developer can add mDNS support, and some projects, such as Chromium, have long `considered it <https://bugs.chromium.org/p/chromium/issues/detail?id=405925>`_, but the real solution is for support to occur at the OS level.

View File

@@ -9,7 +9,7 @@ Tor
It is not currently possible to run Tor natively (in the background) on iOS. The best chance for this functionality coming to iOS is via the `iCepa Project <https://github.com/iCepa>`_.
Workarounds
...........
===========
The only way to use Tor on iOS is with apps that come with Tor built-in, such as :ref:`Zap Wallet <zap>`.
Matrix
@@ -17,5 +17,5 @@ Matrix
The lack of Tor support on iOS means that Element/Matrix cannot be run on an iPhone in conjunction with your Embassy Matrix server, as that currently requires a Tor connection. This will be fixed when `Element <https://github.com/vector-im/element-ios>`_ builds Tor into their app. An issue specifically in regard to this can be found `here <https://github.com/vector-im/element-ios/issues/1085>`_.
Workarounds
...........
===========
None currently known.

View File

@@ -1,6 +1,12 @@
.. _sessions:
.. _active-sessions:
===============
Active Sessions
===============
Every time a login is made with Embassy, such as from a web browser on your laptop or mobile device, a :ref:`Session <sessions>` is created. You can see these listed in the ``Embassy`` tab, under ``Active Sessions``.
To end a session, simply click ``Kill`` to the right of your selection.
.. figure:: /_static/images/walkthrough/sessions0.svg
:width: 60%

View File

@@ -4,24 +4,32 @@
Windows
=======
.. note:: Please see Window's :ref:`Known Limitations<lim-windows>` to understand what is currently not possible on these devices
.. note:: Please see Window's :ref:`Known Limitations<lim-windows>` to understand what is currently not possible on these devices.
LAN Setup (Connectivity, Performance)
-------------------------------------
.. topic-box::
:title: LAN Setup (Connectivity, Performance)
:link: https://start9.com/latest/support/user-manual/configuration/lan-setup/lan-windows
:anchor: Setup
`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.
For a fast and secure connection while on your Embassy's local network
Tor Setup (Connectivity)
------------------------
.. topic-box::
:title: Tor Setup (Connectivity)
:link: https://start9.com/latest/support/user-manual/configuration/tor-setup/tor-os/tor-windows
:anchor: Setup
`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.
Run Tor natively (in the background) on your device. This will allow you to use applications on your Windows machine via the Tor Network so they can communicate with your Embassy.
Tor Firefox Config (Connectivity)
---------------------------------
.. topic-box::
:title: Tor Firefox Config (Connectivity)
:link: https://start9.com/latest/support/user-manual/configuration/tor-setup/tor-firefox/torff-windows
:anchor: Configure
`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.
Configure Firefox to use the Tor Network so that you can reach ``.onion`` sites without needing to change browsers.
Embassy Backups (Reliability)
-----------------------------
.. topic-box::
:title: Embassy Backups (Resilience)
:link: https://start9.com/latest/support/user-manual/walkthrough/backup/backup-win
:anchor: Backup
`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.
Configure remote backups 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.

View File

@@ -7,8 +7,11 @@ Recover Embassy from Versions 0.3.x
Recover Embassy Series 0.3.x Data
---------------------------------
This guide will cover how to recover existing EmbassyOS version 0.3.x data.
Recover From Remote Backup
==========================
Recover From Local (External Drive) Backup
==========================================

View File

@@ -8,18 +8,18 @@ Hardware
--------
Embassy is making noises
........................
========================
The plug and play Embassy sold by Start9 has no moving parts, so the only noises it should ever make would come from its internal speaker. The following is a list of all possible sounds:
#.
Embassy will not boot
.....................
=====================
If the device will not power on at all (no lights whatsoever), then the only issues could be that the Pi is not getting the power it needs, or it is completely dead (extremely rare). If you sourced your own parts, please ensure that the power supply meets the minimum required specificiations in the `DIY Guide<diy>`. If you received your device from us and it will not power up at all, please `Contact us<contact>` for assistance.
Software
--------
I'm having an issue with a particular Service
.............................................
=============================================
If a Service is crashing or acting up in some way, check the `Documentation<services>` and `FAQ<faq-services>` for that particular Service. You can also check the `Logs` of a service, which might tell you what the problem is. If that is not helpful, try to restart the service to see if that clears up the issue. If you are still having issues, please reach out in one of our `Community Channels` for immediate assistance, or email support@start9labs.com for help during business hours.

View File

@@ -4,7 +4,7 @@
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.
.. warning:: This is an advanced feature and should be used with caution. Start9 is not responsible for any damage you might cause while using SSH access.
Connecting via CLI (Linux / Mac)
--------------------------------