mirror of
https://github.com/Start9Labs/documentation.git
synced 2026-03-26 02:11:55 +00:00
Lots of menu edits for readability
This commit is contained in:
kn0wmad
@@ -4,10 +4,11 @@
|
||||
Roadmap
|
||||
=======
|
||||
|
||||
Probably needs to actually be an html page that is linked to from "About"
|
||||
Under Construction
|
||||
------------------
|
||||
|
||||
Please pardon our dust...
|
||||
|
||||
Also badly needs updating
|
||||
|
||||
.. .. raw:: html
|
||||
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
.. _faq-contributing:
|
||||
|
||||
============
|
||||
Contributing
|
||||
============
|
||||
================
|
||||
Contributing FAQ
|
||||
================
|
||||
|
||||
We ❤️ contributions!
|
||||
|
||||
|
||||
@@ -4,9 +4,9 @@
|
||||
:depth: 3
|
||||
:local:
|
||||
|
||||
=====================
|
||||
Service Packaging FAQ
|
||||
=====================
|
||||
=============
|
||||
Packaging FAQ
|
||||
=============
|
||||
|
||||
Do I need programming experience to package a service for EmbassyOS?
|
||||
--------------------------------------------------------------------
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
.. _exec-service-container:
|
||||
|
||||
=========================
|
||||
Enter a Service Container
|
||||
=========================
|
||||
==================
|
||||
Service Containers
|
||||
==================
|
||||
|
||||
For simplicity, EmbassyOS is designed to be completely operated via the :ref:`WebUI<web-ui>`, however, your device belongs to you and if you want to "lift the hood" and access the internals of the software, you may do so. This guide will show you how to enter a Service's :ref:`container<containers>` in order to directly interface with it and issue commands.
|
||||
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
.. _service-packaging-spec:
|
||||
|
||||
===============================
|
||||
Service Packaging Specification
|
||||
===============================
|
||||
======================
|
||||
Service Packaging Spec
|
||||
======================
|
||||
|
||||
Welcome! If you are here, you are interested in becoming part of the mission to change the future of personal computing. This guide will take you through the process of packaging a service for EmbassyOS, a novel, self-hosted, sovereign computing platform.
|
||||
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
.. _service_package_overview:
|
||||
|
||||
========================
|
||||
Service Package Overview
|
||||
========================
|
||||
==================
|
||||
Packaging Overview
|
||||
==================
|
||||
|
||||
.. contents::
|
||||
:depth: 2
|
||||
|
||||
@@ -11,8 +11,8 @@ Answers to Frequently Asked Questions from Embassy users
|
||||
|
||||
faq-general
|
||||
faq-030
|
||||
faq-basic-use
|
||||
faq-troubleshooting
|
||||
faq-basic-use
|
||||
faq-embassy
|
||||
faq-services
|
||||
faq-bitcoin
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
.. _lan-setup:
|
||||
|
||||
============
|
||||
Local Access
|
||||
============
|
||||
=================
|
||||
Local (LAN) Setup
|
||||
=================
|
||||
|
||||
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>`.
|
||||
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
.. _lan-browser:
|
||||
|
||||
====================
|
||||
LAN Setup - Browsers
|
||||
====================
|
||||
=============
|
||||
LAN - Browser
|
||||
=============
|
||||
|
||||
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.
|
||||
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
.. _lan-os:
|
||||
|
||||
===================
|
||||
LAN Setup - Devices
|
||||
===================
|
||||
============
|
||||
LAN - Device
|
||||
============
|
||||
|
||||
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.
|
||||
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
.. _lim-android:
|
||||
|
||||
=========================
|
||||
Android Known Limitations
|
||||
=========================
|
||||
=======
|
||||
Android
|
||||
=======
|
||||
|
||||
Local Access
|
||||
------------
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
.. _lim-ios:
|
||||
|
||||
=====================
|
||||
iOS Known Limitations
|
||||
=====================
|
||||
===
|
||||
iOS
|
||||
===
|
||||
|
||||
Tor
|
||||
---
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
.. _lim-linux:
|
||||
|
||||
=======================
|
||||
Linux Known Limitations
|
||||
=======================
|
||||
=====
|
||||
Linux
|
||||
=====
|
||||
|
||||
Currently, Linux has no known limitations in regard to Embassy. Congratulations, Master Race...
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
.. _lim-mac:
|
||||
|
||||
=====================
|
||||
Mac Known Limitations
|
||||
=====================
|
||||
===
|
||||
Mac
|
||||
===
|
||||
|
||||
MacOS has no known limitations in regard to Embassy at this time.
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
.. _lim-windows:
|
||||
|
||||
=========================
|
||||
Windows Known Limitations
|
||||
=========================
|
||||
=======
|
||||
Windows
|
||||
=======
|
||||
|
||||
Windows10 has no known limitations in regard to Embassy at this time.
|
||||
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
.. _tor-firefox:
|
||||
|
||||
===================
|
||||
Tor Setup - Firefox
|
||||
===================
|
||||
=============
|
||||
Tor - Firefox
|
||||
=============
|
||||
|
||||
.. caution:: This guide assumes you are already :ref:`running Tor on your phone or computer<running-tor>`.
|
||||
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
.. _tor-os:
|
||||
|
||||
===================
|
||||
Tor Setup - Devices
|
||||
===================
|
||||
============
|
||||
Tor - Device
|
||||
============
|
||||
|
||||
Select your Operating System to setup Tor to run in the background (natively) of any device that you might want to use to access your Embassy with remotely.
|
||||
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
.. _dg-android:
|
||||
|
||||
==============
|
||||
Android Guides
|
||||
==============
|
||||
=======
|
||||
Android
|
||||
=======
|
||||
|
||||
.. tip:: Please see Android's :ref:`Known Limitations<lim-android>` to understand what is currently not possible on these devices
|
||||
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
.. _dg-ios:
|
||||
|
||||
==========
|
||||
iOS Guides
|
||||
==========
|
||||
===
|
||||
iOS
|
||||
===
|
||||
|
||||
.. tip:: Please see iOS's :ref:`Known Limitations<lim-ios>` to understand what is currently not possible on these devices
|
||||
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
.. _dg-linux:
|
||||
|
||||
============
|
||||
Linux Guides
|
||||
============
|
||||
=====
|
||||
Linux
|
||||
=====
|
||||
|
||||
.. tip:: Please see Linux's :ref:`Known Limitations<lim-linux>` to understand what is currently not possible on these devices
|
||||
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
.. _dg-mac:
|
||||
|
||||
==========
|
||||
Mac Guides
|
||||
==========
|
||||
===
|
||||
Mac
|
||||
===
|
||||
|
||||
.. tip:: Please see Mac's :ref:`Known Limitations<lim-mac>` to understand what is currently not possible on these devices
|
||||
|
||||
@@ -32,4 +32,4 @@ Mac Guides
|
||||
:link: https://start9.com/latest/support/user-manual/walkthrough/backup/backup-mac
|
||||
:anchor: Backup
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
.. _dg-windows:
|
||||
|
||||
==============
|
||||
Windows Guides
|
||||
==============
|
||||
=======
|
||||
Windows
|
||||
=======
|
||||
|
||||
.. tip:: Please see Window's :ref:`Known Limitations<lim-windows>` to understand what is currently not possible on these devices.
|
||||
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
.. _device-guides:
|
||||
|
||||
======================
|
||||
Device-Specific Guides
|
||||
======================
|
||||
=============
|
||||
Device Guides
|
||||
=============
|
||||
|
||||
Guides to get connected with or improve your Embassy by device-type.
|
||||
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
.. _recover-02x:
|
||||
|
||||
===================================
|
||||
Migrate Embassy from Versions 0.2.x
|
||||
===================================
|
||||
===================
|
||||
Migrate v0.2.x Data
|
||||
===================
|
||||
|
||||
.. contents::
|
||||
:depth: 4
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
.. _recover-03x:
|
||||
|
||||
===================================
|
||||
Recover Embassy from Versions 0.3.x
|
||||
===================================
|
||||
===================
|
||||
Recover v0.3.x Data
|
||||
===================
|
||||
|
||||
Recover Embassy Series 0.3.x Data
|
||||
---------------------------------
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
.. _service-overview:
|
||||
|
||||
=================
|
||||
Services Overview
|
||||
=================
|
||||
========
|
||||
Overview
|
||||
========
|
||||
|
||||
Services are very similar to Applications on a mobile device. The biggest differences are that they are often designed to run constantly, with 24/7 availability for when a user requires them. This is why they are called :ref:`Services<services>`, they are always ready to serve users!
|
||||
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
.. _shoot-connection:
|
||||
|
||||
===========================
|
||||
Troubleshooting Connections
|
||||
===========================
|
||||
===========
|
||||
Connections
|
||||
===========
|
||||
|
||||
During initial setup, I am unable to connect to ``embassy.local``.
|
||||
------------------------------------------------------------------
|
||||
@@ -16,4 +16,4 @@ Make sure you have successfully followed the :ref:`LAN Setup<lan-setup>` instruc
|
||||
|
||||
I am unable to reach Embassy via it's ``xxxxxxxxxxxxxxxxxx.onion`` (Tor) address
|
||||
--------------------------------------------------------------------------------
|
||||
First, attmept to connect using :ref:`The Tor Browser<tor-browser>`. This is a good test because Tor Browser has Tor built in. If you cannot reach your ``.onion`` with Tor Browser, reboot the Embassy by unplugging power and plugging it back in. This will reset your Tor connection. If you can reach via Tor Browser, but not with another browser, then follow the setup guides to run Tor on your device :ref:`Natively<tor-os>` and/or to :ref:`Configure Your Browser<tor-firefox>`.
|
||||
First, attmept to connect using :ref:`The Tor Browser<tor-browser>`. This is a good test because Tor Browser has Tor built in. If you cannot reach your ``.onion`` with Tor Browser, reboot the Embassy by unplugging power and plugging it back in. This will reset your Tor connection. If you can reach via Tor Browser, but not with another browser, then follow the setup guides to run Tor on your device :ref:`Natively<tor-os>` and/or to :ref:`Configure Your Browser<tor-firefox>`.
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
.. _shoot-embassy:
|
||||
|
||||
=======================
|
||||
Troubleshooting Embassy
|
||||
=======================
|
||||
=======
|
||||
Embassy
|
||||
=======
|
||||
|
||||
Hardware
|
||||
--------
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
.. _alt-marketplace:
|
||||
|
||||
=======================
|
||||
Alternative Marketplace
|
||||
=======================
|
||||
===============
|
||||
Alt Marketplace
|
||||
===============
|
||||
|
||||
EmbassyOS supports accessing alternative marketplaces.
|
||||
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
.. _advanced-config:
|
||||
|
||||
======================
|
||||
Advanced Configuration
|
||||
======================
|
||||
===============
|
||||
Advanced Config
|
||||
===============
|
||||
|
||||
Custom options for folks that "know what they're doing."
|
||||
|
||||
|
||||
@@ -32,26 +32,42 @@ You can also drop into a shell using::
|
||||
|
||||
and then enter ``bitcoin-cli`` commands. When you are finished, simply type ``exit``.
|
||||
|
||||
Software Wallets
|
||||
----------------
|
||||
|
||||
.. _electrum:
|
||||
|
||||
Electrum
|
||||
--------
|
||||
========
|
||||
|
||||
Available for
|
||||
.............
|
||||
-Linux
|
||||
|
||||
**UNTESTED**
|
||||
|
||||
.. _fully-noded:
|
||||
|
||||
FullyNoded
|
||||
----------
|
||||
==========
|
||||
|
||||
.. note:: Mac only
|
||||
.. note:: Mac / iOS only
|
||||
|
||||
**UNTESTED**
|
||||
|
||||
.. _ledger-live:
|
||||
|
||||
Ledger Live
|
||||
===========
|
||||
|
||||
.. tip:: Built for use with Ledger hardware devices
|
||||
|
||||
**UNTESTED**
|
||||
|
||||
.. _samourai:
|
||||
|
||||
Samourai
|
||||
--------
|
||||
========
|
||||
|
||||
.. note:: Android only
|
||||
|
||||
@@ -60,33 +76,25 @@ Samourai
|
||||
.. _sparrow:
|
||||
|
||||
Sparrow
|
||||
-------
|
||||
=======
|
||||
|
||||
**UNTESTED**
|
||||
|
||||
.. _specter:
|
||||
|
||||
Specter
|
||||
-------
|
||||
=======
|
||||
|
||||
Current - https://github.com/Start9Labs/bitcoind-wrapper/tree/master/docs/integrations/specter
|
||||
|
||||
**UNTESTED**
|
||||
|
||||
.. _trezor:
|
||||
.. _trezor-suite:
|
||||
|
||||
Trezor Suite
|
||||
------------
|
||||
============
|
||||
|
||||
.. tip:: Built for use with Trezor hardware devices
|
||||
|
||||
**UNTESTED**
|
||||
|
||||
.. _ledger:
|
||||
|
||||
Ledger Live
|
||||
-----------
|
||||
|
||||
.. tip:: Built for use with Ledger hardware devices
|
||||
|
||||
**UNTESTED**
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
.. _service-guides:
|
||||
|
||||
=======================
|
||||
Service-Specific Guides
|
||||
=======================
|
||||
==============
|
||||
Service Guides
|
||||
==============
|
||||
|
||||
These guides will help you to setup external tools to connect or interact with specific :ref:`Services<services>`, such as a chat client or :ref:`Bitcoin<bitcoin>` wallet.
|
||||
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
.. _tune-embassy-os:
|
||||
|
||||
=====================
|
||||
Customizing EmbassyOS
|
||||
=====================
|
||||
===============
|
||||
Customizing EOS
|
||||
===============
|
||||
|
||||
.. _device-name:
|
||||
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
.. _error-logs:
|
||||
|
||||
=============================
|
||||
Anonymous Error Log Reporting
|
||||
=============================
|
||||
===================
|
||||
Error Log Reporting
|
||||
===================
|
||||
|
||||
When you fire up your Embassy for the first time, you will be greeted with a modal asking you if you would be willing to provide your error logs to Start9 to assist us in improving EmbassyOS and its ecosystem. The decision to send or retain this data is 100% yours. Below are details to aid you in determining your choice.
|
||||
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
.. _overview:
|
||||
|
||||
=====================
|
||||
Overview of EmbassyOS
|
||||
=====================
|
||||
==================
|
||||
EmbassyOS Overview
|
||||
==================
|
||||
|
||||
.. _services-tab:
|
||||
|
||||
|
||||
Reference in New Issue
Block a user