Start9/documentation
2
0
Fork 0
mirror of https://github.com/Start9Labs/documentation.git synced 2026-03-26 02:11:55 +00:00
Code Issues Packages Projects Releases Wiki Activity

Guide updates, yanked bug reporting

Browse Source
This commit is contained in:
kn0wmad
2022-02-10 14:00:56 -07:00
committed by Lucy Cifferello
parent ec78649efb
commit c5a4077e9e
7 changed files with 251 additions and 132 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
site/03-todo.md
View File

@@ -1,21 +1,22 @@
# TODO
- Update all guides in service repos (link to wrapper repos in service guides)
- Lightning
- Lightning (Zeus)
- Vaultwarden needs screens
- Verify LAN and Tor setup steps on a Mac
- Refactor and update Roadmap
- Add / verify ALL links in the **UI** go to the right place in docs
# BLOCKED:
- Mission / values
- Initial Setup
- Possible sounds in troubleshooting (and walkthrough?)
- Alt Market Switching
- Migration / Recovery
- Backups
- CIFS
- OS guides for CIFS
- Local
- Restore from backup
- Alt Market Switching
# BLOCKED:
- Mission / values
- Possible sounds in troubleshooting (and walkthrough?)
- Alt Market Build Guide
- Launch versioned site/docs to start9.com
- Verify ALL links (especially in device guides as they are all external)
@@ -24,8 +25,4 @@
- Create badges for device guide topic boxes <connectivity, performance, resilience and/or tuning>
- Close all relevant issues (some await new processes in order to test)
- Migrate from other server projects / nodes (currently punted)
# Chris devdocs edits
Dependencies - This should be rolled into the config/manifest sections, unless the newdependencies.yaml file is what's being referred to, in which case it needs to be rewritten anyway - Lucy??
Screen Shot 2022-02-01 at 2.21.44 PM.png - this is technically just an artifact of compat now. in 030, properties can be any docker action
- Breakout Bitcoin / Lightning integrations into their own individual pages

18
site/source/support/user-manual/configuration/basic-config.rst
View File

@@ -4,20 +4,20 @@
Basic Configuration
===================
.. _auto-reporting:
.. .. _auto-reporting:
Automatically Report Bugs
-------------------------
.. Automatically Report Bugs
.. -------------------------
You are asked at first setup if you would like to provide bug reports to Start9. You can edit that setting here if you change your mind. This data is anonymous and you can see exactly what is collected :ref:`here<error-logs>`.
.. You are asked at first setup if you would like to provide bug reports to Start9. You can edit that setting here if you change your mind. This data is anonymous and you can see exactly what is collected :ref:`here<error-logs>`.
#. As in the :ref:`Set Device Name<device-name>` steps above, go to the ``Embasssy`` tab, then under ``Settings``, click ``Preferences``
.. #. As in the :ref:`Set Device Name<device-name>` steps above, go to the ``Embasssy`` tab, then under ``Settings``, click ``Preferences``
#. Click ``Auto Report Bugs`` and either ``Enable`` or ``Disable``
.. #. Click ``Auto Report Bugs`` and either ``Enable`` or ``Disable``
.. figure:: /_static/images/config/basic-config3.png
:width: 60%
:alt: Automatically Report Bugs
.. .. figure:: /_static/images/config/basic-config3.png
.. :width: 60%
.. :alt: Automatically Report Bugs
.. _auto-update:

166
site/source/support/user-manual/tuning/service-guides/bitcoin.rst
View File

