From 6d8fe7bf2029bd0c4c145a390808da38e25acb01 Mon Sep 17 00:00:00 2001 From: kn0wmad Date: Mon, 16 Aug 2021 12:45:11 -0600 Subject: [PATCH 1/8] Typo fix --- source/contributing/services/overview.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/contributing/services/overview.rst b/source/contributing/services/overview.rst index 978b1d8..dd4d9f3 100644 --- a/source/contributing/services/overview.rst +++ b/source/contributing/services/overview.rst @@ -67,7 +67,7 @@ This DSL is utilized in the :ref:`config rules ` and :ref:`depende Manifest -------- -This file describes the service and it's requirements. It is used to: +This file describes the service and its requirements. It is used to: - create a listing in the marketplace - denote any installation considerations From 5319022c412fb46a299c53a2c8495b6c9c00f2f0 Mon Sep 17 00:00:00 2001 From: kn0wmad Date: Mon, 16 Aug 2021 13:15:59 -0600 Subject: [PATCH 2/8] Typo fix 1 --- source/contributing/services/wrapper.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/contributing/services/wrapper.rst b/source/contributing/services/wrapper.rst index e4ebad3..c76d1f0 100644 --- a/source/contributing/services/wrapper.rst +++ b/source/contributing/services/wrapper.rst @@ -37,6 +37,6 @@ The project structure should be used as a model: Submodule ========== -`Git sub-modules `_ allow use of another project while in the working project directory. Setting up this feature enables linking of the source service repository so that it's context is available. +`Git sub-modules `_ allow use of another project while in the working project directory. Setting up this feature enables linking of the source service repository so that its context is available. Run ``git submodule add `` \ No newline at end of file From fa5afb87f9eeabb61dd048392597704d5b3119db Mon Sep 17 00:00:00 2001 From: kn0wmad Date: Mon, 16 Aug 2021 15:49:16 -0600 Subject: [PATCH 3/8] Typo fix 2 --- source/contributing/services/wrapper.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/contributing/services/wrapper.rst b/source/contributing/services/wrapper.rst index c76d1f0..aa84887 100644 --- a/source/contributing/services/wrapper.rst +++ b/source/contributing/services/wrapper.rst @@ -37,6 +37,6 @@ The project structure should be used as a model: Submodule ========== -`Git sub-modules `_ allow use of another project while in the working project directory. Setting up this feature enables linking of the source service repository so that its context is available. +`Git submodules `_ allow use of another project while in the working project directory. Setting up this feature enables linking of the source service repository so that its context is available. Run ``git submodule add `` \ No newline at end of file From dd41ec69cdfb116fa671c3e3d7be4e7e45de0eb1 Mon Sep 17 00:00:00 2001 From: kn0wmad Date: Thu, 2 Sep 2021 14:13:02 -0600 Subject: [PATCH 4/8] FAQ update --- source/support/FAQ/030-faq.rst | 2 +- source/support/FAQ/setup-faq.rst | 4 ++++ 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/source/support/FAQ/030-faq.rst b/source/support/FAQ/030-faq.rst index 38ec73c..e7db518 100644 --- a/source/support/FAQ/030-faq.rst +++ b/source/support/FAQ/030-faq.rst @@ -46,6 +46,6 @@ Yes, you may, and our original upgrade kits come with this style of drive. We h Can I re-use the SD Card from my Embassy for the new version? ------------------------------------------------------------- -ONLY if you have no data that you want to transfer. If you have existing files, Lightning channels, etc, then you will need to migrate to the new drive first. You can use the original 128GB card for other purposes, sell it, etc. +ONLY if you have no data that you want to transfer. If you have existing files, Lightning channels, etc, then you will need to migrate to the new drive first. Keep in mind that this SD card is major overkill for newer versions of EmbassyOS, which will only require a 16GB SD card. This is because all service and user data will be stored on external drives going forward. You can use the original 128GB card for other purposes, sell it, etc. ``*`` PLEASE FEEL FREE TO REACH OUT TO US WITH ANY QUESTIONS - THIS PROCESS WILL BE QUITE EASY AND WE ARE HERE TO HELP :) ``*`` diff --git a/source/support/FAQ/setup-faq.rst b/source/support/FAQ/setup-faq.rst index 6dffc5a..a7b847f 100644 --- a/source/support/FAQ/setup-faq.rst +++ b/source/support/FAQ/setup-faq.rst @@ -50,6 +50,10 @@ Why am I having trouble using my Embassy via the Brave browser? --------------------------------------------------------------- Unfortunately, Brave does not treat .onion addresses in a 'secure context.' This is a known issue in Brave that is being tracked `here `_. +I'm getting this error: The shell command "apt-get update" returned a failure exit code: 100. What do I do? +------------------------------------------------------------------------------------------------------------ +This has been fixed in newer updates. Please first make sure to update to the latest EOS version (2.16 or higher). If this does not work, please :ref:`contact us `. + Is it true that iOS has some limited functionality in regard to the Embassy? ---------------------------------------------------------------------------- The short answer is yes, but not much. Unfortunately, Apple does not allow any ability for Tor to run in the background (everything on the Embassy runs over Tor). Most of your Embassy services can be run with Tor-native apps, inside Consulate, or with another Tor browser, with the exception of RTL, Spark, and Matrix. Zap and Zeus wallets can be used in place of RTL/Spark, and we hope a Tor-native Element client will be available soon to allow for the use of Matrix. \ No newline at end of file From d1e37a4550aea8db1379de79eadaa9f9f8581091 Mon Sep 17 00:00:00 2001 From: kn0wmad Date: Fri, 3 Sep 2021 08:59:20 -0600 Subject: [PATCH 5/8] Dev FAQ initial commit --- source/support/FAQ/030-faq.rst | 2 ++ source/support/FAQ/bitcoin-faq.rst | 2 ++ source/support/FAQ/dev-faq.rst | 32 +++++++++++++++++++++++++++++ source/support/FAQ/embassy-faq.rst | 2 ++ source/support/FAQ/general-faq.rst | 2 ++ source/support/FAQ/index.rst | 1 + source/support/FAQ/services-faq.rst | 2 ++ source/support/FAQ/setup-faq.rst | 2 ++ source/support/FAQ/usage-faq.rst | 2 ++ 9 files changed, 47 insertions(+) create mode 100644 source/support/FAQ/dev-faq.rst diff --git a/source/support/FAQ/030-faq.rst b/source/support/FAQ/030-faq.rst index e7db518..ef1b90e 100644 --- a/source/support/FAQ/030-faq.rst +++ b/source/support/FAQ/030-faq.rst @@ -1,3 +1,5 @@ +.. _030_faq: + *********************** EmbassyOS Version 0.3.0 *********************** diff --git a/source/support/FAQ/bitcoin-faq.rst b/source/support/FAQ/bitcoin-faq.rst index e2142df..81969eb 100644 --- a/source/support/FAQ/bitcoin-faq.rst +++ b/source/support/FAQ/bitcoin-faq.rst @@ -1,3 +1,5 @@ +.. _bitcoin_faq: + ***************************** Bitcoin and Lightning Network ***************************** diff --git a/source/support/FAQ/dev-faq.rst b/source/support/FAQ/dev-faq.rst new file mode 100644 index 0000000..2e12113 --- /dev/null +++ b/source/support/FAQ/dev-faq.rst @@ -0,0 +1,32 @@ +.. _dev_faq: + +************************** +Contributing & Development +************************** + +What versions does this FAQ concern? +------------------------------------ +This FAQ concerns only EmbassyOS version 0.3.0 and above. For v0.2.x documentation, please see our :ref:`Service Packaging Guide `. + +What language does the application I want to package need to be written in? +--------------------------------------------------------------------------- +The application can be written in any language, so you may prefer to select an application in a language you are comfortable with (or write your own application). It is only important that the packaging specifications be followed. + +What considerations go into selecting an application to package? +---------------------------------------------------------------- +With sufficient effot, most any software with the ability to be self-hosted could make its way onto EmbassyOS. That being said, the following features will make service packaging much easier: + +- Already built with self-hosting in mind +- Active development +- Built-in tor support +- Already 'dockerized' + +Which possible formats can I use to write the :code:`manifest`, :code:`config_spec`, and :code:`config_rules` files? +------------------------------------------------------------------------------------------------------------------- +JSON, TOML, or YAML are valid options. + +I'm getting errors on the `embassy-sdk pack` step. What's going on? +-------------------------------------------------------------------- +There is something either missing or incorrect in regard to one of the :code:`manifest`, :code:`configs`, :code:`instructions`, or :code:`icon` files. + + diff --git a/source/support/FAQ/embassy-faq.rst b/source/support/FAQ/embassy-faq.rst index b529a03..9d12797 100644 --- a/source/support/FAQ/embassy-faq.rst +++ b/source/support/FAQ/embassy-faq.rst @@ -1,3 +1,5 @@ +.. _embassy_faq: + ***************************** Embassy (Device, OS, and DIY) ***************************** diff --git a/source/support/FAQ/general-faq.rst b/source/support/FAQ/general-faq.rst index 699f2dc..dce625d 100644 --- a/source/support/FAQ/general-faq.rst +++ b/source/support/FAQ/general-faq.rst @@ -1,3 +1,5 @@ +.. _general_faq: + ******* General ******* diff --git a/source/support/FAQ/index.rst b/source/support/FAQ/index.rst index 32d4c0f..2f3058b 100644 --- a/source/support/FAQ/index.rst +++ b/source/support/FAQ/index.rst @@ -14,3 +14,4 @@ A collection of common questions and concerns from our community. services-faq bitcoin-faq 030-faq + dev-faq diff --git a/source/support/FAQ/services-faq.rst b/source/support/FAQ/services-faq.rst index f3b3457..bd071d0 100644 --- a/source/support/FAQ/services-faq.rst +++ b/source/support/FAQ/services-faq.rst @@ -1,3 +1,5 @@ +.. _services_faq: + ******** Services ******** diff --git a/source/support/FAQ/setup-faq.rst b/source/support/FAQ/setup-faq.rst index a7b847f..889b0a5 100644 --- a/source/support/FAQ/setup-faq.rst +++ b/source/support/FAQ/setup-faq.rst @@ -1,3 +1,5 @@ +.. _setup_faq: + ************************* Setup and Troubleshooting ************************* diff --git a/source/support/FAQ/usage-faq.rst b/source/support/FAQ/usage-faq.rst index 00a3b4a..d2d0749 100644 --- a/source/support/FAQ/usage-faq.rst +++ b/source/support/FAQ/usage-faq.rst @@ -1,3 +1,5 @@ +.. _usage_faq: + *********** Basic Usage *********** From cd862fda8523b06c696e22b72b535d854bd8366a Mon Sep 17 00:00:00 2001 From: kn0wmad Date: Mon, 6 Sep 2021 10:52:06 -0600 Subject: [PATCH 6/8] Added 0.3.0 FAQs --- source/support/FAQ/030-faq.rst | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-) diff --git a/source/support/FAQ/030-faq.rst b/source/support/FAQ/030-faq.rst index ef1b90e..d1ea433 100644 --- a/source/support/FAQ/030-faq.rst +++ b/source/support/FAQ/030-faq.rst @@ -28,7 +28,7 @@ I would like to purchase my own hardware. What factors do I need to consider? ------------------------------------------------------------------------------ 1 - Please check the :ref:`DIY guide` for the necessary Raspberry Pi hardware. ``*`` (Skip this step if you already have an Embassy) ``*`` -2 - The most important piece of additional hardware is the external drive. It MUST have a USB 3.x connection (3.0, 3.1, etc are fine). You may use a HDD, an SSD, or an M.2 SSD / NVME. HDDs are cheaper, and the storage capacities can be much higher, however this is at a big performance sacrifice. SSDs are significantly faster (all services and user data will be stored on your external drive), and more generally more reliable than an HDD. This is what we recommend and sell with our official upgrade kits. An M.2 SSD is simply an SSD with a smaller form factor. An NVME SSD is even more preformat than an SSD, however that performance will not be accessible due to the USB bottleneck that the data must traverse to the Pi. Drives will range in price radically depending on what you choose. +2 - The most important piece of additional hardware is the external drive. It MUST have a USB 3.x connection (3.0, 3.1, etc are fine). You may use a HDD, an SSD, or an M.2 SSD / NVME. HDDs are cheaper, and the storage capacities can be much higher, however this is at a big performance sacrifice. SSDs are significantly faster (all services and user data will be stored on your external drive), and more generally more reliable than an HDD. This is what we strongly recommend and sell with our official upgrade kits. An M.2 SSD is simply an SSD with a smaller form factor. An NVME SSD is even more preformat than an SSD, however that performance will not be accessible due to the USB bottleneck that the data must traverse to the Pi. Drives will range in price radically depending on what you choose. If you are unsure what drive type is best for you, get an external SSD with a USB 3.0 connection, such as a Samsung T5. These are around $130USD for 1TB and around $240 for 2TB. @@ -38,16 +38,26 @@ What size drive do I need? -------------------------- This will depend on how you want to use your Embassy. We recommend a minimum of 1TB if you intend to run a pruned Bitcoin node, or no Bitcoin node at all, and a 2TB minimum if you intend to run a full archival node, which will add a lot more functionality. -If you intend to run your own "cloud", then consider the amount of data you are storing. If you have lots of video files, for example, you may start filling up the disk fairly quickly. Any service you are currently using should have a simple way for you to view your data usage. Make sure to leave room for expansion. +If you intend to run your own "cloud", then consider the amount of data you are storing. If you have lots of video files, for example, you may start filling up the disk fairly quickly. Any service you are currently using should have a simple way for you to view your data usage. Make sure to leave plenty of room for expansion. Finally, remember that you can always expand to a larger drive in the future. EOS will also be adding the ability to store on multiple drives, and other advanced storage features, in the near future. +I want to add an HDD later, in addition to my SSD, what are the performance consequences of doing this? +------------------------------------------------------------------------------------------------------- +After additional drive support is added (v0.3.x, no current ETA), we will recommend using uniform drives, but it will not be required. If you choose to add a lower performance HDD to an existing SSD in order to increase storage capacity, the reads and writes to the HDD will obviously be slower, but otherwise there will not be any issues. + +The reason we will recommend uniform drives is because we will be adding the ability to create redundancy (as an advanced feature), if you are interested. This will only be necessary if uptime is very important to you, such as when running a Lightning routing node, or serving a popular .onion site. Most users will find that a single drive, adding drives as space is needed, will suit their needs just fine. + Can I use an internal SSD with a USB 3 enclosure? I've heard these may have issues? ------------------------------------------------------------------------------------ Yes, you may, and our original upgrade kits come with this style of drive. We have addressed the known issues in software, and in the rare event of hardware failure, we are here to help. +Does my external drive need its own power supply? +------------------------------------------------- +This should not be necessary for a single drive and we are not selling external power with our kits. However, it will be advised to use a powered USB hub, or powered external drives, if you continue to add additional drives in the future. + Can I re-use the SD Card from my Embassy for the new version? ------------------------------------------------------------- ONLY if you have no data that you want to transfer. If you have existing files, Lightning channels, etc, then you will need to migrate to the new drive first. Keep in mind that this SD card is major overkill for newer versions of EmbassyOS, which will only require a 16GB SD card. This is because all service and user data will be stored on external drives going forward. You can use the original 128GB card for other purposes, sell it, etc. -``*`` PLEASE FEEL FREE TO REACH OUT TO US WITH ANY QUESTIONS - THIS PROCESS WILL BE QUITE EASY AND WE ARE HERE TO HELP :) ``*`` +``*`` PLEASE FEEL FREE TO REACH OUT TO US WITH ANY QUESTIONS - THIS PROCESS WILL BE STRAIGHTFORWARD AND WE ARE HERE TO HELP :) ``*`` From b1fb721621c918509ab42119ce4e1358ebf7d0d7 Mon Sep 17 00:00:00 2001 From: kn0wmad Date: Mon, 6 Sep 2021 10:56:09 -0600 Subject: [PATCH 7/8] Typo fix --- source/support/FAQ/030-faq.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/support/FAQ/030-faq.rst b/source/support/FAQ/030-faq.rst index d1ea433..6b84cf3 100644 --- a/source/support/FAQ/030-faq.rst +++ b/source/support/FAQ/030-faq.rst @@ -28,7 +28,7 @@ I would like to purchase my own hardware. What factors do I need to consider? ------------------------------------------------------------------------------ 1 - Please check the :ref:`DIY guide` for the necessary Raspberry Pi hardware. ``*`` (Skip this step if you already have an Embassy) ``*`` -2 - The most important piece of additional hardware is the external drive. It MUST have a USB 3.x connection (3.0, 3.1, etc are fine). You may use a HDD, an SSD, or an M.2 SSD / NVME. HDDs are cheaper, and the storage capacities can be much higher, however this is at a big performance sacrifice. SSDs are significantly faster (all services and user data will be stored on your external drive), and more generally more reliable than an HDD. This is what we strongly recommend and sell with our official upgrade kits. An M.2 SSD is simply an SSD with a smaller form factor. An NVME SSD is even more preformat than an SSD, however that performance will not be accessible due to the USB bottleneck that the data must traverse to the Pi. Drives will range in price radically depending on what you choose. +2 - The most important piece of additional hardware is the external drive. It MUST have a USB 3.x connection (3.0, 3.1, etc are fine). You may use a HDD, an SSD, or an M.2 SSD / NVME. HDDs are cheaper, and the storage capacities can be much higher, however this is at a big performance sacrifice. SSDs are significantly faster (all services and user data will be stored on your external drive), and more generally more reliable than an HDD. This is what we strongly recommend and sell with our official upgrade kits. An M.2 SSD is simply an SSD with a smaller form factor. An NVME SSD is even more performant than an SSD, however that performance will not be accessible due to the USB bottleneck that the data must traverse to the Pi. Drives will range in price radically depending on what you choose. If you are unsure what drive type is best for you, get an external SSD with a USB 3.0 connection, such as a Samsung T5. These are around $130USD for 1TB and around $240 for 2TB. From b926251c1d85edbaaca49ce047a77444c8786452 Mon Sep 17 00:00:00 2001 From: kn0wmad Date: Mon, 13 Sep 2021 10:03:23 -0600 Subject: [PATCH 8/8] Edits for powered USB hub --- source/support/FAQ/030-faq.rst | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/source/support/FAQ/030-faq.rst b/source/support/FAQ/030-faq.rst index 6b84cf3..b524696 100644 --- a/source/support/FAQ/030-faq.rst +++ b/source/support/FAQ/030-faq.rst @@ -34,6 +34,8 @@ If you are unsure what drive type is best for you, get an external SSD with a US 3 - For the SD card, any type will work, and 16GB is recommended. A larger card will not offer any benefit. These are $5-10USD. EmbassyOS will be stored on this card. +4 - For the powered USB hub, any kind will work as long as it has it's own power supply and is USB 3.0 capable. + What size drive do I need? -------------------------- This will depend on how you want to use your Embassy. We recommend a minimum of 1TB if you intend to run a pruned Bitcoin node, or no Bitcoin node at all, and a 2TB minimum if you intend to run a full archival node, which will add a lot more functionality. @@ -46,7 +48,7 @@ I want to add an HDD later, in addition to my SSD, what are the performance cons ------------------------------------------------------------------------------------------------------- After additional drive support is added (v0.3.x, no current ETA), we will recommend using uniform drives, but it will not be required. If you choose to add a lower performance HDD to an existing SSD in order to increase storage capacity, the reads and writes to the HDD will obviously be slower, but otherwise there will not be any issues. -The reason we will recommend uniform drives is because we will be adding the ability to create redundancy (as an advanced feature), if you are interested. This will only be necessary if uptime is very important to you, such as when running a Lightning routing node, or serving a popular .onion site. Most users will find that a single drive, adding drives as space is needed, will suit their needs just fine. +The reason we will recommend uniform drives is because we will be adding the ability to create redundancy (drive mirroring, as an advanced feature), if you are interested. This will only be necessary if uptime is very important to you, such as when running a Lightning routing node, or serving a popular .onion site. Most users will find that a single drive, adding drives as space is needed, will suit their needs just fine. Can I use an internal SSD with a USB 3 enclosure? I've heard these may have issues? ------------------------------------------------------------------------------------ @@ -54,7 +56,7 @@ Yes, you may, and our original upgrade kits come with this style of drive. We h Does my external drive need its own power supply? ------------------------------------------------- -This should not be necessary for a single drive and we are not selling external power with our kits. However, it will be advised to use a powered USB hub, or powered external drives, if you continue to add additional drives in the future. +We are recommending the use of a powered USB hub to connect drives with (and power the Pi if it has USB-C). However, you may use powered disk drives if you prefer. Can I re-use the SD Card from my Embassy for the new version? -------------------------------------------------------------