mirror of
https://github.com/Start9Labs/documentation.git
synced 2026-03-26 02:11:55 +00:00
fix links and references so no compilation errors
This commit is contained in:
Lucy Cifferello
@@ -28,7 +28,7 @@ If you purchase a device from us, this is printed on the bottom of your Embassy.
|
||||
|
||||
The first and foremost use of the Product Key is to encrypt data that is sent to Embassy at :ref:`Initial Setup<initial-setup>`. There are several other usecases. Start9 keeps an anonymous database of all Product Keys that have been purchased by us (ZERO additional data is associated) so that we can verify someone is a "paid user." Currently this is just to allow someone to get a new copy of the EOS image if they have a problem, but in future we intend to give added bonuses to customers who have chosen to pay us for a copy of the software.
|
||||
|
||||
.. _services:
|
||||
.. _services-eos:
|
||||
|
||||
Services
|
||||
--------
|
||||
|
||||
@@ -50,7 +50,7 @@ We decided to have the Embassy act as a Certificate Authority. It creates a self
|
||||
|
||||
When you setup SSL for your Embassy and device, the certificate communicates to the client (a browser) that the server (the Embassy) demonstrated ownership of the domain (the ``embassy-xxxxxxxx.local`` address) to the certificate authority (created on the Embassy) at the time of certificate issuance (during the setup process). The Embassy dashboard can then be accessed from a home network (LAN) using a secure HTTPS connection!
|
||||
|
||||
For more information on how to setup your devices to enable this feature visit :ref:`ssl-setup`.
|
||||
For more information on how to setup your devices to enable this feature visit :ref:`lan-setup`.
|
||||
|
||||
|
||||
.. _tor:
|
||||
@@ -81,4 +81,4 @@ Tor Hidden Service
|
||||
------------------
|
||||
A Tor Hidden Service is essentially just software or a website that is only broadcast on the Tor network. These are identified by a long, random public key, and end with the ``.onion`` suffix. For example, you can visit http://privacy34kn4ez3y3nijweec6w4g54i3g54sdv7r5mr6soma3w4begyd.onion to view the Start9 homepage on Tor.
|
||||
|
||||
In order to reach a Hidden Service, you must use a browser that can handle ``.onion`` domains, such as `The Tor Browser <https://www.torproject.org/download/>`_ or by configuring :ref:`Firefox <>` ***REF NEEDED***.
|
||||
In order to reach a Hidden Service, you must use a browser that can handle ``.onion`` domains, such as `The Tor Browser <https://www.torproject.org/download/>`_ or by configuring :ref:`Firefox <tor-firefox>`.
|
||||
|
||||
@@ -1,18 +0,0 @@
|
||||
.. _packaging-references:
|
||||
|
||||
====================
|
||||
Packaging References
|
||||
====================
|
||||
|
||||
Below are links to working examples of more advanced configurations for current Embassy services. They might serve as a starting point or reference during your development process:
|
||||
|
||||
TODO update links when merged to master
|
||||
|
||||
- Detailed `docker_entrypoint.sh` - `Filebrowser <https://github.com/Start9Labs/filebrowser-wrapper/blob/master/docker_entrypoint.sh>`_
|
||||
- Optional dependencies - `BTCPay Server <https://github.com/Start9Labs/btcpayserver-wrapper/blob/master/assets/compat/dependencies.yaml>`_
|
||||
- Config spec - `BTCPay Server <https://github.com/Start9Labs/btcpayserver-wrapper/blob/master/assets/compat/config_spec.yaml>`_
|
||||
- Config rules - `BTC RPC Proxy <https://github.com/Start9Labs/btc-rpc-proxy-wrapper/blob/master/assets/compat/config_rules.yaml>`_
|
||||
- Multiple dependencies - `BTCPay Server <https://github.com/Start9Labs/btcpayserver-wrapper/blob/master/manifest.yaml#L172-L187>`_
|
||||
- Actions - `BTCPay Server <https://github.com/Start9Labs/btcpayserver-wrapper/blob/master/actions/btcpay-admin.sh>`_
|
||||
- Health checks - `BTCPay Server <https://github.com/Start9Labs/btcpayserver-wrapper/blob/master/assets/utils/health_check.sh>`_
|
||||
- Alerts - `BTCPay Server <https://github.com/Start9Labs/btcpayserver-wrapper/blob/master/manifest.yaml#L207-L218>`_
|
||||
@@ -24,6 +24,8 @@ We recommend using the build in terminal as a command line interface (CLI) for y
|
||||
|
||||
If you are new to the command line, Ionic has published this awesome `guide <https://ionicframework.com/blog/new-to-the-command-line/>`_ to get you started.
|
||||
|
||||
.. _environment-setup-git:
|
||||
|
||||
Git
|
||||
===
|
||||
|
||||
@@ -50,11 +52,12 @@ Cargo
|
||||
|
||||
Cargo is the package management solution for the Rust programming language. It will install Rust to your system, and provide the required environment to build the Embassy SDK for packaging your service into the required format needed by EmbassyOS.
|
||||
|
||||
Installation instructions for Cargo can be found `here <https://doc.rust-lang.org/cargo/getting-started/installation.html>`_.
|
||||
Installation instructions for Cargo can be found `here <https://doc.rust-lang.org/cargo/getting-started/installation.html>`__.
|
||||
|
||||
To verify the installation, open a terminal window and run:
|
||||
|
||||
.. code:: bash
|
||||
|
||||
cargo --version
|
||||
|
||||
SDK
|
||||
@@ -84,10 +87,11 @@ While not strictly necessary, having a running instance of EmbassyOS is recommen
|
||||
You can acquire EmbassyOS by :ref:`purchasing <purchasing>` or following the :ref:`DIY guide <diy>`.
|
||||
|
||||
.. _quick-start:
|
||||
|
||||
Quick Start Environment Setup
|
||||
=============================
|
||||
- `Docker <https://docs.docker.com/get-docker>`_
|
||||
- `Docker buildx <https://docs.docker.com/buildx/working-with-buildx/>`_
|
||||
- `Cargo <https://doc.rust-lang.org/cargo/getting-started/installation.html>`_
|
||||
- `Cargo <https://doc.rust-lang.org/cargo/getting-started/installation.html>`__
|
||||
- `EmbassyOS <https://github.com/Start9Labs/embassy-os>`_
|
||||
- `Embassy SDK <https://github.com/Start9Labs/embassy-os/blob/master/backend/install-sdk.sh>`_
|
||||
@@ -1,4 +1,4 @@
|
||||
.. _service-config:
|
||||
.. _configuration:
|
||||
|
||||
=============
|
||||
Configuration
|
||||
|
||||
@@ -0,0 +1,7 @@
|
||||
.. _dependencies:
|
||||
|
||||
============
|
||||
Dependencies
|
||||
============
|
||||
|
||||
TODO
|
||||
@@ -10,13 +10,14 @@ The following guides provide an in depth overview of the full capabilities avail
|
||||
:hidden:
|
||||
|
||||
overview
|
||||
wrapper
|
||||
docker
|
||||
manifest
|
||||
emver
|
||||
docker
|
||||
makefile
|
||||
config
|
||||
properties
|
||||
instructions
|
||||
dependencies
|
||||
backups
|
||||
instructions
|
||||
wrapper
|
||||
makefile
|
||||
submission
|
||||
|
||||
@@ -352,9 +352,9 @@ Types for ``manifest.yaml`` fields: TODO check accuracy
|
||||
Examples
|
||||
========
|
||||
|
||||
- `filebrowser <>`_
|
||||
- `embassy-pages <>`_
|
||||
- `photoview <>`_
|
||||
- `btcpayserver <>`_
|
||||
- `lnd <>`_
|
||||
- `synapse <>`_
|
||||
- `Hello World <https://github.com/Start9Labs/hello-world-wrapper/blob/master/manifest.yaml>`__
|
||||
- `Filebrowser <https://github.com/Start9Labs/filebrowser-wrapper/blob/master/manifest.yaml>`__
|
||||
- `Embassy-pages <https://github.com/Start9Labs/embassy-pages-wrapper/blob/master/manifest.toml>`__
|
||||
- `Photoview <https://github.com/Start9Labs/embassyos-photoview-wrapper/blob/master/manifest.yaml>`__
|
||||
- `BTCPay Server <https://github.com/Start9Labs/btcpayserver-wrapper/blob/master/manifest.yaml>`__
|
||||
- `Synapse <https://github.com/Start9Labs/synapse-wrapper/blob/master/manifest.yaml>`__
|
||||
|
||||
@@ -42,7 +42,7 @@ Image
|
||||
|
||||
Each service boils down to a Docker image. We're not going to dive into Docker specifics in this guide, since there exists tons of `resources <https://docs.docker.com/>`_ for developing with this containerization tool.
|
||||
|
||||
Because the service ultimately runs on a Raspberry Pi, the created Docker image should be a snapshot of an arm based linux environment. The service image is then mounted to the EmbassyOS image during installation. This path is defined in the :ref:`manifest <service-manifest>` configuration file.
|
||||
Because the service ultimately runs on a Raspberry Pi, the created Docker image should be a snapshot of an arm based linux environment. The service image is then mounted to the EmbassyOS image during installation. This path is defined in the :ref:`manifest <service_manifest>` configuration file.
|
||||
|
||||
The image is immutable, meaning that when the service is updated, the image is replaced with a completely new image containing the updated features.
|
||||
|
||||
@@ -98,7 +98,7 @@ The configuration and manifest files get bundled into the ``.s9pk`` package, whi
|
||||
Hello World Example
|
||||
===================
|
||||
|
||||
For reference, the `Hello world <https://github.com/Start9Labs/hello-world-wrapper>`_ repository should be used as an example. A project template can be cloned using the "Use this template" button in GitHub. For a detailed walkthrough of this example, please see the :ref:`Packaging Example<packaging-example>`.
|
||||
For reference, the `Hello World <https://github.com/Start9Labs/hello-world-wrapper>`__ repository should be used as an example. A project template can be cloned using the "Use this template" button in GitHub. For a detailed walkthrough of this example, please see the :ref:`Packaging Example <build-package-example>`.
|
||||
|
||||
|
||||
.. role:: raw-html(raw)
|
||||
|
||||
@@ -33,7 +33,7 @@ To get a general idea of what is required of an app, answer these questions:
|
||||
|
||||
If all answers are yes, then it can run on EmbassyOS.
|
||||
|
||||
Packing up a service for the Embassy does not require extensive development skills. If you are interested in doing do, please see our :ref:`Developer Docs<dev-docs>`.
|
||||
Packing up a service for the Embassy does not require extensive development skills. If you are interested in doing do, please see our :ref:`Service Packaging Overview <service-packaging>`.
|
||||
|
||||
We are aggressively moving away from service development in favor of a more community driven approach. Meaning you, an app development team, or anyone else on Earth, can bring the Service they want to an Embassy Marketplace. You don't need our permission.
|
||||
|
||||
@@ -96,4 +96,4 @@ By reading the descriptions in the link above, as well as doing some extra searc
|
||||
|
||||
We translated much of (but not all of) the tons of options into a clean and easy-to-use GUI with toggles, dropdowns, inputs, etc, which is what you're seeing in your config screen. If you notice the little "?" icons on the left of each option, clicking them will provide a brief description as to what the option does. Also, our config GUI restricts the possible values you can enter such that you don't accidentally crash Bitcoin. That said, be very careful about just randomly changing things, lest your node starts to behave strangely.
|
||||
|
||||
You can also check out our :ref:`Service Config Spec <service_config>` documentation for further details.
|
||||
You can also check out our :ref:`Service Config Spec <configuration>` documentation for further details.
|
||||
|
||||
@@ -27,4 +27,4 @@ Local Backups
|
||||
#. With Embassy powered down, plug in your external drive to the powered hub if you are using one, or directly into Embassy's available USB 3.0 (blue) slot if it is externally powered.
|
||||
#. Plug in power to your hub or drive
|
||||
#. Boot Embassy and go to ``Embassy`` -> ``Create Backup``
|
||||
#.
|
||||
|
||||
|
||||
@@ -27,4 +27,4 @@ Local Backups
|
||||
#. With Embassy powered down, plug in your external drive to the powered hub if you are using one, or directly into Embassy's available USB 3.0 (blue) slot if it is externally powered.
|
||||
#. Plug in power to your hub or drive
|
||||
#. Boot Embassy and go to ``Embassy`` -> ``Create Backup``
|
||||
#.
|
||||
|
||||
|
||||
@@ -49,4 +49,5 @@ Windows
|
||||
|
||||
#. Click ``OK`` and then restart Firefox for the changes to take effect.
|
||||
|
||||
#. You're all set! You should now be able to navigate to ``.onion`` URLs in Firefox. This means you can access tor-only service :ref:`WebUIs <web-ui>`, such as Cups Messenger, and use your :ref:`Vaultwarden<vaultwarden>` Tor address in the `Bitwarden Firefox Plugin <https://addons.mozilla.org/en-US/firefox/addon/bitwarden-password-manager/>`_. You can test this by going to Start9's ``.onion`` homepage, `here <http://privacy34kn4ez3y3nijweec6w4g54i3g54sdv7r5mr6soma3w4begyd.onion/>`_.
|
||||
#. You're all set! You should now be able to navigate to ``.onion`` URLs in Firefox. This means you can access tor-only service :ref:`WebUIs <web-ui>`, such as Cups Messenger, and use your :ref:`Vaultwarden<vaultwarden>` Tor address in the `Bitwarden Firefox Plugin <https://addons.mozilla.org/en-US/firefox/addon/bitwarden-password-manager/>`_. You can test this by going to Start9's ``.onion`` homepage, `here <http://privacy34kn4ez3y3nijweec6w4g54i3g54sdv7r5mr6soma3w4begyd.onion/>`__.
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@ Some apps, such as :ref:`Tor Browser<tor-browser>`, have Tor built in. They do n
|
||||
|
||||
.. youtube:: b__mVfN-BP8
|
||||
|
||||
Running Orbot
|
||||
Running Orbot
|
||||
-------------
|
||||
|
||||
Orbot is a system wide proxy for your Android device that enables communications over Tor.
|
||||
|
||||
@@ -22,7 +22,7 @@ User Manual
|
||||
|
||||
EmbassyOS is designed to work out of the box with a minimal setup and immediate practicality. That said, there are many use-cases and utilities that can be added and tweaked at your convenience, which are covered extensively in this manual. You can get started right away with :ref:`Initial Setup <initial-setup>`, head to our :doc:`Walkthrough <walkthrough/index>` for a guided tour, or learn about :doc:`Services <services/index>` and how to use them. In the :doc:`Configuration <configuration/index>` and :doc:`Tuning <tuning/index>` chapters, you can put your Embassy to work, and make it unique. Finally, you can cure common issues with :doc:`Troubleshooting <troubleshooting/index>` or find answers in our :ref:`FAQ<faq>`.
|
||||
|
||||
For further information, check out our :ref:`Knowledge Base <Learn>` to learn about the technologies behind Embassy. If you want to build your own Embassy, check out the :ref:`DIY Guide<diy>`. When you're ready to build, please check out our :ref:`Developer Docs <dev-docs>`. Please don't hestitate to :ref:`Contact Us <contact>` if you have any issues, questions, or suggestions.
|
||||
For further information, check out our :ref:`Knowledge Base <Learn>` to learn about the technologies behind Embassy. If you want to build your own Embassy, check out the :ref:`DIY Guide<diy>`. When you're ready to build, please check out our :ref:`Service Packaging Overview <service-packaging>`. Please don't hestitate to :ref:`Contact Us <contact>` if you have any issues, questions, or suggestions.
|
||||
|
||||
* :doc:`Getting Started <getting-started/index>` - Initial setup and device-specific guides to connect with your Embassy.
|
||||
* :doc:`Walkthrough <walkthrough/index>` - A guided tour of EmbassyOS.
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
.. _bitcoin:
|
||||
.. _bitcoin-service:
|
||||
|
||||
=======
|
||||
Bitcoin
|
||||
@@ -73,7 +73,7 @@ Available For
|
||||
|
||||
Instructions
|
||||
............
|
||||
Follow the `guide <https://github.com/start9labs/bitcoind-wrapper/docs/integrations/sparrow/guide.md>`_.
|
||||
Follow the `guide <https://github.com/start9labs/bitcoind-wrapper/docs/integrations/sparrow/guide.md>`__.
|
||||
|
||||
.. _specter:
|
||||
|
||||
@@ -88,7 +88,7 @@ Available For
|
||||
|
||||
Instructions
|
||||
............
|
||||
Follow the `guide <https://github.com/Start9Labs/bitcoind-wrapper/tree/master/docs/integrations/specter>`_.
|
||||
Follow the `guide <https://github.com/Start9Labs/bitcoind-wrapper/tree/master/docs/integrations/specter>`__.
|
||||
|
||||
.. _trezor-suite:
|
||||
|
||||
@@ -115,7 +115,7 @@ Instructions for accessing the bitcoind service in order to issue commands direc
|
||||
|
||||
.. tip:: For example ``sudo docker exec bitcoind bitcoin-cli getnetworkinfo``
|
||||
|
||||
A list of possible commands can be found `here <https://chainquery.com/bitcoin-cli>`_.
|
||||
A list of possible commands can be found `here <https://chainquery.com/bitcoin-cli>`__.
|
||||
|
||||
You can also drop into a shell using::
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@ Check out our `Getting Started with Lightning video <https://www.youtube.com/wat
|
||||
|
||||
.. youtube:: KhU_sTiaN8w
|
||||
|
||||
.. _blue-wallet::
|
||||
.. _blue-wallet-lightning:
|
||||
|
||||
BlueWallet
|
||||
----------
|
||||
|
||||
Reference in New Issue
Block a user