@@ -6,6 +6,99 @@ Bitcoin
Here you will find guides on how to connect different kinds of Bitcoin wallets (hardware and software) to your Embassy node, to complete your sovereign Bitcoin stack!
Tested Wallets
--------------
.. _blockstream-green:
Blockstream Green
=================
.. note:: Not Possible at this time - No ability to connect to a Bitcoin node
.. _blue-wallet:
BlueWallet
==========
.. note:: Not Possible at this time - Requires Electrum Server
.. _electrum:
Electrum
========
.. warning:: UNTESTED
.. _fully-noded:
FullyNoded
==========
Available For
.............
- iOS
- Mac
Instructions
............
1. In Fully Noded, go to `Settings > Node Manager > +`
2. Enter your Bitcoin Core credentials. You can do this in one of two ways: (1) Use Fully Noded to scan your QuickConnect QR code (located in `Services > Bitcoin Core > properties`); or (2) copy/paste your Bitcoin Core Tor Address (located in `Services > Bitcoin Core > Interfaces`) with :8332 appended, as well as you rpc username and password (located in `Services > Bitcoin Core > Config > RPC Settings`).
.. _ledger-live:
Ledger Live
===========
.. tip:: Built for use with Ledger hardware devices
.. warning:: UNTESTED
.. _samourai:
Samourai
========
.. note:: Not Possible at this time - Requires Dojo Stack
.. _sparrow:
Sparrow
=======
Available For
.............
- Linux
- Mac
- Windows
Instructions
............
Follow the `guide <https://github.com/start9labs/bitcoind-wrapper/docs/integrations/sparrow/guide.md>`_.
.. _specter:
Specter
=======
Available For
.............
- Linux
- Mac
- Windows
Instructions
............
Follow the `guide <https://github.com/Start9Labs/bitcoind-wrapper/tree/master/docs/integrations/specter>`_.
.. _trezor-suite:
Trezor Suite
============
.. tip:: Built for use with Trezor hardware devices
.. warning:: UNTESTED
.. _bitcoin-cli:
Using Bitcoin-Cli
@@ -20,9 +113,7 @@ Instructions for accessing the bitcoind service in order to issue commands direc
sudo docker exec bitcoind bitcoin-cli COMMAND
.. admonition:: Example
sudo docker exec bitcoind bitcoin-cli getnetworkinfo
.. tip:: For example ``sudo docker exec bitcoind bitcoin-cli getnetworkinfo``
A list of possible commands can be found `here <https://chainquery.com/bitcoin-cli>`_.
@@ -30,71 +121,4 @@ You can also drop into a shell using::
sudo docker exec -it bitcoind bash
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 / iOS only
**UNTESTED**
.. _ledger-live:
Ledger Live
===========
.. tip:: Built for use with Ledger hardware devices
**UNTESTED**
.. _samourai:
Samourai
========
.. note:: Android only
**UNTESTED**
.. _sparrow:
Sparrow
=======
**UNTESTED**
.. _specter:
Specter
=======
Current - https://github.com/Start9Labs/bitcoind-wrapper/tree/master/docs/integrations/specter
**UNTESTED**
.. _trezor-suite:
Trezor Suite
============
.. tip:: Built for use with Trezor hardware devices
**UNTESTED**
and then enter ``bitcoin-cli`` commands. When you are finished, simply type ``exit``...

49
site/source/support/user-manual/tuning/service-guides/lightning.rst
View File

