From 37233895f9e6375d223536e83faceabce2c21f9e Mon Sep 17 00:00:00 2001 From: kn0wmad Date: Mon, 17 Jan 2022 15:59:22 -0700 Subject: [PATCH] Edit FAQ for 0.3 relevance --- poetry.lock | 6 +- site/03-todo.md | 2 - site/source/about/start9.rst | 36 ++++++++++-- site/source/support/faq/faq-030.rst | 14 +++++ site/source/support/faq/faq-basic-use.rst | 52 +++++++----------- site/source/support/faq/faq-bitcoin.rst | 43 +++++---------- site/source/support/faq/faq-embassy.rst | 28 +++++----- site/source/support/faq/faq-general.rst | 55 +++++++++++-------- site/source/support/faq/faq-lightning.rst | 26 +++++---- site/source/support/faq/faq-services.rst | 28 +++++----- .../support/faq/faq-troubleshooting.rst | 28 ++++------ site/source/support/faq/index.rst | 1 + .../configuration/limitations/lim-android.rst | 4 ++ .../configuration/limitations/lim-ios.rst | 4 ++ .../support/user-manual/services/index.rst | 2 +- .../tuning/advanced-config/ssh-setup.rst | 2 + .../tuning/service-guides/lightning.rst | 4 +- 17 files changed, 179 insertions(+), 156 deletions(-) create mode 100644 site/source/support/faq/faq-030.rst diff --git a/poetry.lock b/poetry.lock index b1d0ba7..2f3bb2b 100644 --- a/poetry.lock +++ b/poetry.lock @@ -126,7 +126,7 @@ python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*" [[package]] name = "importlib-metadata" -version = "4.10.0" +version = "4.10.1" description = "Read metadata from Python packages" category = "dev" optional = false @@ -673,8 +673,8 @@ imagesize = [ {file = "imagesize-1.3.0.tar.gz", hash = "sha256:cd1750d452385ca327479d45b64d9c7729ecf0b3969a58148298c77092261f9d"}, ] importlib-metadata = [ - {file = "importlib_metadata-4.10.0-py3-none-any.whl", hash = "sha256:b7cf7d3fef75f1e4c80a96ca660efbd51473d7e8f39b5ab9210febc7809012a4"}, - {file = "importlib_metadata-4.10.0.tar.gz", hash = "sha256:92a8b58ce734b2a4494878e0ecf7d79ccd7a128b5fc6014c401e0b61f006f0f6"}, + {file = "importlib_metadata-4.10.1-py3-none-any.whl", hash = "sha256:899e2a40a8c4a1aec681feef45733de8a6c58f3f6a0dbed2eb6574b4387a77b6"}, + {file = "importlib_metadata-4.10.1.tar.gz", hash = "sha256:951f0d8a5b7260e9db5e41d429285b5f451e928479f19d80818878527d36e95e"}, ] jinja2 = [ {file = "Jinja2-3.0.3-py3-none-any.whl", hash = "sha256:077ce6014f7b40d03b47d1f1ca4b0fc8328a692bd284016f806ed0eaca390ad8"}, diff --git a/site/03-todo.md b/site/03-todo.md index af9c90f..abe4255 100644 --- a/site/03-todo.md +++ b/site/03-todo.md @@ -27,7 +27,6 @@ - Configuration - Tor Setup - Desktop - - Linux - Mac - Windows - Mobile @@ -56,7 +55,6 @@ - Service-specific Guides # Learn - Concepts - - FAQ - remove anything no longer relevant in 0.3 - Embassy - Device - OS diff --git a/site/source/about/start9.rst b/site/source/about/start9.rst index e68cc62..8ce9269 100644 --- a/site/source/about/start9.rst +++ b/site/source/about/start9.rst @@ -4,13 +4,41 @@ Start9 Labs =========== -Start9 Labs is a small, but rapidly growing team of passionate builders. We are based in Denver, Colorado, but have team members around the world. +Privacy and free speech are fundamental human rights and essential ingredients for a free society. Human history demonstrates that, when entrusted to others, these rights are invariably denied, resulting in great suffering. As such, it is necessary for individuals to protect their own privacy and right to speak freely. Fortunately, modern technologies, in the form of personal computers, encryption, and open, decentralized network protocols such as the Internet and Bitcoin, make this a real possibility. What is needed is a revolution in personal computing away from the current, hosted, custodial model that breeds dependency and corruption, towards a decentralized model, where individuals have absolute control over their data and communications. + +.. _mission: + +The Mission +----------- +To afford individuals sovereign control over their computers. + +.. _values: + +Values +------ +Decentralization - While centralized services can offer some efficiency gains, the costs are simply too high. Decentralized systems afford more power (and responsibility) to the users. + +Openness +Community +Dignity +Independence + +.. _virtues: + +Virtues +------- +Audacity +Tenacity +Excellence +Courtesy +Generosity +Fortitude +Integrity .. _start9-origin: -"The Origin of “Start9” ------------------------ - +"The Origin of “Start9” (the name) +---------------------------------- Pokemon is a game for Gameboy. Twitch is a live video streaming app. “Twitch Plays Pokemon” was a popular phenomenon where Twitch users would collaborate to play a SHARED game of Pokemon on Gameboy. Here’s how it worked: Participants would use the Twitch message board to enter commands that then got executed in the gameplay. For example, if someone entered the command "right”, that would cause the player to move 1 space to the right. Commands would execute immediately after they were received, and anyone could enter a valid command at any time. You can think of Twitch Plays Pokemon as the more practical equivalent of placing a Gameboy in the middle of a crowded room and telling everyone to push buttons at the same time. As you might expect, the gameplay of Twitch Plays Pokemon was quite “twitchy”, but in a very "infinite monkey theory" way, progress could eventually be made. diff --git a/site/source/support/faq/faq-030.rst b/site/source/support/faq/faq-030.rst new file mode 100644 index 0000000..240017b --- /dev/null +++ b/site/source/support/faq/faq-030.rst @@ -0,0 +1,14 @@ +.. _faq-030: + +===================== +EOS Version 0.3.0 FAQ +===================== + +I'm trying to migrate my old Embassy data, but the device won't boot. What do I do? +------------------------------------------------------------------------------------ +Remove the external drive and sd card adapter if they are plugged in. Boot the device with just the new (16GB) sd card inserted. After you hear the start-up sounds, you may plug in the external drive and old (128GB) sd card. + +I cannot reach embassy.local after hearing the start-up sounds from Embassy. What do I do? +------------------------------------------------------------------------------------------- +* Ensure that you are on the same network as your Embassy. Check that it is not a "Guest" network in your router. +* Your browser might try to force https://embassy.local, delete the https:// and try again with just embassy.local. \ No newline at end of file diff --git a/site/source/support/faq/faq-basic-use.rst b/site/source/support/faq/faq-basic-use.rst index 0c8571a..e12e52e 100644 --- a/site/source/support/faq/faq-basic-use.rst +++ b/site/source/support/faq/faq-basic-use.rst @@ -21,46 +21,32 @@ What if I forget my Embassy password? ------------------------------------- Check out the `docs `_ on forgot password, and let us know if you have any additional questions. All your services and data will remain. +My Embassy is set up, now what? +------------------------------- +Check out our :ref:`Walkthrough` for some details on your Embassy. You can now access your Embassy and find the Services you want from the "Marketplace" tab, then clicking "Install." The Service will let you know if you need any "dependencies," or pre-requisite Services, first. After you have a Service installed, don't forget to "Start" the service. Check out :ref:`Services` for more info. + Can I move my Embassy to another location? What happens when I do this? ------------------------------------------------------------------------ -Yes, you can move the Embassy to another network. Your service tor addresses will remain the same. +Yes, you can move the Embassy to another network. Your service tor addresses will remain the same. Remember that you can only access via LAN if you are accessing with a device on the same network as your Embassy. What’s the advantage of using the .local address over the .onion address? ------------------------------------------------------------------------- -If you are in your home network it is both faster and more private since the connection never leaves your household. The downside is that it won’t work if you’re 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? ---------------------------------------------------- Unfortunately, no. The Tor Browser requires all web visits to first enter the Tor network. Once you have entered the Tor network there is no way to exit the Tor network in such a way that .local/mDNS addresses resolve. -Can I not use .local addresses on Android? Why not? ----------------------------------------------------- -Unfortunately, no. Google has not included support for .local addresses via mDNS for Android. - -Is the software Open Source? ----------------------------- -Yes! EmbassyOS is open sourced under the `Start9 Personal Use License `_. Some of our other projects are currently open sourced under MIT. You can find these in the Start9 `GitHub repository `_. - -Is there a product warranty? ----------------------------- -Yes! Start9 commits, to the best of our ability, to serving each beta Embassy product released until the wild. We will resolve any issue encountered with our provided hardware or software in a personalized matter. We strive to provide highly available, quality customer service. - -Can you tell me about the License? ----------------------------------- -EmbassyOS is published under our own Start9 Non-Commercial License, which has similar properties to many open source licenses with the exception that users cannot in any way, either through products or services, commercialize the source code, and any changes to the code or derivative works of the code are treated in the same manner. This means people will be welcome to access the source code, download it, use it, run it, fork it, change it, improve it - whatever they want - except sell it or sell services related to it. - -I run a business, can I use an Embassy for tasks such as password management and file sharing? ----------------------------------------------------------------------------------------------- -Absolutely. An Embassy would be a great addition to any business as it is easy to use and provides services that you control, with no subscription fees. - -With the addition of `BTCPay Server `_, you can even run your own payment processor and accept cryptocurrency payments with no third party necessary! +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` for more deatils. Can I have multiple users on my Embassy? ---------------------------------------- -Currently, the Embassy itself is designed to 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 absolutely support multiple users (aka multi-tenancy, aka uncle Jim model) where people who trust you 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. +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. -What can I do if I am having issues connecting to an Android app? ------------------------------------------------------------------ +What can I do if I am having issues connecting to an Android app over Tor? +-------------------------------------------------------------------------- Unfortunately, Orbot can be finicky. The best solution to Android issues is normally to restart Orbot, or to reboot the phone. This will solve most common problems. What can I do if I am having issues connecting with Consulate? @@ -77,20 +63,20 @@ Do I need to delete existing backups before doing a new backup? Or does a new ba ------------------------------------------------------------------------------------------------------------- No, you don’t need to delete the old backups. The technology we use updates the existing backup. -Can I clone my Embassy SD card for backup purposes? ---------------------------------------------------- -Warning: **DO NOT do this if you are running LND or c-lightning**. If you clone the SD card, then go back to running LND or c-lightning, and you *ever* try to restore the SD card, there is a good chance you will lose *all your channel funds*. Also, if you try to use the SD card for a 2nd Embassy, that will also result in loss of funds. This has nothing to do with Start9 or the Embassy; it is inherent to the architecture of Lightning. +Can I clone my Embassy SSD for backup purposes? +----------------------------------------------- +.. warning:: **DO NOT do this if you are running LND or c-lightning**. If you clone the SSD, then go back to running LND or c-lightning, and you *ever* try to restore the SSD, there is a good chance you will lose *all your channel funds*. Also, if you try to use the SSD for a 2nd Embassy, that will also result in loss of funds. This has nothing to do with Start9 or the Embassy; it is inherent to the architecture of Lightning. -If you are not running LND or c-lightning, then *yes*, it is possible to do a deep clone of the SD card as a backup. But even here, there are some considerations: Start9 does not test/support this officially, which means it is untested. Also, it may take a while to do a deep clone of the card since the ones we ship are 128GB and there isn't a really effective way to clone the Embassy card that isn't a byte-for-byte copy. However, if you do a byte for byte copy (128GB), and run `PiShrink `_ you could flash that image file onto a new card and restore all of your data. +It is neither necessary, nor recommended to do this. The backup solution available in EmbassyOS (v0.3.0+) allows all data to be written to another drive remotely, and this can mean another SSD, attached to a computer on your network. You may also do a backup to a local drive if it has external power. Please follow the directions in the backup UI for more details. Why would I even buy this when I can just build it for free?? ------------------------------------------------------------- -(1) White glove support. Because each Embassy comes with a unique product key engraved on it, and we have a record of all product keys ever, we can ask the user to verify their product key in order to receive a higher tier of support, such as phone calls. +(1) White glove support. Because each Embassy comes with a unique product key engraved on it, and we have a record of all product keys, we can ask the user to verify their product key in order to receive a higher tier of support, such as phone calls. (2) Supporting the project. Buying an Embassy from Start9 is your way of supporting the development of the project. And it's not just out of gratitude, but rather, a recognition that if the project isn't funded, the cool software stops coming. -(3) Convenience. This is the big one. It's true, some people will choose to use the software without buying an Embassy, but most will not. Very few people on Earth are comfortable using the command line, compiling code, and configuring an OS. Furthermore, hardware is necessary. Sure, some people already have a Raspberry Pi, and others may try to re-purpose an old laptop, but many people would be choosing between buying the Embassy hardware components themselves and assembling vs buying pre-assembled at a reasonable markup. And it's not just a pi, the Ambassador utilizes audio feedback, so a speaker is necessary too. Finally, due to the product key aspect, we can gate certain features of our hosted Service Marketplace. As in, if you buy an Embassy from us, certain services may be free, whereas they may be charged if you don't buy from us. Nothing stops a user from getting the service themselves from elsewhere, but again, convenience. +(3) Convenience. This is the big one. It's true, some people will choose to use the software without buying an Embassy, but most will not. Very few people on Earth are comfortable using the command line, compiling code, and configuring an OS. Furthermore, hardware is necessary. Sure, some people already have a Raspberry Pi, and others may try to re-purpose an old laptop, but many people would be choosing between buying the Embassy hardware components themselves and assembling vs buying pre-assembled at a reasonable markup. 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 `Telegram `_ or `Matrix `_ channels. You can also `email us `_. Please do not hesitate to reach out! +The fastest way to get support is via our :ref:`Community channels`. You can also `email us `_. Please do not hesitate to reach out! diff --git a/site/source/support/faq/faq-bitcoin.rst b/site/source/support/faq/faq-bitcoin.rst index fee0a50..26a9118 100644 --- a/site/source/support/faq/faq-bitcoin.rst +++ b/site/source/support/faq/faq-bitcoin.rst @@ -6,33 +6,32 @@ Bitcoin FAQ Why does the Bitcoin service take so long to be ready? ------------------------------------------------------ -On first install, the Bitcoin service must verify the entire history of transactions in order to verify transactions going forward. This can take approximately a week depending on your internet connection. You can continue to use the Embassy normally in the meantime. +On first install, the Bitcoin service must verify the entire history of transactions in order to verify transactions going forward. This can take up to a week depending on your internet connection. On a fast connection, you can expect 3-4 days. You can continue to use your Embassy normally in the meantime. You can learn more about the Initial Block Download in `this video `_. +.. youtube:: OrYDehC-8TU + Can the IBD (Initial Block Download) be made faster? Or can wait times be improved? ------------------------------------------------------------------------------------ -We have improvements on the way in mid-2021 to vastly improve the painful sync times, without sacrificing trust minimization. +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, which we are investigating. -I'm getting this error: unable to connect to bitcoind: -28: Loading block index... What do I do? ------------------------------------------------------------------------------------------------- -The block index error is normal and goes away after the Bitcoin blockchain has synced. If you have completed the Initial Blockchain Download (IBD), this will be a few minutes at most. - -Does the Embassy run a full archival Bitcoin node? --------------------------------------------------- -The Embassy runs a full node, but does not run a full *archival* node, it's pruned. This means it does not store the entire Blockchain. As it syncs, it discards blocks and transactions it does not need. -It is fully validating and verifying consensus all the way from Genesis. Really, the only reason to store the entire Blockchain is if you want to run a block explorer. Learn more here: :ref:`node`. All this being said, it will be possible to run a full archival node on the Embassy in mid-2021, bringing this additional functionality to those that would like it. +Does the Embassy run a full archival Bitcoin node or a pruned one? +------------------------------------------------------------------ +Previous Embassy versions (pre-0.3.0) only allowed a pruned node, but the option is now yours. In the Bitcoin Config, find the section on pruning, and set to 'Manual' or 'Automatic' to to prune to specified sizes, or turn pruning off entirely for a full archival node. Please keep in mind that a full archival node will take up between 400-500GB of your drive as of 2022. What actions, specifically, are only possible with an archival, or ‘unpruned’ node? ----------------------------------------------------------------------------------- The more sophisticated the blockchain analysis being done is, the more index data is required, which will increase the system resources required. For example, if you wanted to run a block explorer, you would require not only a full archival node, but also a full transaction index. So, specifically, at this time, a full archival node is required for running an Electrum server, a block explorer, and for doing advanced chain analysis in general. +Many wallets also do not yet support pruned nodes, which is one big reason that we added the archival option. Archival nodes currently have a lot more wallet integration options. + Is it insecure to run a pruned node? ------------------------------------ -As a user, pruned nodes and archival nodes provide you the same security. In a larger sense, if 100% of people ran pruned nodes, the security of the network could be in dire circumstances and be put at risk if no nodes kept history, as then no one could bootstrap new nodes. The reality however, is that most Embassy owners are new node operators, so there is no net systemic risk introduced. +As a user, pruned nodes and archival nodes provide you the same security. In a larger sense, if 100% of people ran pruned nodes, the security of the network could be in dire circumstances and be put at risk if no nodes kept history, as then no one could bootstrap new nodes. The reality however, is that most Embassy owners are new node operators, so there is no net systemic risk introduced if users decide to run a pruned node. The Bitcoin Service is different from the GUI version I am used to using (bitcoin-qt). How do I use this like I used to? ------------------------------------------------------------------------------------------------------------------------- -At present, the Embassy does not offer its own node visualization tool. You can view certain properties about your node inside the "Properties" section, but not in an animated GUI. If you want to use bitcoin-cli, you may do so by adding an SSH key onto your Embassy and exec-ing into the bitcoind docker container. Otherwise, the main way to actually *use* your node is through a wallet. The QT GUI is not usable because it cannot be served through the browser (which is necessary here), and last we checked, the QT desktop client was incapable of connecting to a remote node over Tor. As far as we are aware, the only wallets that support this are Specter, Fully Noded, and Sparrow. +At present, the Embassy does not offer its own node visualization tool. You can view certain properties about your node inside the "Properties" section, but not in an animated GUI. If you want to use bitcoin-cli, you may do so by adding an SSH key onto your Embassy and :ref:`exec-ing into the bitcoind docker container`. Otherwise, the main way to actually *use* your node is through a wallet. The QT GUI is not usable because it cannot be served through the browser (which is necessary here), and last we checked, the QT desktop client was incapable of connecting to a remote node over Tor. Is a wallet vulnerable to hacking if it’s always online?? --------------------------------------------------------- @@ -60,24 +59,14 @@ It is helpful to think of the Bitcoin Core service on the Embassy as your own pe There are modern wallets that have the ability to use your personal Bitcoin node as a source of truth, and with the advantages of additional security and advanced features. This also follows the Linux mantra of "do one thing and do it well." The recommended way to use Bitcoin with your Embassy’s Bitcoin node is with an external wallet. The available wallets are listed in the following FAQ. -Which wallets can I use that sync with my Embassy Bitcoin node? ---------------------------------------------------------------- -The only currently available external options are FullyNoded and Specter. Within the Embassy, BTCPayServer is available, which offers a wallet that is automatically connected to your Embassy's Bitcoin Core node. Keep in mind that this first and foremost a payment gateway, rather than a personal wallet. Unforutnately, this is still not a popular functionality in Bitcoin wallets. We are in communication with several wallet developers about adding Tor full node support. - -What Lightning wallets can I use that sync with my Embassy? ------------------------------------------------------------ -Spark, Zap, and Zeus. +Which wallets can I use that sync with my Embassy Bitcoin and/or Lightning nodes? +--------------------------------------------------------------------------------- +Please see the :ref:`Service Guides` 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. -Is there a guide for connecting Specter Wallet to my Embassy? -------------------------------------------------------------- -There is. Please follow the integration guide `here `_ and select the tutorial based on your operating system. - -More guides, particularly in video form, are forthcoming. - 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. @@ -92,6 +81,4 @@ You would use your hardware signer with your wallet, then instruct that wallet t - Signers are for generating and storing keys, as well as signing transactions. -The reason there is so much confusion about these 3 concepts is that the Bitcoin Core Node comes with its own Wallet (which you should not use), and that wallet is also a signer. In fact, most wallets double as signers, and most wallets do NOT support connecting to your own node. So, most wallets are actually serving as a wallet, a node, and a signer, which might be convenient, but it is neither trustless nor maximally secure. Ideally, you are using a wallet that supports both integrating with a hardware signer (like Coldcard or Trezor) AND a backend node (like on the Embassy). - -Please note: of the wallets listed (Specter/Sparrow/Electrum), only Specter is currently able to use Embassy as it's node, but the other two should be available soon. \ No newline at end of file +The reason there is so much confusion about these 3 concepts is that the Bitcoin Core Node comes with its own Wallet (which you should not use), and that wallet is also a signer. In fact, most wallets double as signers, and most wallets do NOT support connecting to your own node. So, most wallets are actually serving as a wallet, a node, and a signer, which might be convenient, but it is neither trustless nor maximally secure. Ideally, you are using a wallet that supports both integrating with a hardware signer (like Coldcard or Trezor) AND a backend node (like on the Embassy). \ No newline at end of file diff --git a/site/source/support/faq/faq-embassy.rst b/site/source/support/faq/faq-embassy.rst index 78d4dc3..fe09449 100644 --- a/site/source/support/faq/faq-embassy.rst +++ b/site/source/support/faq/faq-embassy.rst @@ -6,17 +6,17 @@ Embassy FAQ Can I run EmbassyOS on a VPS or VM? ----------------------------------- -Maybe, but we advise against this. It is designed to be used on a RaspberryPi. +Yes, 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. Is it possible to use the EmbassyOS on my own hardware? ------------------------------------------------------- -Yes! The :ref:`diy guide ` will take you through the setup steps. This option is great for people who already own the necessary hardware or who live outside the US and want to save on shipping and customs fees. +Yes! The :ref:`DIY Guide ` will take you through the setup steps. This option is great for people who already own the necessary hardware or who live outside the US and want to save on shipping and customs fees. -Additionally, EmbassyOS is available to build from source under the Start9 Personal Use License. If you have the time and energy, it is possible to download and compile EmbassyOS yourself, for free, with the caveat that your “Embassy” will not have a product key generated by us. This means you will miss out on the perks that come along with purchasing from us, which will grow over time. +Additionally, EmbassyOS is available to build from source under the Start9 Personal Use :ref:`License`. If you have the time and energy, it is possible to download and compile EmbassyOS yourself, for free, with the caveat that your “Embassy” will not have a product key generated by us. This means you will miss out on the perks that come along with purchasing from us, which will grow over time. Do I plug the Embassy into my computer? --------------------------------------- -No. The Embassy only needs to be plugged into power and internet, just like your router. You can set it up right by your router and forget about it. +No. The Embassy only needs to be plugged into power and internet, just like your router. You can set it up right by your router and, similar to a router, generally forget about it. How much storage does the Embassy have? --------------------------------------- @@ -24,11 +24,11 @@ Currently, the Embassy ships with a 128gb of storage. Are my Internet requests anonymous and secure? ---------------------------------------------- -EmbassyOS and every service on the Embassy serve their own Tor Hidden Services with unique Tor addresses. The private keys used to create these addresses are generated on your phone or computer when you first set up the Embassy. No one, not even Start9, has any idea what your Tor addresses are, let alone the password(s) you choose to authenticate with them. +EmbassyOS and every service on Embassy serve their own Tor Hidden Services with unique Tor addresses. The private keys used to create these addresses are generated on your phone or computer when you first set up Embassy. No one, not even Start9, has any idea what your Tor addresses are, let alone the password(s) you choose to authenticate with them. Does Start9 have access to my Embassy's encryption keys? -------------------------------------------------------- -No. Your keys are generated on your device using the password you create. +No. Your keys are generated on your device using the password you create so we CAN NOT, nor would we like to, see your private keys. Can multiple Embassies be setup to run redundantly in physically separate locations? ------------------------------------------------------------------------------------ @@ -36,28 +36,28 @@ Soon (tm). Currently no, be we have plans for a feature that will enable Embass 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 the Embassy, which "just works". In between is stuff like MyNode, Nodl, Dojo, Umbrel, and Raspiblitz, which all require some degree of command line effort and network configuration. The biggest benefit of the 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 cannot. +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, Dojo, etc) a competitor to you guys, or are they different enough to be compatible? +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, self-hosted software, including Bitcoin/Lightning. They are more Bitcoin/Lightning oriented. +We are taking more a general approach to all of open-source, hosted software, including Bitcoin/Lightning. They are more Bitcoin/Lightning oriented. Is a more powerful device in the works?? ---------------------------------------- -In the near future, the Embassy will move to more powerful hardware. +Yes, and EmbassyOS will eventually be capable of running on lots of different hardware, such as an old desktop. We want EmbassyOS to be widely available. I heard on an old podcast that there will be an Embassy Two, to be launched in 2021. Is there an ETA on this? -------------------------------------------------------------------------------------------------------------- -Do not expect a new device in 2021, but we are always doing R&D. +R&D is in progress, but obviously 2021 was not the year for this. Check our :ref:`Community Channels` for the latest updates. Can I mine Bitcoin with this? ----------------------------- No, you can not. -Does the Embassy only work over Tor? No http or VPN...?? --------------------------------------------------------- -The Embassy’s current primary communication is Tor, yes. 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. +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. What if someone gets physical access to my device, can they read the contents? Is it encrypted? ----------------------------------------------------------------------------------------------- diff --git a/site/source/support/faq/faq-general.rst b/site/source/support/faq/faq-general.rst index 0aa6f26..f3f7efe 100644 --- a/site/source/support/faq/faq-general.rst +++ b/site/source/support/faq/faq-general.rst @@ -6,61 +6,66 @@ General FAQ What is Start9Labs? ------------------- -Start9Labs is a company based in Denver, CO that builds the Embassy and EmbassyOS. +Start9Labs is a small, but quickly growing group of builders based in Denver, CO that build Embassy and EmbassyOS. What is the Embassy? -------------------- -The Embassy is a "shelf-top" computer built using a `Raspberry Pi `_ for hardware and running EmbassyOS software. +Embassy is a "shelf-top" computer built using a `Raspberry Pi `_ for hardware and 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. -The Embassy is exactly that: your very own "answerer", just like Google's, except managed simply and with ease by and for you alone. +Embassy is exactly that: your very own "answerer", just like Google's, except managed simply and with ease by and for you alone. In other words, it is a generalized private personal server capable of running all sorts of self hosted open source software. When you see your credit card information on your banking app, your messages in your texting app, your passwords in your password management app, all of that information comes from somewhere in the cloud: some server run by some company somewhere on the planet. Who can see the data stored in that server? Who can edit it? It's not always clear, but the increasingly common practice of selling your data to advertisers and the high-profile cyber-security breaches of the last decade suggest a pessimistic outlook. -One thing is for certain though: if you control your server, then you control your data. Your finances, your communications, all of it is actually yours -- and only yours -- with an Embassy. +One thing is for certain though: if you control your server, then you control your data. Your finances, your communications, all of it is actually yours -- and only yours -- with Embassy. Why do I care? -------------- -As an example, let's talk about the password manager, Bitwarden. It may help convey the concept of a personal server. Currently, when you use Bitwarden, your passwords are stored on a physical device (aka server) owned and operated by the Bitwarden team. Your phone or laptop sends requests to their server when you want to do anything: create an account, create a new password, retrieve existing passwords, etc. Your passwords are stored on their device, encrypted with your Bitwarden password. They are the custodian of your passwords, similar to getting a safe deposit box at the bank. The bank keeps your valuables in their vault, presumably they don't know what's in the box, and any time you want access to your box, you ask the bank for permission. This is exactly how a hosted Bitwarden experience works, as well as just about everything on the internet. +As an example, let's talk about the password manager, Bitwarden. It may help convey the concept of a personal server. Currently, if you sign up with Bitwarden, your passwords are stored on a physical device (aka server) owned and operated by the Bitwarden team. Your phone or laptop sends requests to their server when you want to do anything: create an account, create a new password, retrieve existing passwords, etc. Your passwords are stored on their device, encrypted with your Bitwarden password. They are the custodian of your passwords, similar to getting a safe deposit box at the bank. The bank keeps your valuables in their vault, presumably they don't know what's in the box, and any time you want access to your box, you ask the bank for permission. This is exactly how a hosted Bitwarden experience works, as well as just about everything on the internet. When you install Bitwarden on your Embassy, by contrast, it's like building your own safe deposit box in a private bunker whose location is only known to you and whose keys only you posses. You create an account with yourself, store your passwords with yourself, etc. You are your own custodian. This same concept can be applied to just about everything on the Internet, without losing the convenience of the custodial model, which is what we are out to accomplish. This may sound cool, or neat, but it is so much more than that. The custodial data model is amongst the greatest threats to human liberty the world has ever seen. -This `podcast `_ may help expound upon why this is important. +This `podcast `_ may help expound upon why this is important. -How does the Embassy work? --------------------------- -The Embassy runs on the Raspberry Pi 4B hardware with a Cortex-a72 CPU, 4GB of RAM, and has 2.4ghz and 5.0ghz IEEE 802.11AC wireless capabilities and an internal speaker for audio feedback of system operations. It also features a high endurance MicroSD card, on which the operating system software is installed. +.. youtube:: aylDowaSdzU -EmbassyOS is a stripped down version of Raspbian Buster Lite 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 download and install services. +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 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 Embassy’s 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 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. -Once on Embassy's web page, you can choose what services to install to the Embassy. Then, each installed service also receives its own private and unique URL, such that you can access it from the browser or any mobile app that supports using it as a backend. +Once on Embassy's web page, you can choose what services to install. Then, each installed service also receives its own private and unique URL, such that you can access it from the browser or any mobile app that supports using it as a backend. -The list of services will grow rapidly over the coming months, such that many things you currently do using cloud-based third party servers can be just as easily accomplished using your own personal cloud serving your own personal apps and storing your own private data. No trusted third parties at all. +The list of services will grow rapidly over the coming months and years, such that many things you currently do using cloud-based third party servers can be just as easily accomplished using your own personal cloud serving your own personal apps and storing your own private data. No trusted third parties at all. 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 self-host their own software services. +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 custom-built Linux distribution, which is a stripped down and beefed up version of `Raspbian Buster Lite OS `_, along with a suite of software tools which make it easy to: +EmbassyOS is a custom-built Linux distribution, which is a beefed up version of `Ubuntu Server OS `_, along with a suite of software tools which make it easy to: -* Install, uninstall, and upgrade services from the custom Marketplace (similar to your phone's app store) -* Manage and run services that YOU control +* Install, uninstall, and upgrade services from a Marketplace (similar to your phone's app store) +* Manage and run services that YOU own and control * Upgrade your Embassy software with the latest features and security updates * Backup services, and restore from backups if needed -Start9 augmented the original Raspbian OS to include: +It includes: * a custom application management layer, specialized for installing, running, and backing up .s9pk packaged services * a layer responsible for Embassy specific operations, such as Tor, Backups, and Notifications +* a system of :ref:`Health Checks` for simple monitoring +* an SDK for developers, including an :ref:`Actions API` to simplify complex operations for the common user +* and much, much more. Please see the corresponding :ref:`Concepts` 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 the 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. What are EmbassyOS Services? ---------------------------- @@ -80,23 +85,23 @@ Yes. Is the software Open Source? ---------------------------- -Yes! EmbassyOS is open sourced under the `Start9 Personal Use License `_. Some of our other projects are currently open sourced under MIT. You can find these in the Start9 `GitHub repository `_. - -Is there a product warranty? ----------------------------- -Yes! Start9 commits, to the best of our ability, to serving each beta Embassy product released into the wild. We will resolve any issue encountered with our provided hardware or software in a personalized matter. We strive to provide highly available, quality customer service. +Yes! EmbassyOS is open source under the `Start9 Personal Use License `_. Some of our other projects are currently open sourced under MIT. You can find these in the Start9 `GitHub repository `_. Can you tell me about the License? ---------------------------------- EmbassyOS is published under our own Start9 Non-Commercial License, which has similar properties to many open source licenses with the exception that users cannot in any way, either through products or services, commercialize the source code, and any changes to the code or derivative works of the code are treated in the same manner. This means people will be welcome to access the source code, download it, use it, run it, fork it, change it, improve it - whatever they want - except sell it or sell services related to it. +Is there a product warranty? +---------------------------- +Yes! The full warranty for a device purchased with us is located on the insert in the box (1 year). Furthermore, Start9 commits, to the best of our ability, to serving Embassy users. We will resolve any issue encountered with our provided hardware or software in a personalized matter. We strive to provide highly available, quality customer service. + What kind of Internet connection is required to use Embassy? ------------------------------------------------------------ In general, any modern Internet connection is usually fine. We have had reports from users on rural satellite connections with high latency (ping), and low up/download speeds who had issues accessing via Tor. You can check your internet connection at `SpeedTest `_ to find your ping and speed. If your ping is higher than 200ms and/or your speeds are lower than 5Mbps, you may want to host your Embassy somewhere with a better connection. Please don't hesitate to contact us with any questions. I run a business, can I use an Embassy for tasks such as password management and file sharing? ---------------------------------------------------------------------------------------------- -Absolutely. An Embassy would be a great addition to any business as it is easy to use and provides services that you control, with no subscription fees. +Absolutely. Embassy would be a great addition to any business as it is easy to use and provides services that you control, with no subscription fees. With the addition of `BTCPay Server `_, you can even run your own payment processor and accept cryptocurrency payments with no third party necessary! @@ -115,3 +120,5 @@ I want to help, but I'm not a developer. Are there any ways for non-coders to c 2. Answer questions from new users in the community channels 3. Make tutorial videos 4. Write instruction manuals or commit to the docs + +Check out the :ref:`Contribute` section of this site for more details. \ No newline at end of file diff --git a/site/source/support/faq/faq-lightning.rst b/site/source/support/faq/faq-lightning.rst index 30f3a27..50470e3 100644 --- a/site/source/support/faq/faq-lightning.rst +++ b/site/source/support/faq/faq-lightning.rst @@ -26,8 +26,8 @@ The commitment fees are automatically negotiated every few blocks with your peer What would happen if I shut down an Embassy that is running a Lightning node with open channels? ------------------------------------------------------------------------------------------------ -It is REALLY IMPORTANT to understand that if Lightning services are shut off for long periods of time (days on end) it is possible for your peers to cheat you out of money. If you are not prepared to LOSE ALL THE MONEY IN YOUR CHANNELS, KEEP YOUR NODE RUNNING. -That said, malicious actors on the network right now are probably sparse. However, you are still open to that risk if you do not keep your node online. +It is REALLY IMPORTANT to understand that if Lightning services are shut off for long periods of time (several days or more) it is possible for your peers to cheat you out of money. If you are not prepared to LOSE ALL THE MONEY IN YOUR CHANNELS, KEEP YOUR NODE RUNNING. +That said, malicious actors on the network right now are probably sparse, and you may choose to only open channels with friends that may be a lot nicer to you if your node is not active. Is there a solution to this? ---------------------------- @@ -37,19 +37,17 @@ Is it possible to run c-lightning and lnd parallel on the 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 Spark mobile app to the Embassy Spark server? +How do I connect my Lightning wallet or mobile app to my Embassy? ----------------------------------------------------------------- -To use a Spark client, you still need to have Spark installed on the Embassy (which ‘serves’ Spark). Then, under Properties, there is a "Pairing URL". The first part of this is the server URL, and the end portion of it is the access key. +Please see the :ref:`Service Guides` section for more details. -Unfortunately, Spark cannot currently be used in Consulate. This issue is being tracked `here `__. - -Are my addresses, channels, and balances all stored in LND or in RTL? ---------------------------------------------------------------------- -This is all on LND, and RTL is just a GUI for accessing LND. On-chain balance is also part of the LND backup. +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. How do I find my LND seed so I can write it down to backup? ----------------------------------------------------------- -All LND backups are best done via the Embassy backup flow. It is not supported to use a seed as backup; LND does not expose this. Everything crucial is backed up by our backup system so you do not need your seed. The seed is ONLY for the onchain wallet and does not backup your channel state. +All LND backups are best done via Embassy's backup flow. It is not supported to use a seed as backup; LND does not expose this. Everything crucial is backed up by our backup system so you do not need your seed. The seed is ONLY for the onchain wallet and does not backup your channel state. To clarify some of the reasons for this choice: @@ -59,12 +57,16 @@ So, what is the LND seed *for*? In short, the seed is only used for the Layer1 p Is there a way to use the channel backups made within RTL? ---------------------------------------------------------- -The only backup flow we officially support is through the Embassy backup system. This does include the channel backups created automatically by LND, but it must be understood that backups in Lightning are very different than they are on Layer 1 Bitcoin. If you restore from backup all your channels will close, and there is a potential, albeit small, probability for you to lose funds. +The only backup flow we officially support is through Embassy's backup system. This does include the channel backups created automatically by LND, but it must be understood that backups in Lightning are very different than they are on Layer 1 Bitcoin. If you restore from backup all your channels will close, and there is a potential, albeit small, probability for you to lose funds. When attempting to add new peer, RTL says "server is still in the process of starting," but chain state seems to be fully up to date. What can I do? ----------------------------------------------------------------------------------------------------------------------------------------------------- Check the LND logs, it can take a while to bootstrap, and starting RTL before this completes could cause errors. +I get an error ("Unlock Wallet Failed") when trying to log in to RTL, what can I do? +------------------------------------------------------------------------------------ +Stop and Restart the Service. + "Server is still in the process of starting," but LND and RTL are running. How can I address this? --------------------------------------------------------------------------------------------------- You may need to restart the LND Service. @@ -75,7 +77,7 @@ LND is waiting for Bitcoin to completely sync, and then needs to catch up on blo What's the best way to move a small lightning balance? ------------------------------------------------------ -It is possible to have lightning balances that are so low that they will not (or barely will) cover the on-chain fees to recoup into an on-chain wallet. +It is possible to have lightning balances that are so low that they will not (or barely will) cover the on-chain fees to recoup into an on-chain wallet. If possible, move them to another Lightning node. Why are Lightning Network backups and moves so complicated? ----------------------------------------------------------- diff --git a/site/source/support/faq/faq-services.rst b/site/source/support/faq/faq-services.rst index b1b2f27..8393871 100644 --- a/site/source/support/faq/faq-services.rst +++ b/site/source/support/faq/faq-services.rst @@ -4,10 +4,6 @@ Services FAQ ============ -My Embassy is set up, now what? -------------------------------- -You can now access your Embassy and find the Services you want from the "Marketplace" tab, then clicking "Install." The Service will let you know if you need any "dependencies," or pre-requisite Services, first. After you have a Service installed, don't forget to "Start" the service. - What if I cannot connect to a Service? -------------------------------------- Please make sure the service is started by viewing it in the Services tab in the Embassy dashboard menu. A green indicator bar should be visible. @@ -18,7 +14,7 @@ Potentially. The PiHole service is on the roadmap. Will there be a VPN? -------------------- -We are looking into adding as a Wireguard service for VPN access when you are not home. A client-to-client VPN may also be possible. +We are looking into adding Wireguard as a service for VPN access when you are not home. A client-to-client Embassy VPN may also be possible. Will there be an email server? ------------------------------ @@ -26,7 +22,7 @@ We do hope to add this functionality one day, however it has some technical chal Can the Embassy run 'X' Service?? --------------------------------- -Potentially. Here is a `comprehensive list `_ of self-hosted services, any of which can theoretically be run on the Embassy. +Potentially. Here is a `comprehensive list `_ of self-hosted services, any of which can theoretically be run on EmbassyOS. To get a general idea of what is required of an app, answer these questions: 1. Is it designed to be self-hosted? @@ -37,21 +33,21 @@ 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 service packaging guide :ref:`here `. +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`. -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 the Embassy Marketplace. You don't need our permission. +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. Does the Embassy operate as a Tor relay node? --------------------------------------------- -No, currently it is not, but we plan to add that functionality in the future. +No, currently it does not, but we plan to add that functionality in the near future. Are files on File browser encrypted on disk? -------------------------------------------- No, not currently. -Can I use my CUPS instance with other people? How does that work? ------------------------------------------------------------------ -Cups does not have multiple accounts support. Each person would need their own Embassy. We are considering adding multi-account support to Cups, but it's just not a priority at the moment. +Can others use my Cups instance? How does that work? +---------------------------------------------------- +Cups does not have multiple accounts support. Each person would need their own Embassy. We are considering adding multi-account support to Cups, but it's not a priority at the moment. How can I fix issues with Sphinx? --------------------------------- @@ -70,11 +66,13 @@ Can the browser extension be used with Bitwarden hosted on the embassy? ----------------------------------------------------------------------- Yes, but only in a tor-enabled browser. Just add your .onion address as the server in the extension. Make sure that http:// is at the beginning, and NOT https://, as this will not work. +You can use your .local address, but remember that you will only be able to sync when on your :ref:`LAN`. + I want to use BTCPayServer on my website, but Tor is the only option, how can visitors access my BTCPay on clearnet? -------------------------------------------------------------------------------------------------------------------- -As the Embassy produces a Tor Hidden Service for each service, BTCPayServer is only available via Tor by default. For a brick and mortar business, this is no problem as you can use your own device for a customer to pay you on. If you run your own website, it is possible to set up a reverse proxy in order to serve BTCPay content to your clearnet visitors. A guide to doing this is available in the `BTCPayServer docs `_. +As the Embassy produces a Tor Hidden Service for each service, BTCPayServer is only available via Tor by default. For a brick and mortar business, this is no problem as you can use your own device for a customer to pay you on. If you run your own website, it is possible to set up a reverse proxy in order to serve BTCPay content to your clearnet visitors. A guide to doing this is available in the `BTCPayServer docs `_. -We understand that this can be a frustrating limitation, and adding clearnet support is high on our list of priorities for the Embassy. This will allow a number of services to have better interoperability with the broader Web. +We understand that this can be a frustrating limitation, and adding clearnet support is high on our list of priorities for EmbassyOS. This will allow a number of services to have better interoperability with the broader Web. I'm having issues connecting to users or rooms in Matrix/Synapse, what can I do? -------------------------------------------------------------------------------- @@ -84,7 +82,7 @@ Please reach out to us if you are still unable to connect. My Element desktop client stopped working after an OS update, what is happening? -------------------------------------------------------------------------------- -If you had to create a custom destkop shortcut, it is likely that this was reset with the system update, so you'll just need to remake it. +If you had to create a custom destkop shortcut, it is likely that this was reset with the system update, so you'll just need to remake it. This happens most often on Windows. I don't see an answer to my question regarding a certain service. Is there more documentation? ----------------------------------------------------------------------------------------------- diff --git a/site/source/support/faq/faq-troubleshooting.rst b/site/source/support/faq/faq-troubleshooting.rst index c2aa965..8213b76 100644 --- a/site/source/support/faq/faq-troubleshooting.rst +++ b/site/source/support/faq/faq-troubleshooting.rst @@ -6,7 +6,7 @@ Setup and Troubleshooting FAQ What do I do first? ------------------- -Simply plug the device into power and internet, most easily by using an empty ethernet port on your home internet router. That's it! After this, get the :ref:`Setup App `, and follow the instructions. +Please check out the :ref:`Initial Setup ` page, and follow the instructions. How do I know if my Embassy is running? --------------------------------------- @@ -14,7 +14,7 @@ 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 additional energy) is required to cool the system. +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. What if I can't connect to my Embassy? -------------------------------------- @@ -30,7 +30,7 @@ This is most likely a transient networking issue that will correct itself in a f 1. On Android/Orbot, the most common solution is to restart your Android device. -2. Access your Embassy over :ref:`LAN ` and restart it from the "Embassy" menu. +2. Access your Embassy over :ref:`LAN `, and restart it from the "Embassy" menu. 3. Restart your router. @@ -40,26 +40,18 @@ 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? --------------------------------------------------------------------- -The 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 community :ref:`channels ` to the best of our ability. +The 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 ` to the best of our ability. -Can I use the Embassy from behind a VPN, for example, if my router has a built-in VPN? --------------------------------------------------------------------------------------- +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 connections. If you are having trouble with this, you might consider letting the Embassy out "in the clear," since everything is broadcast exclusively across the Tor network, offering a high level of privacy. 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 `_. +Unfortunately, Brave does not treat .onion addresses in a 'secure context.' This is a well-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. - -I'm having trouble using Firefox for Tor addresses on Lineage, what can I do? ------------------------------------------------------------------------------ -Unfortunately, there seems to be a bug in Lineage that makes using Firefox over Tor currently unusable. Currently, this feature works fine on Calyx and Graphene. +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` page for details on your device. diff --git a/site/source/support/faq/index.rst b/site/source/support/faq/index.rst index 1727137..e792851 100644 --- a/site/source/support/faq/index.rst +++ b/site/source/support/faq/index.rst @@ -10,6 +10,7 @@ Answers to Frequently Asked Questions from Embassy users :maxdepth: 2 faq-general + faq-030 faq-basic-use faq-troubleshooting faq-embassy diff --git a/site/source/support/user-manual/configuration/limitations/lim-android.rst b/site/source/support/user-manual/configuration/limitations/lim-android.rst index 6edd6bf..2b9aeb4 100644 --- a/site/source/support/user-manual/configuration/limitations/lim-android.rst +++ b/site/source/support/user-manual/configuration/limitations/lim-android.rst @@ -11,3 +11,7 @@ Older versions of Android (previous to version 12, and some custom ROMs, such as Workarounds =========== An app developer can add mDNS support, and some projects, such as Chromium, have long `considered it `_, but the real solution is for support to occur at the OS level. + +LineageOS +--------- +Unfortunately, there seems to be a bug in Lineage that makes using Firefox over Tor currently unusable. Currently, this feature works fine on Calyx and Graphene. diff --git a/site/source/support/user-manual/configuration/limitations/lim-ios.rst b/site/source/support/user-manual/configuration/limitations/lim-ios.rst index 1447115..1512ace 100644 --- a/site/source/support/user-manual/configuration/limitations/lim-ios.rst +++ b/site/source/support/user-manual/configuration/limitations/lim-ios.rst @@ -19,3 +19,7 @@ The lack of Tor support on iOS means that Element/Matrix cannot be run on an iPh Workarounds =========== None currently known. + +Spark Wallet +------------ +Unfortunately, Spark cannot currently be used in Consulate. This issue is being tracked `here `__. diff --git a/site/source/support/user-manual/services/index.rst b/site/source/support/user-manual/services/index.rst index 56e7e85..355ff63 100644 --- a/site/source/support/user-manual/services/index.rst +++ b/site/source/support/user-manual/services/index.rst @@ -1,4 +1,4 @@ -.. _services-index: +.. _services: ======== Services diff --git a/site/source/support/user-manual/tuning/advanced-config/ssh-setup.rst b/site/source/support/user-manual/tuning/advanced-config/ssh-setup.rst index 6eec578..d82e195 100644 --- a/site/source/support/user-manual/tuning/advanced-config/ssh-setup.rst +++ b/site/source/support/user-manual/tuning/advanced-config/ssh-setup.rst @@ -6,6 +6,8 @@ SSH Setup .. warning:: This is an advanced feature and should be used with caution. Start9 is not responsible for any damage you might cause while using SSH access. +.. tip:: An ED25519 key is strongly recommended. If you have issues with any other type of key, please consider using an ED25519. + Connecting via CLI (Linux / Mac) -------------------------------- diff --git a/site/source/support/user-manual/tuning/service-guides/lightning.rst b/site/source/support/user-manual/tuning/service-guides/lightning.rst index aaf36d9..f74860d 100644 --- a/site/source/support/user-manual/tuning/service-guides/lightning.rst +++ b/site/source/support/user-manual/tuning/service-guides/lightning.rst @@ -1,10 +1,9 @@ .. _lightning: ========= -Lightning - **NEED GUIDES WRITTEN (in lnd/c-lightning repos?)** +Lightning ========= - Check out our `Getting Started with Lightning video `_ for an introduction to the Lightning Network using LND and RTL on Embassy! .. youtube:: KhU_sTiaN8w @@ -20,6 +19,7 @@ See the video at the top of this page for an intro to Lightning using RTL. Spark ----- +To use a Spark client, you still need to have Spark installed on the Embassy (which ‘serves’ Spark). Then, under Properties, there is a "Pairing URL". The first part of this is the server URL, and the end portion of it is the access key. .. _thunderhub: