mirror of
https://github.com/Start9Labs/documentation.git
synced 2026-03-30 12:11:57 +00:00
re-arrange the user docs (#76)
* re-arrange the user docs * Minor description edit * update styles * fix service links Co-authored-by: kn0wmad <kn0wmad@protonmail.com> Co-authored-by: Lucy Cifferello <12953208+elvece@users.noreply.github.com>
This commit is contained in:
11
site/source/user-manual/device-guides/dg-android.rst
Normal file
11
site/source/user-manual/device-guides/dg-android.rst
Normal file
@@ -0,0 +1,11 @@
|
||||
.. _dg-android:
|
||||
|
||||
=======
|
||||
Android
|
||||
=======
|
||||
|
||||
.. tip:: Please see Android's :ref:`Known Limitations<lim-android>` to understand what is currently not possible on these devices
|
||||
|
||||
* :ref:`Connecting over LAN <lan-android>` - For a fast and secure connection while on your Embassy's local network
|
||||
* :ref:`Connecting over Tor <tor-android>` - Run Tor natively (in the background) on your device. This will allow you to use applications on your machine via the Tor Network so they can communicate with your Embassy.
|
||||
* :ref:`Tor Firefox Config <torff-android>` - Configure Firefox to use the Tor Network so that you can reach ``.onion`` sites without needing to change browsers.
|
||||
9
site/source/user-manual/device-guides/dg-ios.rst
Normal file
9
site/source/user-manual/device-guides/dg-ios.rst
Normal file
@@ -0,0 +1,9 @@
|
||||
.. _dg-ios:
|
||||
|
||||
===
|
||||
iOS
|
||||
===
|
||||
|
||||
.. tip:: Please see iOS's :ref:`Known Limitations<lim-ios>` to understand what is currently not possible on these devices
|
||||
|
||||
* :ref:`Connecting over LAN <lan-ios>` - For a fast and secure connection while on your Embassy's local network
|
||||
12
site/source/user-manual/device-guides/dg-linux.rst
Normal file
12
site/source/user-manual/device-guides/dg-linux.rst
Normal file
@@ -0,0 +1,12 @@
|
||||
.. _dg-linux:
|
||||
|
||||
=====
|
||||
Linux
|
||||
=====
|
||||
|
||||
.. tip:: Please see Linux's :ref:`Known Limitations<lim-linux>` to understand what is currently not possible on these devices
|
||||
|
||||
* :ref:`Connecting over LAN <lan-linux>` - For a fast and secure connection while on your Embassy's local network
|
||||
* :ref:`Connecting over Tor <tor-linux>` - Run Tor natively (in the background) on your device. This will allow you to use applications on your machine via the Tor Network so they can communicate with your Embassy.
|
||||
* :ref:`Tor Firefox Config <torff-linux>` - Configure Firefox to use the Tor Network so that you can reach ``.onion`` sites without needing to change browsers.
|
||||
* :ref:`SNF Setup <cifs-linux>` - Configure a Shared Network Folder on your laptop/desktop (or an external drive plugged into your laptop/desktop) in order to use it for Embassy backups.
|
||||
12
site/source/user-manual/device-guides/dg-mac.rst
Normal file
12
site/source/user-manual/device-guides/dg-mac.rst
Normal file
@@ -0,0 +1,12 @@
|
||||
.. _dg-mac:
|
||||
|
||||
===
|
||||
Mac
|
||||
===
|
||||
|
||||
.. tip:: Please see Mac's :ref:`Known Limitations<lim-mac>` to understand what is currently not possible on these devices
|
||||
|
||||
* :ref:`Connecting over LAN <lan-mac>` - For a fast and secure connection while on your Embassy's local network
|
||||
* :ref:`Connecting over Tor <tor-mac>` - Run Tor natively (in the background) on your device. This will allow you to use applications on your machine via the Tor Network so they can communicate with your Embassy.
|
||||
* :ref:`Tor Firefox Config <torff-mac>` - Configure Firefox to use the Tor Network so that you can reach ``.onion`` sites without needing to change browsers.
|
||||
* :ref:`SNF Setup <cifs-mac>` - Configure a Shared Network Folder on your laptop/desktop (or an external drive plugged into your laptop/desktop) in order to use it for Embassy backups.
|
||||
12
site/source/user-manual/device-guides/dg-windows.rst
Normal file
12
site/source/user-manual/device-guides/dg-windows.rst
Normal file
@@ -0,0 +1,12 @@
|
||||
.. _dg-windows:
|
||||
|
||||
=======
|
||||
Windows
|
||||
=======
|
||||
|
||||
.. tip:: Please see Window's :ref:`Known Limitations<lim-windows>` to understand what is currently not possible on these devices.
|
||||
|
||||
* :ref:`Connecting over LAN <lan-windows>` - For a fast and secure connection while on your Embassy's local network
|
||||
* :ref:`Connecting over Tor <tor-windows>` - Run Tor natively (in the background) on your device. This will allow you to use applications on your machine via the Tor Network so they can communicate with your Embassy.
|
||||
* :ref:`Tor Firefox Config <torff-windows>` - Configure Firefox to use the Tor Network so that you can reach ``.onion`` sites without needing to change browsers.
|
||||
* :ref:`SNF Setup <cifs-windows>` - Configure a Shared Network Folder on your laptop/desktop (or an external drive plugged into your laptop/desktop) in order to use it for Embassy backups.
|
||||
17
site/source/user-manual/device-guides/index.rst
Normal file
17
site/source/user-manual/device-guides/index.rst
Normal file
@@ -0,0 +1,17 @@
|
||||
.. _device-guides:
|
||||
|
||||
=============
|
||||
Device Guides
|
||||
=============
|
||||
|
||||
Guides to get connected with or improve your Embassy by device-type.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
dg-linux
|
||||
dg-mac
|
||||
dg-windows
|
||||
dg-android
|
||||
dg-ios
|
||||
limitations/index
|
||||
16
site/source/user-manual/device-guides/limitations/index.rst
Normal file
16
site/source/user-manual/device-guides/limitations/index.rst
Normal file
@@ -0,0 +1,16 @@
|
||||
.. _limitations:
|
||||
|
||||
=================
|
||||
Known Limitations
|
||||
=================
|
||||
|
||||
The following pages describe functionality that is known to be missing from certain platforms. Please bother the appropriate company or developers until they have been remedied.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
lim-linux
|
||||
lim-mac
|
||||
lim-windows
|
||||
lim-android
|
||||
lim-ios
|
||||
@@ -0,0 +1,17 @@
|
||||
.. _lim-android:
|
||||
|
||||
=======
|
||||
Android
|
||||
=======
|
||||
|
||||
Local Access
|
||||
------------
|
||||
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.
|
||||
|
||||
LineageOS
|
||||
---------
|
||||
Unfortunately, there seems to be a bug in Lineage that makes using Firefox over Tor currently unusable. Currently, this feature works fine on Calyx and Graphene.
|
||||
@@ -0,0 +1,25 @@
|
||||
.. _lim-ios:
|
||||
|
||||
===
|
||||
iOS
|
||||
===
|
||||
|
||||
Tor
|
||||
---
|
||||
It is not currently possible to run Tor natively (in the background) on iOS. The best chance for this functionality coming to iOS in the future is via the `iCepa Project <https://github.com/iCepa>`_.
|
||||
|
||||
Workarounds
|
||||
===========
|
||||
The only way to use Tor (in the background) on iOS is with apps that come with Tor built-in, such as :ref:`Zap Wallet <zap>`. For visiting Embassy UI Tor sites, you may use `Onion Browser <https://apps.apple.com/us/app/onion-browser/id519296448>`_ or `Start9's Consulate <https://apps.apple.com/us/app/start9-consulate-browser/id1528124570>`_ application.
|
||||
|
||||
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, but may be solved with forthcoming "clearnet" support on EmbassyOS.
|
||||
|
||||
Spark Wallet
|
||||
------------
|
||||
Unfortunately, Spark cannot currently be used in Consulate. This issue is being tracked `here <https://github.com/Start9Labs/consulate-ios/issues/30>`__.
|
||||
@@ -0,0 +1,7 @@
|
||||
.. _lim-linux:
|
||||
|
||||
=====
|
||||
Linux
|
||||
=====
|
||||
|
||||
Currently, Linux has no known limitations in regard to Embassy. Congratulations, Master Race...
|
||||
@@ -0,0 +1,7 @@
|
||||
.. _lim-mac:
|
||||
|
||||
===
|
||||
Mac
|
||||
===
|
||||
|
||||
MacOS has no known limitations in regard to Embassy at this time.
|
||||
@@ -0,0 +1,9 @@
|
||||
.. _lim-windows:
|
||||
|
||||
=======
|
||||
Windows
|
||||
=======
|
||||
|
||||
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.
|
||||
Reference in New Issue
Block a user