@@ -13,13 +13,17 @@ Check out our `Getting Started with Lightning video <https://www.youtube.com/wat
BlueWallet
----------
Not compatible at this time - LNDHub is required
.. note:: Not available at this time - LNDHub is required
.. _rtl:
Ride the Lightning
------------------
Available For
.............
- EmbassyOS
See the video at the top of this page for an intro to Lightning using RTL.
.. _spark:
@@ -27,37 +31,58 @@ See the video at the top of this page for an intro to Lightning using RTL.
Spark
-----
Android
iOS
.. note:: Compatible with C-Lightning only
To use a Spark client, you still need to have Spark installed on the Embassy. The Spark service on Embassy is both a server (background service) and a client (the web UI). Under Properties, there is a "Pairing URL". The first part of this is the server URL, and the end portion of it is the access key.
Available For
.............
- Android
- EmbassyOS
- iOS
To use a Spark client, you still need to have Spark installed on the Embassy. The Spark service on Embassy is both a server (background service) and a client (the :ref:`Web UI<web-ui>`). Under Properties, there is a "Pairing URL". The first part of this is the server URL, and the end portion of it is the access key.
.. _thunderhub:
Thunderhub
----------
Compatible with LND
Available For
.............
- EmbassyOS
Download from your Embassy's Marketplace and follow the included Instructions.
.. _zap:
Zap
---
Compatible with LND
Available For
.............
- Android
- iOS
.. note:: Compatible with LND only
#. Download from your device's application store.
#. Go to Settings and activate Tor.
#. Go to Add a Wallet and scan the LND REST connection QR code found in your Embassy's LND service page -> Properties.
.. _zeus:
Zeus
----
Android
iOS (Coming Soon)
Compatible with both C-Lightning and LND
Available For
.............
- Android
- iOS (Coming Soon)
C-Lightning
===========
...........
LND
===
...
Spark
.....

105
site/source/support/user-manual/tuning/service-guides/vaultwarden.rst
View File

@@ -4,11 +4,110 @@
Vaultwarden
===========
Guides
------
Vaultwarden Setup Guide and Integrations
----------------------------------------
.. note:: The version of Bitwarden server used on the Embassy is a fork called "Vaultwarden." Despite this, it still functions with several of the apps/integrations that are built for, and still named after, "Bitwarden." We apologize for any confusion this may cause.
Check out our `Vaultwarden video <https://www.youtube.com/watch?v=YcxxVHpm9j0>`_ for basic features and setup!
.. youtube:: YcxxVHpm9j0
See our full, updated `Vaultwarden Guide <https://github.com/Start9Labs/vaultwarden-wrapper/tree/master/docs/guides.md>`_ for detailed setup and third party integrations.
Vaultwarden Vault (WebUI)
=========================
1. First we will open up our Embassy and go to the Marketplace tab, select Vaultwarden, and install if you have not already done so.
2. After install, click Configure. A strong admin token has been securely created by your Embassy, but you may change it if you wish. This can also be changed later. Click save. Click start to run the service.
3. Next launch the Vaultwarden web interface. If you are connected to your Embassy on LAN, Vaultwarden will also launch on LAN. If you are connected over Tor, Vaultwarden will lanuch on Tor. What you are looking at now is your very own Vaultwarden website, served right from your Embassy. Let's create an account. Please note, you are creating an account with yourself on your own Vaultwarden website served from your own Vaultwarden server, there are no third parties involved here. Enter an email for logging in, a strong password that you will remember, and optionally a password hint. It is important to realize that this is the 'Master password' for all your other passwords. Make it very strong, memorize it, write it down, and back it up to a safe place. If you lose it, you may lose access to all your passwords and your entire digital life.
Now you can log in to your new password manager!
4. We are greeted with our newly setup Vaultwarden password vault. At the top you can visit 'Tools' for reports, a password generator, and to import data from another program, such as lastpass, onepass, or keepass. 'Settings' gives you all your options, including the ability to set up 2 factor authorization.
5. Back at the main page for your vault, let's do a quick example login. We can setup a new folder here and save new login. For our example, we're going to use our FileBrowser instance. So click 'Add item,' then we'll fill in some test information. A name for the entry, a username, password, and the website we want to log in to. Then click 'Save.'
Bitwarden Browser Extension
===========================
The Bitwarden browser extension will only work with Tor browser or Firefox, since those are the only two browsers capable of using Tor, or in other words, access .onion URLs. Brave Browser can also access .onion URLs, but only in special tabs, not in extension, so the Bitwarden extension will not work on Brave.
1. If you choose Tor Browser, everything will just work right out of the box. If you choose Firefox, you will need to configure both your :ref:`device <tor-os>` and :ref:`Firefox <tor-firefox>` to use Tor.
2. In this example we will use Firefox. First, install the `Bitwarden browser extension <https://addons.mozilla.org/en-US/firefox/addon/bitwarden-password-manager/>`_. Once installed, click on the extension and click 'Settings' in the top left. Under 'Self-hosted environment,' you will see a field for 'Server URL,'. Here, we need to paste in our Vaultwarden Tor address. Go to your Embassy and copy you Vaultwarden Tor address, then return to the Bitwarden extension and paste it in, prefixed by ``http://``. Please note, you must use in ``http``, not ``https``. Click 'Save.'
3. Now you can click on the extension again, click 'Log In,' and enter your credentials. That's it, the extension is all set up!
Mobile Apps
===========
Android
.......
You will need to :ref:`Setup Tor <tor-android>` on your device first.
#. Visit your app store of choice and download the Bitwarden app. Once downloaded and installed, let's go into Orbot, and add the app to the VPN apps list. You may need to hit the refresh button in the top left to get it to populate.
#. Next, enter the Bitwarden app. You'll be greeted with a log-in screen, and just like in the extension, you can go to the top left gear icon to enter the Settings. You'll need to enter your LAN address from your Embassy, so you can copy-paste it over to your phone, or type it in by hand. Don't forget to ensure the prefix is ``http://`` and NOT ``https://``. Hit save, and you'll be returned to the log-in screen.
#. Go ahead and tap 'Log In,' enter your credentials, and you can access your Bitwarden app / Vaultwarden server.
iOS
...
Unfortunately, the iOS app does not support Tor, so currently the Bitwarden app can only be synced on LAN. Once synced, your app and passwords will be cached and available when you are on the go, and you will only need to be on LAN to update any edits to your vault.
You will need to :ref:`Setup LAN <lan-ios>` on your device first.
#. Visit your app store and download the Bitwarden app.
#. Next, enter the Bitwarden app. You'll be greeted with a log-in screen, and just like in the extension, you can go to the top left gear icon to enter the Settings. You'll need to enter your LAN address from your Embassy, so you can copy-paste it over to your phone, or type it in by hand. Don't forget to ensure the prefix is ``https://``. Hit save, and you'll be returned to the log-in screen.
#. Go ahead and tap 'Log In,' enter your credentials, and you can access your Bitwarden app / Vaultwarden server.
Desktop Apps
============
The desktop app is a bit more finicky, and arguably much less useful than the mobile and browser solutions, but below are the known good (tested) configurations if you'd like to use it.
Linux
.....
First, be sure to :ref:`Setup Tor <tor-linux>` natively.
#. Download the `Bitwarden Desktop app <https://bitwarden.com/download/>`_. Depending on your Linux distribution and preference, you may want the AppImage, Deb, Snap, etc. You can also check your favorite package manager.
#. Run the program with the flag ` --proxy-server=socks5://127.0.0.1:9050` behind it. You can run this from a terminal, and if you'd like to use a shortcut, edit that shortcut file to include the flag.
#. As with the other solutions above, click the 'Settings' icon, and enter your Vaultwarden Tor address. You can then log in to your vault.
Alternatively, you may be able to run using your LAN address, but this has proven finicky, especially on Debian/Ubuntu systems. You will have better luck if you have the Root CA installed at the OS level. First, be sure to :ref:`Setup LAN <lan-linux>` natively.
Mac
...
#. Download the `Bitwarden Desktop app <https://bitwarden.com/download/>`_.
#. LAN
#. First, be sure to :ref:`Setup LAN <lan-mac>` natively.
#. For LAN access, follow the LAN setup in the instructions below. After completing setup, simply open Bitwarden and add your LAN address in the 'Settings' and login.
#. Tor
#. First, be sure to :ref:`Setup Tor <tor-mac>` natively.
#. Run the program with the flag ` --proxy-server=socks5://127.0.0.1:9050` behind it. You can run this from a terminal, and if you'd like to use a shortcut, edit that shortcut file to include the flag.
#. You can now log in to your vault.
Windows
.......
#. Download the `Bitwarden Desktop app <https://bitwarden.com/download/>`_.
#. Follow the Tor setup in the instructions below. Make sure the Bitwarden directory is located in your user's directory (C:\Users\YOURUSER\AppData\Local\Bitwarden). This is because you need permission to run over a proxy. You can make a shortcut wherever you'd like.
#. Right-click the shortcut and click 'Properties.' Add the flag ` --proxy-server=socks5://127.0.0.1:9050` to the end of the 'Target' field. Click 'Apply,' then 'OK.' Close Properties and launch the shortcut.
#. As with the other solutions above, click the 'Settings' icon, and enter your Vaultwarden Tor address. You can then log in to your vault.

