Update FAQ, correct c-lightning references to Core Lightning (#234)

* Update FAQ, correct c-lightning references to Core Lightning

* Add 2 or 3 things leftover from my other commit

* final touchups

Co-authored-by: gStart9 <george@start9labs.com>
This commit is contained in:
kn0wmad
2022-12-19 18:54:09 -07:00
committed by GitHub
parent d59e97f697
commit b5a681a556
11 changed files with 60 additions and 56 deletions

View File

@@ -128,7 +128,7 @@ Optional Dependencies
Configuring a service to have multiple optional dependencies is also possible. This can be done by defining a file that specifies the condition under which the dependency should become activated.
For example, in BTCPay Server's config, a user can select either LND or C-lightning as an internal lightning node implementation. To do this, we define the following file:
For example, in BTCPay Server's config, a user can select either LND or Core Lightning (CLN) as an internal lightning node implementation. To do this, we define the following file:
.. code:: yaml
@@ -136,7 +136,7 @@ For example, in BTCPay Server's config, a user can select either LND or C-lightn
condition: '''lightning.type = "lnd"'
health_checks: []
c-lightning:
condition: '''lightning.type = "c-lightning"'
condition: '''lightning.type = "core lightning"'
health_checks: []
This file gets passed in as an argument during BTCPay Server's config set function in its Manifest, shown `here <https://github.com/Start9Labs/btcpayserver-wrapper/blob/master/manifest.yaml#L86>`__.

View File

@@ -35,7 +35,7 @@ Yes, you can move the Embassy to another network. Your service tor addresses wi
What's the advantage of using the .local address over the .onion address?
-------------------------------------------------------------------------
If you are in your home/office network with an Embassy, it is both faster and more private since the connection never leaves your household/office. The downside is that it wont work if youre on the go.
If you are in your home/office network with an Embassy, it is both faster and more private since the connection never leaves your household/office. The downside is that it won't work if you're on the go.
Can I use the .local addresses over the Tor Browser?
----------------------------------------------------
@@ -43,13 +43,13 @@ No. The Tor Browser requires all web visits to first enter the Tor network. Once
Can I use .local addresses on Android?
--------------------------------------
This will depend on your Android device. This support was added in Android 12, but may not yet be added to custom ROMs, such as Calyx, Graphene, or Lineage. Please see :ref:`Android Limitations<lim-android>` for more deatils.
This will depend on your Android device. This support was added in Android 12. For custom ROMs, such as Calyx and Graphene, version 13 is required.
Can I have multiple users on my Embassy?
----------------------------------------
Currently, the Embassy itself is designed for a single user. There is no way to grant others access to your Embassy without sharing your personal, master password, which is not recommended. There are certain services, however, such as Bitwarden, File Browser, and Mastodon, that do support multiple users (aka multi-tenancy, aka the Uncle Jim model) where people who trust you (and vice versa) can create their own, personal accounts for these services on your Embassy. Just remind them that they are trusting you with their data, and that it might be preferable for them to take the final leap of self-sovereignty and get an Embassy of their own.
Multi-tenancy is a high priority for the upcoming Embassy:Pro device.
Multi-tenancy is a desired future OS feature. Stay tuned.
What can I do if I am having issues connecting to a mobile app over Tor?
------------------------------------------------------------------------
@@ -81,8 +81,8 @@ Why would I even buy this when I can just build it for free?
Bottom line...We are charging a very marginal rate for something incredibly powerful, and we think the convenience of a plug-and-play device, free service marketplace, and free white glove support is where the money is. Anyone could build their own couches too, but here is a reason furniture stores exist. How much is your time worth?
The fastest way to get support is via our :ref:`Community channels<contact>`. You can also `email us <support@start9.com>`_. Please do not hesitate to reach out!
The fastest way to get support is via our :ref:`Community channels<contact>`. Please do not hesitate to reach out!
I bought an Embassy before Q3 2022 and it came with a 'product key,' what is that?
----------------------------------------------------------------------------------
This will entitle you to white glove support as well as future benefits yet to be announced.
This will entitle you to white glove support as well as future benefits yet to be announced. Newer products ship with a similar (anonymous) key for these purposes.

View File

@@ -18,7 +18,7 @@ You can learn more about the Initial Block Download in `this video <https://www.
Can the IBD (Initial Block Download) be made faster? Or can wait times be improved?
------------------------------------------------------------------------------------
IBD was made significantly faster with the new hardware scheme of version 0.3.0 and up. Going forward the only way to improve IBD speeds will be on more powerful hardware, such as the upcoming Embassy:Pro.
IBD was made significantly faster with the new hardware scheme of version 0.3.0 and up. Going forward the only way to improve IBD speeds will be on more powerful hardware, such as Embassy Pro.
Does the Embassy run a full archival Bitcoin node or a pruned one?
------------------------------------------------------------------
@@ -41,8 +41,9 @@ At present, the Embassy does not offer its own node visualization tool. You can
Is a wallet vulnerable to hacking if it's always online??
---------------------------------------------------------
Funds are not stored on the node typically. The node simply serves as a source of truth for the state of the blockchain. Attacks depend on where the keys are and where the signing happens. You can use something like a hardware wallet for better security. Though, to be fair, a lot of attacks depend on you or your machine being targeted specifically, and a whole bunch of attack vectors are highly theoretical and obscure.
Most successful attacks seem to be either fake/doctored software or a social attack (tricking you into installing some malware or giving your seed outright or something like that).
Keep in mind, however, the more value there is out there to steal, the more sophisticated attacks will get automated (bots, crawlers etc). So its not just the risk profile of today, but also tomorrow you have to consider. Thats why something like a hardware wallet or dedicated mobile device for key signing is a good idea.
Keep in mind, however, the more value there is out there to steal, the more sophisticated attacks will get automated (bots, crawlers etc). So its not just the risk profile of today, but also tomorrow you have to consider. That's why something like a hardware wallet or dedicated mobile device for key signing is a good idea.
Even if your wallet is plugged into your Embassy, whether your wallet is hot or cold depends on the hardware that stores the keys.
How does Bitcoin Proxy request (and verify) data when that data is needed by some app using it?
@@ -62,10 +63,6 @@ Which wallets can I use that sync with my Embassy Bitcoin and/or Lightning nodes
---------------------------------------------------------------------------------
Please see the :ref:`Bitcoin Service Guides<bitcoin-service>` for all the current options.
Is BlueWallet an option?
------------------------
BlueWallet requires a separate backend service called LNDHub, which is not available on the Embassy at this time.
I want to use my hardware signer, such as Coldcard or Trezor, with my Embassy. How does this work?
---------------------------------------------------------------------------------------------------
You do not use hardware signers directly with your node. Hardware signers interface with wallets, and wallets interface with nodes.

View File

@@ -10,7 +10,7 @@ Embassy FAQ
Can I run embassyOS on a VPS or VM?
-----------------------------------
Possibly, but we currently advise against this. It is designed to be used on a RaspberryPi, and at the moment this is the only supported way to run eOS.
Yes! The :ref:`DIY Guide <diy>` will take you through the setup steps.
Is it possible to use embassyOS on my own hardware?
---------------------------------------------------
@@ -24,7 +24,7 @@ No. Your Embassy only needs to be plugged into power and internet, just like yo
Do I plug in a monitor, keyboard, and mouse?
--------------------------------------------
No. Embassy is headless (has no display), and is accessed via the web browser.
Typically, no. It is not necessary or recommended to do this as embassyOS runs in "headless" mode - meaning that you will access it from your computer or mobile device. However, we have recently added "Kiosk Mode," which allows the installation (and use) of embassyOS with a monitor/keyboard/mouse. For directions on setting this up, please check out the :ref:`x86 DIY Guide <x86-diy>`.
How much storage does Embassy have?
-----------------------------------
@@ -43,13 +43,24 @@ Can multiple Embassies be setup to run redundantly in physically separate locati
Currently no, but we have plans for a feature that will enable Embassies to provide encrypted, automated backup services for one another.
How does 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.
--------------------------------------------------------------------
The cheapest way to run a Bitcoin/Lightning node is to buy a Raspberry Pi (or equivalent), download or compile embassyOS for free, 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 Embassy, 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. The aforementioned examples tend to be more Bitcoin/Lightning focused.
One difference with Start9 is that we began with a plan to create an OS for general-purpose sovereign hosting of server-side software. No other project in the space (that we know of) started this way. There's also no reason you can't use more than one device. As an example, some users prefer Embassy for their data and RoninDojo for their Bitcoin stack.
Some other things that embassyOS offers that others do not:
- Graphical configuration of services (instead of command line)
- System backups (pretty important)
- Encrypted connection over the home network (https)
- Health Checks for quick-glance understanding of the status of your services
- Unique user experiences created by service-packagers, including "Actions" (custom commands at the click of a button!)
From an architectural perspective, embassyOS is a true operating system, giving you the ability to understand and control what is going on. Many other systems are black boxes offering little insight or agency to you. If something goes wrong, you'll have to put in your engineer hat and go command line diving. Lastly, our team is very responsive and helpful. We pride ourselves on providing incredible customer support.
Since it is often requested, we have put together an :ref:`Umbrel comparison guide<umbrel-compare>`
@@ -59,17 +70,9 @@ We've created a guide to help you `transform your Umbrel's bitcoin stack into an
Alternatively, if you have an Umbrel and an Embassy and they're on the same network, you can just select *Services > Lightning Network Daemon > Actions > Import from Umbrel* in your Embassy's web interface and your LND settings and channels will be automatically migrated.
Is a more powerful device in the works??
----------------------------------------
Yes, we are now taking `pre-orders <https://store.start9.com/products/embassy-2>`_ for Embassy Pro, which will be the new standard in personal servers! Additionally, embassyOS will eventually be capable of running on lots of different hardware, such as an old desktop. We want embassyOS to be widely available and accessible.
Is there an ETA on the Embassy Pro release date?
------------------------------------------------
R&D is in progress, and we have already secured the hardware. We anticipate shipping in Q3 2022. Check our :ref:`Community Channels<contact>` for the latest updates.
Can I mine Bitcoin with this?
-----------------------------
No, you can not.
You do **not** want to do that.
Does Embassy only work over Tor? No http or VPN?
-------------------------------------------------
@@ -77,7 +80,7 @@ Embassy's current primary communication is over Tor. In many cases we use HTTP o
What if someone gets physical access to my device, can they read the contents? Is it encrypted?
-----------------------------------------------------------------------------------------------
The data is currently encrypted at rest, but not in a way that would prevent a sophisticated attacker from accessing it. This is a step towards better security in the near future.
The data is currently encrypted at rest, but not in a way that would prevent a sophisticated attacker from accessing it. This is a step towards better security in the near future. At-rest encryption on servers is a serious challenge, because of the need for remote availability. For example, you may not be at home to enter an encryption password following a power outage, leaving you without access to your server.
Services like Bitwarden, however, do not store plaintext information, so your passwords will not be compromised unless they know your master password.

View File

@@ -8,13 +8,13 @@ General FAQ
:depth: 2
:local:
What is Start9Labs?
-------------------
Start9Labs is a small, but quickly growing group of builders based in Denver, CO that build Embassy and embassyOS.
What is the Embassy?
What is Start9 Labs?
--------------------
Embassy is a "shelf-top" personal server built using a `Raspberry Pi <https://www.raspberrypi.org/products/raspberry-pi-4-model-b/>`_ for hardware and running embassyOS software.
Start9 Labs is a small, but quickly growing group of builders based in Denver, CO (with a global team) that build Embassy and embassyOS.
What is Embassy?
----------------
Embassy is a "shelf-top" personal server running embassyOS software.
The internet as we know it is organized into questioners, or clients, and answerers, or servers. When you open a mobile email app, say Gmail, the app (client) begins asking questions: "have I received new mail?", "what are my last 50 messages?", "what drafts am I in the midst of writing?", and so on. Your app's questions are sent to and heard by a Google-run server which then provides answers back to the client and are subsequently displayed to the screen.
@@ -39,11 +39,9 @@ This `podcast <https://www.youtube.com/watch?v=aylDowaSdzU>`_ may help expound u
How does Embassy work?
----------------------
The current model Embassy runs on Raspberry Pi 4B hardware with a Cortex-a72 CPU, 8GB of RAM, has 2.4ghz and 5.0ghz IEEE 802.11AC wireless capabilities, an internal speaker for audio feedback of system operations, and an external SSD. It also features a high endurance MicroSD card, on which the operating system software is installed.
embassyOS (see next question) is based on Linux and handles all operations of your Embassy device. This core element of the technology stack is what enables you to set up, login, access your Embassy's dashboard, and install services.
embassyOS is based on Ubuntu Server and handles all operations of your Embassy device. This core element of the technology stack is what enables you to set up, login, access your Embassys dashboard, and install services.
One of these operations is creating and managing Tor addresses, which are uniquely attributed to each service you download, as well as to the Embassy device itself. You can see your uniquely generated Tor address when you complete the setup process using the Setup App. This address is how you view your Embassys dashboard, which is actually just a website served up from your Embassy itself! It is authenticated, of course, so only you can access it.
One of these operations is creating and managing Tor addresses, which are uniquely attributed to each service you download, as well as to the Embassy device itself. You can see your uniquely generated Tor address when you complete the setup process using the Setup App. This address is how you view your Embassy's dashboard, which is actually just a website served up from your Embassy itself! It is authenticated, of course, so only you can access it.
You can connect to and manage your Embassy from any mobile device, desktop computer, or laptop computer. This is accomplished right through the browser by visiting your Embassy's private and unique URL.
@@ -53,9 +51,9 @@ The list of services will grow rapidly over the coming months and years, such th
What is embassyOS?
------------------
embassyOS is a new kind of Operating System (OS). It is built from the ground up to allow anyone to easily run their own "cloud," become independent from Big Tech, and own their own data. embassyOS allows anyone to easily host their own software services.
embassyOS is a new kind of Operating System (OS). It is a built from the ground up to allow anyone to easily run their own "cloud," become independent from Big Tech, and own their own data. embassyOS allows anyone to easily host their own software services.
embassyOS is a custom-built Linux distribution, which is a beefed up version of `Raspberry Pi OS <https://www.raspberrypi.com/software/operating-systems/>`_, along with a suite of software tools which make it easy to:
embassyOS is custom-built Linux distribution with a suite of software tools which make it easy to:
* Install, uninstall, and upgrade services from a Marketplace (similar to your phone's app store)
* Manage and run services that YOU own and control
@@ -70,7 +68,7 @@ It includes:
* an SDK for developers, including an "Actions" API to simplify complex operations for the common user
* and much, much more. Please see the corresponding :ref:`Concepts<embassy-os>` section.
The .s9pk extension is Start9's custom package format based on tar. It encompasses the necessary components to compress, host, and install a service on a Marketplace.
The `.s9pk` extension is Start9's custom package format based on `tar`. It encompasses the necessary components to compress, host, and install a service on a Marketplace registry.
What are embassyOS Services?
----------------------------
@@ -78,7 +76,7 @@ A Service can be any piece of software added to the Marketplace. Unlike "apps,"
Does the Embassy ship worldwide?
--------------------------------
No. We ship everywhere that DHL ships, with the unfortunate exception of Europe, where the VAT and Customs are so ridiculous that they cost as much as Embassy itself or more. Please consider buying your hardware locally, and purchasing embassyOS as a download from us instead. Please see the :ref:`DIY<diy>` page for details.
We ship everywhere that DHL ships. Please consider that in some countries, the VAT and Customs fees are so ridiculous that they cost as much as Embassy itself or more. You may wish to consider buying your hardware locally and building your own device, downloading embassyOS from our github, and `donating<https://donate.start9.com/>`_ to us. Please see the :ref:`DIY<diy>` page for details.
Does the Embassy have international electrical plugs?
-----------------------------------------------------
@@ -117,6 +115,8 @@ Embassy device sales are processed through Shopify, which we do not like, but it
In summary: (1) the shipping data we currently have is stored in Shopify (2) we are asking Shopify to delete all our customer data (3) we will be migrating off of Shopify (4) going forward, we alone will control customer data and will purge it regularly (5) you can always assemble the hardware yourself and just download embassyOS for free.
We are currently working on a better solution.
I want to help, but I'm not a developer. Are there any ways for non-coders to contribute?
------------------------------------------------------------------------------------------
1. Shill it to everyone and create awareness

View File

@@ -38,17 +38,17 @@ Is there a solution to this?
----------------------------
Yes, the concept of a Watchtower was originally conceptualized in the LN whitepaper. A Watchtower is simply a lightning node to which you can give the authority to monitor transactions associated with your open payment channels.
Is it possible to run c-lightning and lnd parallel on the Embassy?
------------------------------------------------------------------
Is it possible to run Core Lightning and LND in parallel on Embassy?
--------------------------------------------------------------------
Yes, you may run both. They will operate in their own environments and allow you to run services that depend on either.
How do I connect my Lightning wallet or mobile app to my Embassy?
-----------------------------------------------------------------
Please see the :ref:`Lightning Service Guides<lightning-service>` section for more details.
Are my addresses, channels, and balances all stored in LND or in RTL? C-Lightning or Spark, etc?
-------------------------------------------------------------------------------------------------
This is all on LND, including on-chain funds, and RTL (or ThunderhHub, Zap, etc) is just a GUI for accessing LND. Same for C-Lightning, it contains all funds, channels, etc, and Spark, Zeus, etc are just GUIs to interface with the node.
Are my addresses, channels, and balances all stored in LND or in RTL? Core Lightning or Spark, etc?
----------------------------------------------------------------------------------------------------
This is all on LND, including on-chain funds, and RTL (or ThunderhHub, Zap, etc) is just a GUI for accessing LND. Same for Core Lightning, it contains all funds, channels, etc, and Spark, Zeus, etc are just GUIs to interface with the node.
How do I find my LND seed so I can write it down to backup?
-----------------------------------------------------------

View File

@@ -96,6 +96,8 @@ I don't see an answer to my question regarding a certain service. Is there more
-----------------------------------------------------------------------------------------------
While we are intent on providing the most friendly experience possible to our customers, ultimately it will be impossible for Start9 to create documentation and tutorials for every service we make available on the Embassy. Each service *should* have its own documentation produced by the service developers themselves, and we will do our best keep track, consolidate, and link to it. Also, much of the reason good tutorials don't exist is simply because no one in the community has taken the time to produce it. If you come across something useful or write something up yourself, please let us know and we will promote it. Otherwise we will do our best to answer questions as they arise and gradually build out tutorials where they are lacking.
Please also check out these :ref:`external support channels <external-support>` for assistance.
I want to understand in depth how a Service works and it's available configuration options. Where can I go to learn more?
--------------------------------------------------------------------------------------------------------------------------
Depending on the app, the config options can be quite involved. Bitcoin Core, for example, has an enormous amount of complex options, almost none of which are useful to a normal user doing normal things. We chose some very sane defaults that should work for normal use cases. Here is an example config from the Bitcoin `GitHub <https://github.com/bitcoin/bitcoin/blob/master/share/examples/bitcoin.conf>`_.

View File

@@ -18,7 +18,9 @@ After plugging into power and your router, you will hear 2 distinct sounds: firs
My Embassy is really hot! Is this normal?
------------------------------------------
Yes, the Embassy's case is actually doing 'double duty' as a heat sync. This means that the metal of the case is actually touching the chips on the circuit board and drawing their heat out and away. This is known as "passive cooling," as no fan (and therefore no noise) is required to cool the system.
On early devices, yes. These cases are actually doing 'double duty' as a heat sync. This means that the metal of the case is actually touching the chips on the circuit board and drawing their heat out and away. This is known as "passive cooling," as no fan (and therefore no noise) is required to cool the system.
You can check the chip temperature of your device under "System -> Metrics".
I'm trying to migrate my old Embassy data, but the device won't boot. What do I do?
------------------------------------------------------------------------------------
@@ -38,7 +40,7 @@ Why do I need the Bonjour service (Windows)?
--------------------------------------------
A major use-case of Bonjour is wireless printing over the LAN, but your Windows machine can also use Bonjour to discover and connect with other devices on the :ref:`Local Network<lan>`. In this case your Embassy. If Windows were to add support for reaching ``.local`` addresses, as is done in Linux and Mac, this would no longer be necessary.
Recent updates to Windows 10 (and possibly 11) may obviate the need for Bonjour, but so far results are mixed.
Recent updates to Windows may obviate the need for Bonjour, but so far results are mixed.
My Tor sites aren't loading, what should I do?
----------------------------------------------
@@ -56,14 +58,14 @@ Nothing special is required, however, it is best practice to use good passwords,
What if I have an unique network issue, for example, with a firewall?
---------------------------------------------------------------------
Embassy is designed to work as simply as possible, for as many as possible, while providing the ability to self-host in a private manner. If you have an agressive or custom firewall, or other custom network settings, there is a good chance that addtional configuration may be necessary. We will continue to learn about custom networking issues, update our docs with resources, and help in the :ref:`Community Channels <contact>` to the best of our ability.
Embassy is designed to work as simply as possible, for as many as possible, while providing the ability to host in a private manner. If you have an agressive or custom firewall, or other custom network settings, there is a good chance that addtional configuration may be necessary. We will continue to learn about custom networking issues, update our docs with resources, and help in the :ref:`Community Channels <contact>` to the best of our ability.
Can I use my Embassy from behind a VPN, for example, if my router has a built-in VPN?
-------------------------------------------------------------------------------------
While this is possible, it adds complexity, which may lead to problems. You will need to understand the setup of your router/VPN and how it supports (or doesn't support) Tor/LAN connections.
Yes, this is possible, but it adds complexity, which may lead to problems. You will need to understand the setup of your router/VPN and how it supports (or doesn't support) Tor/LAN connections.
If you are having trouble with this, you might consider letting Embassy out "in the clear," since all services are accessible over the Tor network, offering a high level of privacy.
If you are having trouble with this, you might consider letting Embassy out "in the clear," since all services are accessible over the Tor network, offering a high level of privacy. Obviously, Start9 cannot support every variation of router and network.
Is it true that my device has some limited functionality in regard to Embassy?
------------------------------------------------------------------------------
The short answer is maybe, but there are workarounds for most limitations. Please see the :ref:`Limitations<limitations>` page for details on your device.
The short answer is probably not, and there are often workarounds for the few known limitations. Please see the :ref:`Limitations<limitations>` page for details on your device.

View File

@@ -10,7 +10,7 @@ This post will attempt to do a deep dive into the features of the Umbrel 0.4.10
Definitions
-----------
Each platform will have different terminology, so lets first agree on common terms so the comparisons can be easy to understand.
Each platform will have different terminology, so let's first agree on common terms so the comparisons can be easy to understand.
**Embassy “Service” vs Umbrel “App”**

View File

@@ -36,7 +36,7 @@ See the video at the top of this page for an intro to Lightning using RTL.
Spark
-----
.. note:: Compatible with C-Lightning only
.. note:: Compatible with Core Lightning (CLN) only
Available For
.............

View File

@@ -43,7 +43,7 @@ Registering an SSH Key
#. Click "Add New Key".
#. Back in the terminal of your workstation, display and copy your SSH *public* key (created above):
On Mac simply copy your key to clipboard with:
On Mac simply copy your key to clipboard by typing the following into a terminal:
.. code-block:: bash