mirror of
https://github.com/Start9Labs/documentation.git
synced 2026-03-26 10:21:53 +00:00
Initial Setup and device guide edits
This commit is contained in:
kn0wmad
@@ -12,15 +12,18 @@ What considerations are there when choosing a service for packaging?
|
||||
--------------------------------------------------------------------
|
||||
There are several things you will want to consider. Requirements include:
|
||||
|
||||
#. Most importantly, pick a service you are passionate about seeing on EmbassyOS.
|
||||
#. Most importantly, pick a service you are passionate about seeing on EmbassyOS
|
||||
#. Make sure it is :ref:`Open Source <open-source>`
|
||||
|
||||
Recommendations that may ease the process:
|
||||
|
||||
#. A service that has already been 'dockerized' (has a **working** ``Dockerfile``)
|
||||
#. A service that incorporates a 'self-hosting' option
|
||||
#. A service written in a language you are familiar with
|
||||
#. A service with a strong community
|
||||
|
||||
You can check this expansive list if you are in search of ideas: `Awesome Self-Hosted <https://github.com/awesome-selfhosted/awesome-selfhosted>`_
|
||||
|
||||
What if I don't need a Config in my service?
|
||||
--------------------------------------------
|
||||
Config files can be empty(``{}``), if you do not require config.
|
||||
|
||||
@@ -6,10 +6,10 @@ Welcome to the Start9 Docs!
|
||||
|
||||
Here you will find guidance and information about Embassy personal server and its operating system, EmbassyOS. If you identify an error with the docs or would like to contribute to them, please use the GitHub link at the top of this page.
|
||||
|
||||
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 `User Manual <link>`, you will find information on what EmbassyOS can do for you, as well as configuration and customization options. Use our `Knowledgebase <link>` to learn more about the technologies behind Embassy. When you're ready to build, please check out our `Developer Docs <link>`. 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 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 `User Manual <link>`, you will find information on what EmbassyOS can do for you, as well as configuration and customization options. Use our `Knowledgebase <link>` to learn more about the technologies behind Embassy, including Frequently Asked Questions. When you're ready to build, please check out our `Developer Docs <link>`. Please don't hestitate to `Contact Us <https://start9.com/contact>`_ if you have any issues, questions, or suggestions that are not covered here.
|
||||
|
||||
Table of Contents
|
||||
-----------------
|
||||
=================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
@@ -1,5 +1,13 @@
|
||||
.. _lim-android:
|
||||
|
||||
*******
|
||||
Android
|
||||
*******
|
||||
*************************
|
||||
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 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.
|
||||
|
||||
@@ -1,5 +1,21 @@
|
||||
.. _lim-ios:
|
||||
|
||||
***
|
||||
iOS
|
||||
***
|
||||
*********************
|
||||
iOS Known Limitations
|
||||
*********************
|
||||
|
||||
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
|
||||
======
|
||||
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 if `Element <https://github.com/vector-im/element-ios>` builds Tor into their app.
|
||||
|
||||
Workarounds
|
||||
-----------
|
||||
None currently known.
|
||||
|
||||
@@ -1,5 +1,7 @@
|
||||
.. _lim-linux:
|
||||
|
||||
*****
|
||||
Linux
|
||||
*****
|
||||
***********************
|
||||
Linux Known Limitations
|
||||
***********************
|
||||
|
||||
Linux has no known limitations in regard to Embassy. Congratulations, Master Race...
|
||||
|
||||
@@ -1,15 +1,6 @@
|
||||
.. _lim-mac:
|
||||
|
||||
***
|
||||
Mac
|
||||
***
|
||||
*********************
|
||||
Mac Known Limitations
|
||||
*********************
|
||||
|
||||
.. _lim-new-mac:
|
||||
|
||||
Newer Mac (M1)
|
||||
==============
|
||||
|
||||
.. _lim-old-mac:
|
||||
|
||||
Older Mac
|
||||
=========
|
||||
@@ -1,5 +1,5 @@
|
||||
.. _lim-windows:
|
||||
|
||||
*******
|
||||
Windows
|
||||
*******
|
||||
*************************
|
||||
Windows Known Limitations
|
||||
*************************
|
||||
|
||||
@@ -3,3 +3,21 @@
|
||||
*******
|
||||
Android
|
||||
*******
|
||||
|
||||
Tor Setup (Connectivity)
|
||||
========================
|
||||
|
||||
|location link| to run natively (in the background) on your device. This will allow you to use applications on your machine via the :ref:`Tor Network<tor>` so they can communicate with your Embassy.
|
||||
|
||||
.. |location link| raw:: html
|
||||
|
||||
<a href="docs.start9.com/user-manual/configuration/tor-setup/tor-os/tor-android" target="_blank">Setup Tor</a>
|
||||
|
||||
Tor Firefox Config (Connectivity)
|
||||
=================================
|
||||
|
||||
|location link| to be able to use the :ref:`Tor Network<tor>` so that you can reach ``.onion`` sites without needing to change browsers.
|
||||
|
||||
.. |location link| raw:: html
|
||||
|
||||
<a href="docs.start9.com/user-manual/configuration/tor-setup/tor-firefox/torff-android" target="_blank">Configure Firefox</a>
|
||||
|
||||
@@ -3,3 +3,12 @@
|
||||
***
|
||||
iOS
|
||||
***
|
||||
|
||||
LAN Setup (Connectivity, Performance)
|
||||
=====================================
|
||||
|
||||
|location link| for a fast and secure connection while on your Embassy's local network.
|
||||
|
||||
.. |location link| raw:: html
|
||||
|
||||
<a href="docs.start9.com/user-manual/configuration/lan-setup/lan-ios" target="_blank">Setup LAN Access</a>
|
||||
|
||||
@@ -1,5 +1,32 @@
|
||||
.. _dg-linux:
|
||||
|
||||
*****
|
||||
Linux
|
||||
*****
|
||||
************
|
||||
Linux Guides
|
||||
************
|
||||
|
||||
LAN Setup (Connectivity, Performance)
|
||||
=====================================
|
||||
|
||||
|location link| for a fast and secure connection while on your Embassy's local network.
|
||||
|
||||
.. |location link| raw:: html
|
||||
|
||||
<a href="docs.start9.com/user-manual/configuration/lan-setup/lan-linux" target="_blank">Setup LAN Access</a>
|
||||
|
||||
Tor Setup (Connectivity)
|
||||
========================
|
||||
|
||||
|location link| to run natively (in the background) on your device. This will allow you to use applications on your machine via the :ref:`Tor Network<tor>` so they can communicate with your Embassy.
|
||||
|
||||
.. |location link| raw:: html
|
||||
|
||||
<a href="docs.start9.com/user-manual/configuration/tor-setup/tor-os/tor-linux" target="_blank">Setup Tor</a>
|
||||
|
||||
Tor Firefox Config (Connectivity)
|
||||
=================================
|
||||
|
||||
|location link| to be able to use the :ref:`Tor Network<tor>` so that you can reach ``.onion`` sites without needing to change browsers.
|
||||
|
||||
.. |location link| raw:: html
|
||||
|
||||
<a href="docs.start9.com/user-manual/configuration/tor-setup/tor-firefox/torff-linux" target="_blank">Configure Firefox</a>
|
||||
|
||||
@@ -4,13 +4,29 @@
|
||||
Mac
|
||||
***
|
||||
|
||||
.. _dg-new-mac:
|
||||
LAN Setup (Connectivity, Performance)
|
||||
=====================================
|
||||
|
||||
Newer Mac (M1)
|
||||
==============
|
||||
|location link| for a fast and secure connection while on your Embassy's local network.
|
||||
|
||||
.. _dg-old-mac:
|
||||
.. |location link| raw:: html
|
||||
|
||||
Older Mac
|
||||
=========
|
||||
<a href="docs.start9.com/user-manual/configuration/lan-setup/lan-mac" target="_blank">Setup LAN Access</a>
|
||||
|
||||
Tor Setup (Connectivity)
|
||||
========================
|
||||
|
||||
|location link| to run natively (in the background) on your device. This will allow you to use applications on your machine via the :ref:`Tor Network<tor>` so they can communicate with your Embassy.
|
||||
|
||||
.. |location link| raw:: html
|
||||
|
||||
<a href="docs.start9.com/user-manual/configuration/tor-setup/tor-os/tor-mac" target="_blank">Setup Tor</a>
|
||||
|
||||
Tor Firefox Config (Connectivity)
|
||||
=================================
|
||||
|
||||
|location link| to be able to use the :ref:`Tor Network<tor>` so that you can reach ``.onion`` sites without needing to change browsers.
|
||||
|
||||
.. |location link| raw:: html
|
||||
|
||||
<a href="docs.start9.com/user-manual/configuration/tor-setup/tor-firefox/torff-mac" target="_blank">Configure Firefox</a>
|
||||
|
||||
@@ -3,3 +3,30 @@
|
||||
*******
|
||||
Windows
|
||||
*******
|
||||
|
||||
LAN Setup (Connectivity, Performance)
|
||||
=====================================
|
||||
|
||||
|location link| for a fast and secure connection while on your Embassy's local network.
|
||||
|
||||
.. |location link| raw:: html
|
||||
|
||||
<a href="docs.start9.com/user-manual/configuration/lan-setup/lan-windows" target="_blank">Setup LAN Access</a>
|
||||
|
||||
Tor Setup (Connectivity)
|
||||
========================
|
||||
|
||||
|location link| to run natively (in the background) on your device. This will allow you to use applications on your machine via the :ref:`Tor Network<tor>` so they can communicate with your Embassy.
|
||||
|
||||
.. |location link| raw:: html
|
||||
|
||||
<a href="docs.start9.com/user-manual/configuration/tor-setup/tor-os/tor-windows" target="_blank">Setup Tor</a>
|
||||
|
||||
Tor Firefox Config (Connectivity)
|
||||
=================================
|
||||
|
||||
|location link| to be able to use the :ref:`Tor Network<tor>` so that you can reach ``.onion`` sites without needing to change browsers.
|
||||
|
||||
.. |location link| raw:: html
|
||||
|
||||
<a href="docs.start9.com/user-manual/configuration/tor-setup/tor-firefox/torff-windows" target="_blank">Configure Firefox</a>
|
||||
|
||||
@@ -50,7 +50,7 @@ Claim Your Embassy
|
||||
If your router does not support mDNS
|
||||
|
||||
* On your desktop or laptop computer, navigate to your router configuration settings within the browser. This is usually an IP address such as 192.168.1.1. A simple Google search will usually reveal how to access the router configuration settings for a particular brand.
|
||||
* Once in the router config settings, find the section that lists the devices on your network. You should see an item labeled "start9labs". Take note of the associated IP address and enter it into the Setup App in the "LAN IP Address" input field.
|
||||
* Once in the router config settings, find the section that lists the devices on your network. You should see an item labeled "embassy". Take note of the associated IP address and enter it into your browser's URL field to enter setup.
|
||||
|
||||
3. Create your *permanent* master password and complete setup.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user