25
site/source/support/user-manual/walkthrough/error-logs.rst
View File

@@ -1,25 +0,0 @@
.. _error-logs:
===================
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.
Why do we ask for this?
-----------------------
The last thing Start9 wants is data that relates to users of EmbassyOS, but data that is generated within the system is *extremely* helpful for our engineers to stabilize and enhance the software.
What data is sent?
------------------
* Every log entry that is WARN or above, such as:
* Service crashes
* Failed updates
* Metadata, such as:
* What services are running
Data is catalogued with a random 64-bit integer that is generated upon creating a new :ref:`Session<sessions>`. Data cannot be correlated across sessions. This means that every time you create a new session, such as a browser log on, error logs are attached to that session *only*, and you can kill a session at any time (see :ref:`Active Sessions<active-sessions>`). These session ids are NOT used during support sessions (they are not even provided to the user), such that a support technician CAN NOT attach any kind of identity to a session or its logs.
How is data sent?
-----------------
These error logs are sent exclusively across Tor, and as such, we cannot even identify what machine, address, or user sent them.

1
site/source/support/user-manual/walkthrough/index.rst
View File

@@ -9,7 +9,6 @@ An overview of EmbassyOS general capabilities.
.. toctree::
:maxdepth: 2
error-logs
overview
updates
backups