mirror of
https://github.com/Start9Labs/documentation.git
synced 2026-03-26 10:21:53 +00:00
Build error fixes, link fixes, misc edits
This commit is contained in:
kn0wmad
@@ -4,7 +4,7 @@
|
||||
- [ ] Footer links need update (or removal?)
|
||||
- [ ] Add screenshots and details
|
||||
- [ ] Verify ALL links (especially in device guides as they are all external)
|
||||
- [ ] Check all menus behave and display as expected
|
||||
- [ ] Check all menus behave and display as expected (issues cut)
|
||||
- [ ] Verify all TOCs, etc
|
||||
- [ ] Add / verify ALL links in the **UI** go to the right place in docs
|
||||
- [ ] Update all guides in service repos
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
.. _decentralize:
|
||||
|
||||
============
|
||||
Decentralize - **ALT MARKET GUIDE NEEDS WRITTEN**
|
||||
Decentralize
|
||||
============
|
||||
|
||||
EmbassyOS allows users to swap to an alternative Marketplace in case they want a service not offered in the official `Start9 Marketplace <https://marketplace.start9.com>`_, would like a backup registry, or have for some reason lost trust in :ref:`Start9 <start9>`.
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
.. _service-container:
|
||||
.. _exec-service-container:
|
||||
|
||||
=========================
|
||||
Enter a Service Container
|
||||
|
||||
@@ -10,8 +10,8 @@ Developer Docs
|
||||
|
||||
dev-faq/index
|
||||
dev-tools/index
|
||||
service-packaging/index
|
||||
packaging-example
|
||||
service-packaging/index
|
||||
|
||||
.. panel-box::
|
||||
:title: Overview
|
||||
|
||||
@@ -39,7 +39,7 @@ How does the Embassy compare to other Bitcoin nodes or personal servers?
|
||||
The cheapest way to run a Bitcoin/Lightning node is to buy a Raspberry Pi (or equivalent), compile the software from source yourself, and host everything on Tor. This takes even technical people significant time to accomplish. On the other end of the spectrum is something like Embassy, which "just works". In between is stuff like MyNode, Nodl, RoninDojo, Umbrel, and Raspiblitz, which all require some degree of command line effort and network configuration. The biggest benefit of Embassy is that it is infinitely extensible to all of open-source, self-hosted software. The service listing will expand enormously over time in ways the other platforms may choose not to, or have difficulty implementing.
|
||||
|
||||
Would you consider (Umbrel, Nodl, RoninDojo, etc) a competitor to you guys, or are they different enough to be compatible?
|
||||
---------------------------------------------------------------------------------------------------------------------
|
||||
--------------------------------------------------------------------------------------------------------------------------
|
||||
Other node devices are competitors, and there are distinct trade-offs to each platform, but we are definitely moving toward the same future, which is a win for everyone!
|
||||
We are taking more a general approach to all of open-source, hosted software, including Bitcoin/Lightning. They are more Bitcoin/Lightning oriented.
|
||||
|
||||
@@ -57,7 +57,7 @@ No, you can not.
|
||||
|
||||
Does the Embassy only work over Tor? No http or VPN?
|
||||
----------------------------------------------------
|
||||
Embassy’s current primary communication is over Tor. In many cases we use HTTP over Tor (they are not mutually exclusive), you can see this by navigating to the Tor address in a browser and see the “http” in front of it. A VPN is a feature we’re exploring as an alternative to Tor to make things faster without meaningfully impacting privacy. You can also connect directly via LAN if you are on the same network as your device.
|
||||
Embassy's current primary communication is over Tor. In many cases we use HTTP over Tor (they are not mutually exclusive), you can see this by navigating to the Tor address in a browser and see the “http” in front of it. A VPN is a feature we’re exploring as an alternative to Tor to make things faster without meaningfully impacting privacy. You can also connect directly via LAN if you are on the same network as your device.
|
||||
|
||||
What if someone gets physical access to my device, can they read the contents? Is it encrypted?
|
||||
-----------------------------------------------------------------------------------------------
|
||||
|
||||
@@ -25,7 +25,7 @@ The following will guide you through the prerequisite configuration to backup to
|
||||
|
||||
#. Click ``Add the permissions automatically``
|
||||
|
||||
#. That's it! Now you can make encrypted backups to your own, private "cloud" by using the :ref:`Backup flow<backups>`` in the Embassy UI.
|
||||
#. That's it! Now you can make encrypted backups to your own, private "cloud" by using the :ref:`Backup flow<backups>` in the Embassy UI.
|
||||
|
||||
.. figure:: /_static/images/
|
||||
|
||||
|
||||
@@ -30,7 +30,7 @@ Mac
|
||||
|
||||
Open with "Keychain Access" and select "OK"
|
||||
|
||||
#. Enter your computer password when prompted. It will be imported into your computer’s keychain.
|
||||
#. Enter your computer password when prompted. It will be imported into your computer's keychain.
|
||||
|
||||
.. figure:: /_static/images/ssl/macos/certificate_untrusted.png
|
||||
:width: 90%
|
||||
@@ -62,4 +62,4 @@ Mac
|
||||
|
||||
Trusted Embassy Local CA certificate
|
||||
|
||||
#. Open your favorite browser to import this certificate and follow the steps for :ref:`browser setup <browser-setup>`.
|
||||
#. Open your favorite browser to import this certificate and follow the steps for :ref:`browser setup <lan-browser>`.
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
.. _torff-android:
|
||||
|
||||
=======
|
||||
Android - ***NEEDS UPDATED***
|
||||
Android
|
||||
=======
|
||||
|
||||
.. caution::
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
.. _device-guides:
|
||||
|
||||
======================
|
||||
Device-Specific Guides - ***NEED TO CHECK ALL LINKS AS THEY ARE NOT REFS (IN ORDER TO OPEN EXTERNALLY)***
|
||||
Device-Specific Guides
|
||||
======================
|
||||
|
||||
Guides to get connected with or improve your Embassy by device-type.
|
||||
|
||||
@@ -20,9 +20,9 @@ User Manual
|
||||
:id: "getting-started"
|
||||
:class: my-panel
|
||||
|
||||
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 hiccups with :doc:`Troubleshooting <troubleshooting/index>`.
|
||||
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 :ref:`Knowledge Base <knowledge-base>` to learn about the technologies behind Embassy, including Frequently Asked Questions. 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:`Developer Docs <dev-docs>`. 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,7 +1,7 @@
|
||||
.. _diy:
|
||||
|
||||
=========
|
||||
DIY Guide - ***CHECK BUILD GUIDE LINK WHEN ON MASTER, ADD PHOTOS OF HARDWARE SETUP***
|
||||
DIY Guide
|
||||
=========
|
||||
|
||||
.. figure:: /_static/images/diy/pi.png
|
||||
@@ -69,7 +69,7 @@ Depending on your Internet speed, the download should take between 5 and 30 minu
|
||||
Getting EmbassyOS: Building from Source
|
||||
.......................................
|
||||
|
||||
If you prefer to build EmbassyOS from source, you can do so following our guide `here <https://github.com/Start9Labs/embassy-os/tree/master/build>`_.
|
||||
If you prefer to build EmbassyOS from source, you can do so following our guide on the `Start9 GitHub <https://github.com/Start9Labs/embassy-os/tree/master/build>`_.
|
||||
|
||||
Installing EmbassyOS
|
||||
--------------------
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
.. _bitcoin:
|
||||
|
||||
=======
|
||||
Bitcoin - **NEED GUIDES WRITTEN (in bitcoind repo?)**
|
||||
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!
|
||||
|
||||
Reference in New Issue
Block a user