mirror of
https://github.com/Start9Labs/documentation.git
synced 2026-03-30 20:14:50 +00:00
fix up navigation
This commit is contained in:
@@ -0,0 +1,21 @@
|
||||
=======================
|
||||
Alternative Marketplace - ***NEEDS UPDATED***
|
||||
=======================
|
||||
|
||||
EmbassyOS supports accessing alternative marketplaces by configuring a system file. Start9 is not responsible for issues encountered by downloading services from alternative marketplaces.
|
||||
|
||||
After SSH-ing into the Embassy, run the following commands::
|
||||
|
||||
sudo systemctl stop agent
|
||||
sudo sh -c "echo '<alternative_marketplace_url>' > /root/agent/alt_registry_url.txt"
|
||||
sudo systemctl start agent
|
||||
|
||||
The Embassy is now able to connect to the provided alternative registry.
|
||||
|
||||
----
|
||||
|
||||
To revert this change, simply delete the file::
|
||||
|
||||
sudo systemctl stop agent
|
||||
sudo rm /root/agent/alt_registry_url.txt
|
||||
sudo systemctl start agent
|
||||
11
site/source/user-manual/tuning/advanced-config/index.rst
Normal file
11
site/source/user-manual/tuning/advanced-config/index.rst
Normal file
@@ -0,0 +1,11 @@
|
||||
======================
|
||||
Advanced Configuration
|
||||
======================
|
||||
|
||||
Custom options for folks that "know what they're doing."
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
ssh-setup
|
||||
alt-marketplace
|
||||
22
site/source/user-manual/tuning/advanced-config/ssh-setup.rst
Normal file
22
site/source/user-manual/tuning/advanced-config/ssh-setup.rst
Normal file
@@ -0,0 +1,22 @@
|
||||
.. _ssh-setup:
|
||||
|
||||
=========
|
||||
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.
|
||||
|
||||
Connecting via CLI
|
||||
------------------
|
||||
|
||||
#. Navigate to *Developer Options > SSH Keys*
|
||||
#. Click the ``+`` button in the lower right hand corner.
|
||||
#. Paste in your SSH key.
|
||||
#. You can now access your Embassy from the command line using::
|
||||
|
||||
ssh pi@<LAN URL>
|
||||
|
||||
Connecting via SSH on Windows, using PuTTY
|
||||
------------------------------------------
|
||||
|
||||
One of our community members, @brewsbitcoin, has put together this guide for connecting via PuTTY on Windows: https://medium.com/@brewsbitcoin/ssh-to-start9-embassy-from-windows-4a4e17891b5a
|
||||
93
site/source/user-manual/tuning/diy.rst
Normal file
93
site/source/user-manual/tuning/diy.rst
Normal file
@@ -0,0 +1,93 @@
|
||||
.. _diy:
|
||||
|
||||
=========
|
||||
DIY Guide
|
||||
=========
|
||||
|
||||
.. figure:: /_static/images/diy/pi.png
|
||||
:width: 40%
|
||||
:alt: Raspberry Pi
|
||||
|
||||
Raspberry Pi Board
|
||||
|
||||
By popular demand, we are pleased to present this "Do it Yourself" (DIY) guide for the Start9 Embassy personal server!
|
||||
|
||||
Motivation
|
||||
----------
|
||||
|
||||
There are four reasons you might prefer to build your own Embassy instead of purchasing one from us.
|
||||
|
||||
#. You already own the necessary hardware and would like to re-purpose it.
|
||||
|
||||
#. You live outside the US and want to save on shipping costs.
|
||||
|
||||
#. You do not trust Start9's supply chain.
|
||||
|
||||
#. You do not want to share your shipping address.
|
||||
|
||||
#. You just like building things.
|
||||
|
||||
Building an Embassy
|
||||
-------------------
|
||||
|
||||
Hardware: Components
|
||||
....................
|
||||
|
||||
#. `Raspberry Pi 4B (8GB) <https://raspberrypi.org/products/raspberry-pi-4-model-b/?variant=raspberry-pi-4-model-b-8gb>`_
|
||||
#. `Power supply for Raspberry Pi 4B <https://raspberrypi.org/products/type-c-power-supply/>`_ Make sure this is at minimum 15w and 3.5a.
|
||||
#. Case for Raspberry Pi 4B (`passive cooling recommended <https://www.amazon.com/Geekworm-Raspberry-Aluminum-Passive-Heatsink/dp/B07Z6FYHCH/>`_ `*`)
|
||||
#. A `16GB microSD card <https://amazon.com/SanDisk-Endurance-microSDXC-Adapter-Monitoring/dp/B07NY23WBG/>`_ (no need for bigger). If you have ABSOLUTELY NO data to migrate, you may choose to re-use the card already in your Embassy.
|
||||
#. `GPIO mini speaker/buzzer <https://www.amazon.com/Corporate-Computer-Motherboard-Internal-Speaker/dp/B01527H4W2/>`_ (These often sell out, please let us know if this link needs to be refreshed)
|
||||
#. Ethernet cable
|
||||
#. MicroSD → USB adapter (or you may have a microSD port on your computer)
|
||||
#. An external drive (1TB minimum, 2TB SSD recommended), or an `internal drive <https://www.amazon.com/Crucial-MX500-NAND-SATA-Internal/dp/B078211KBB>`_ with an `USB enclosure <https://www.amazon.com/gp/product/B07T9D8F6C>`_, as sold with our upgrade kits. MUST CONNECT OVER USB 3.0
|
||||
|
||||
`*` If you use a fan, **DO NOT** use the official Raspberry Pi fan, as it requires the same GPIO pins as the audio speaker. Instead, we recommend `this fan <https://www.amazon.com/Raspberry-iUniker-30x30x7mm-Brushless-RetroFlag/dp/B076H3TKBP/>`_.
|
||||
|
||||
Hardware: Assembly Instructions
|
||||
...............................
|
||||
|
||||
#. Insert mini speaker/buzzer into GPIO pins 6/8/10/12 with the word "speaker" facing out, `away from the board`.
|
||||
|
||||
.. figure:: /_static/images/diy/pins.png
|
||||
:width: 60%
|
||||
:alt: Speaker board spec
|
||||
|
||||
#. Place the Raspberry Pi 4 board (with speaker attached), into its case.
|
||||
#. Plug in the external drive to one of the USB 3.0 (blue) slots
|
||||
|
||||
Getting EmbassyOS
|
||||
-----------------
|
||||
|
||||
Getting EmbassyOS: Purchasing
|
||||
.............................
|
||||
|
||||
You can purchase EmbassyOS `here <https://store.start9.com/collections/embassy/products/embassyos-software-download>`_. This is by far the easiest path to get up and running.
|
||||
|
||||
Depending on your Internet speed, the download should take between 5 and 30 minutes.
|
||||
|
||||
Getting EmbassyOS: Building from Source
|
||||
.......................................
|
||||
|
||||
***Placehodler for build guide - either link to GH or duplicate here. Probably duplicate to keep all docs centralized to this repo - https://github.com/Start9Labs/embassy-os/tree/integration/0.3.0/build***
|
||||
|
||||
Installing EmbassyOS
|
||||
--------------------
|
||||
|
||||
Whether you purchase EmbassyOS from us or build it yourself, you need to flash it onto a microSD card.
|
||||
|
||||
#. Download `balenaEtcher <https://www.balena.io/etcher/>`_ onto your Mac, Windows, or Linux computer.
|
||||
#. Insert the microSD card into your computer, either directly or using an adapter.
|
||||
#. Open balenaEtcher.
|
||||
#. Click `Select Image`, then find and select your copy of EmbassyOS.
|
||||
#. Click `Select Target`, then find and select your micro SD card.
|
||||
#. Click `Flash!` You may be asked to (1) approve the unusually large disk target or (2) enter your password. Both are normal.
|
||||
|
||||
.. figure:: /_static/images/diy/balena.png
|
||||
:width: 60%
|
||||
:alt: Balena Etcher Dashboard
|
||||
|
||||
#. Once the image is flashed and verified, you may remove the micro SD, insert it into your Embassy, and power up the device.
|
||||
#. The Embassy is now ready for use, and you may following the normal :ref:`setup <initial-setup>` instructions. ``*``
|
||||
|
||||
``*`` The first time you power it on, your Embassy will make more noises than future attempts, and it may take several minutes to finally complete.
|
||||
15
site/source/user-manual/tuning/embassy-os.rst
Normal file
15
site/source/user-manual/tuning/embassy-os.rst
Normal file
@@ -0,0 +1,15 @@
|
||||
.. _tune-embassy-os:
|
||||
|
||||
=====================
|
||||
Customizing EmbassyOS
|
||||
=====================
|
||||
|
||||
Rename Device
|
||||
-------------
|
||||
|
||||
Duplicate in walkthrough, probably move to here
|
||||
|
||||
Reorder Service Page
|
||||
--------------------
|
||||
|
||||
Customize Services layout
|
||||
14
site/source/user-manual/tuning/index.rst
Normal file
14
site/source/user-manual/tuning/index.rst
Normal file
@@ -0,0 +1,14 @@
|
||||
======
|
||||
Tuning
|
||||
======
|
||||
|
||||
Here, you can customize your Embassy with advanced configuration, setup external tools, migrate from old projects, or build your own Embassy from scratch.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
diy
|
||||
migrating
|
||||
advanced-config/index
|
||||
embassy-os
|
||||
service-guides/index
|
||||
21
site/source/user-manual/tuning/migrating.rst
Normal file
21
site/source/user-manual/tuning/migrating.rst
Normal file
@@ -0,0 +1,21 @@
|
||||
.. _migrating:
|
||||
|
||||
====================
|
||||
Migrating To Embassy
|
||||
====================
|
||||
|
||||
From Umbrel
|
||||
-----------
|
||||
|
||||
Dreadlocked
|
||||
|
||||
======================
|
||||
Migrating From Embassy
|
||||
======================
|
||||
|
||||
We hate to see you go, but respect your freedom to choose. If you decide to use your hardware with different software, here are some guidelines.
|
||||
|
||||
.. warning:: For obvious reasons, we cannot officially support anything that happens when you leave the Embassy ecosystem
|
||||
|
||||
To Umbrel
|
||||
---------
|
||||
63
site/source/user-manual/tuning/service-guides/bitcoin.rst
Normal file
63
site/source/user-manual/tuning/service-guides/bitcoin.rst
Normal file
@@ -0,0 +1,63 @@
|
||||
.. _bitcoin:
|
||||
|
||||
=======
|
||||
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!
|
||||
|
||||
.. _bitcoin-cli:
|
||||
|
||||
Using Bitcoin-Cli
|
||||
-----------------
|
||||
|
||||
Instructions for accessing the bitcoind service in order to issue commands directly.
|
||||
|
||||
.. 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.
|
||||
|
||||
1. First, you will need SSH access. Please see the :ref:`setup instructions <ssh-setup>` for details.
|
||||
2. Access your Embassy and then you can interact with the bitcoind docker container using the following syntax::
|
||||
|
||||
sudo docker exec bitcoind bitcoin-cli COMMAND
|
||||
|
||||
.. admonition:: Example
|
||||
|
||||
sudo docker exec bitcoind bitcoin-cli getnetworkinfo
|
||||
|
||||
A list of possible commands can be found `here <https://chainquery.com/bitcoin-cli>`_.
|
||||
|
||||
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``.
|
||||
|
||||
.. _electrum:
|
||||
|
||||
Electrum
|
||||
--------
|
||||
|
||||
.. _fully-noded:
|
||||
|
||||
FullyNoded
|
||||
----------
|
||||
|
||||
.. _sparrow:
|
||||
|
||||
Sparrow
|
||||
-------
|
||||
|
||||
.. _specter:
|
||||
|
||||
Specter
|
||||
-------
|
||||
|
||||
.. _trezor:
|
||||
|
||||
Trezor
|
||||
------
|
||||
|
||||
.. _ledger:
|
||||
|
||||
Ledger Live
|
||||
-----------
|
||||
13
site/source/user-manual/tuning/service-guides/index.rst
Normal file
13
site/source/user-manual/tuning/service-guides/index.rst
Normal file
@@ -0,0 +1,13 @@
|
||||
=======================
|
||||
Service-Specific 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.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
vaultwarden
|
||||
matrix
|
||||
bitcoin
|
||||
lightning
|
||||
25
site/source/user-manual/tuning/service-guides/lightning.rst
Normal file
25
site/source/user-manual/tuning/service-guides/lightning.rst
Normal file
@@ -0,0 +1,25 @@
|
||||
.. _lightning:
|
||||
|
||||
=========
|
||||
Lightning
|
||||
=========
|
||||
|
||||
.. _rtl:
|
||||
|
||||
Ride the Lightning
|
||||
------------------
|
||||
|
||||
.. _thunderhub:
|
||||
|
||||
Thunderhub
|
||||
----------
|
||||
|
||||
.. _zap:
|
||||
|
||||
Zap
|
||||
---
|
||||
|
||||
.. _zeus:
|
||||
|
||||
Zeus
|
||||
----
|
||||
7
site/source/user-manual/tuning/service-guides/matrix.rst
Normal file
7
site/source/user-manual/tuning/service-guides/matrix.rst
Normal file
@@ -0,0 +1,7 @@
|
||||
.. _matrix:
|
||||
|
||||
======
|
||||
Matrix
|
||||
======
|
||||
|
||||
https://www.youtube.com/watch?v=PtwQsybFapo
|
||||
@@ -0,0 +1,7 @@
|
||||
.. _vaultwarden:
|
||||
|
||||
===========
|
||||
Vaultwarden
|
||||
===========
|
||||
|
||||
https://www.youtube.com/watch?v=YcxxVHpm9j0
|
||||
Reference in New Issue
Block a user