mirror of
https://github.com/Start9Labs/documentation.git
synced 2026-03-26 10:21:53 +00:00
Update flashing guide for all platforms
This commit is contained in:
kn0wmad
@@ -17,7 +17,7 @@ Community Channels
|
||||
|
||||
* `Matrix <https://matrix.to/#/#community:matrix.start9labs.com>`_ - Community channel that will gradually replace Telegram.
|
||||
|
||||
* `Matrix Dev <https://matrix.to/#/#community-dev:matrix.start9labs.com>`_ - Primary channel for collaboration on EmbassyOS development and service packaging.
|
||||
* `Matrix Dev <https://matrix.to/#/#community-dev:matrix.start9labs.com>`_ - Primary channel for collaboration on embassyOS development and service packaging.
|
||||
|
||||
* `Matrix Tor (Tor required) <https://matrix.to/#/!iRwnQntcjpWfLxdgav:matrix.privacy34kn4ez3y3nijweec6w4g54i3g54sdv7r5mr6soma3w4begyd.onion?via=matrix.start9labs.com&via=matrix.privacy34kn4ez3y3nijweec6w4g54i3g54sdv7r5mr6soma3w4begyd.onion&via=oayal5vhil3zhj7ylixvpi4nr2xvhypdnenji4sx5q4kvaotevjvsxad.onion>`_ - Tor-only community channel for Embassy users
|
||||
|
||||
|
||||
@@ -69,7 +69,7 @@ Can I clone my Embassy SSD for backup purposes?
|
||||
-----------------------------------------------
|
||||
.. warning:: **DO NOT do this if you are running LND or CLN**. If you clone the SSD, then go back to running LND or CLN, 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.
|
||||
|
||||
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.
|
||||
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?
|
||||
------------------------------------------------------------
|
||||
|
||||
@@ -11,7 +11,7 @@ Contributing FAQ
|
||||
We ❤️ contributions!
|
||||
|
||||
|
||||
How can I contribute to EmbassyOS?
|
||||
How can I contribute to embassyOS?
|
||||
----------------------------------
|
||||
Please follow the guide `here <https://github.com/Start9Labs/embassy-os/blob/master/CONTRIBUTING.md>`_ and reach out to the `Community Dev <https://matrix.to/#/#community-dev:matrix.start9labs.com>`_ channel on Matrix with any questions.
|
||||
|
||||
|
||||
@@ -8,15 +8,15 @@ Embassy FAQ
|
||||
:depth: 2
|
||||
:local:
|
||||
|
||||
Can I run EmbassyOS on a VPS or VM?
|
||||
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.
|
||||
|
||||
Is it possible to use EmbassyOS on my own hardware?
|
||||
Is it possible to use embassyOS on my own hardware?
|
||||
---------------------------------------------------
|
||||
Yes! The :ref:`DIY Guide <diy>` 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 for you to download or build from source under the Start9 Personal Use :ref:`License<license>`, for free. The caveat is that you will miss out on the perks that come along with purchasing from us, such as white-glove support, and others, which will grow over time.
|
||||
Additionally, embassyOS is available for you to download or build from source under the Start9 Personal Use :ref:`License<license>`, for free. The caveat is that you will miss out on the perks that come along with purchasing from us, such as white-glove support, and others, which will grow over time.
|
||||
|
||||
Do I plug my Embassy into my computer?
|
||||
---------------------------------------
|
||||
@@ -32,7 +32,7 @@ Currently, Embassy ships with a 1 or 2TB SSD, but you may use a larger drive if
|
||||
|
||||
Are my Internet requests anonymous and secure?
|
||||
----------------------------------------------
|
||||
EmbassyOS and every service on our Marketplace 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.
|
||||
embassyOS and every service on our Marketplace 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?
|
||||
--------------------------------------------------------
|
||||
@@ -59,7 +59,7 @@ Alternatively, if you have an Umbrel and an Embassy and they're on the same netw
|
||||
|
||||
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.
|
||||
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?
|
||||
------------------------------------------------
|
||||
|
||||
@@ -10,11 +10,11 @@ General FAQ
|
||||
|
||||
What is Start9Labs?
|
||||
-------------------
|
||||
Start9Labs is a small, but quickly growing group of builders based in Denver, CO that build 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?
|
||||
--------------------
|
||||
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.
|
||||
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.
|
||||
|
||||
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.
|
||||
|
||||
@@ -41,7 +41,7 @@ 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.
|
||||
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.
|
||||
|
||||
@@ -51,11 +51,11 @@ Once on Embassy's web page, you can choose what services to install. Then, each
|
||||
|
||||
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?
|
||||
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 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 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:
|
||||
|
||||
* Install, uninstall, and upgrade services from a Marketplace (similar to your phone's app store)
|
||||
* Manage and run services that YOU own and control
|
||||
@@ -72,13 +72,13 @@ It includes:
|
||||
|
||||
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?
|
||||
What are embassyOS Services?
|
||||
----------------------------
|
||||
A Service can be any piece of software added to the Marketplace. Unlike "apps," services are (usually) "server-side" software, meaning they are intended to run 24/7/365 and listen for requests from your clients (apps). All services are "self-hosted," meaning that you are in complete control of your data. This means you can run your own "cloud!" Learn more about managing services :ref:`here <managing-services>` and see our currently `Available Services <https://marketplace.start9.com/>`_.
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
Does the Embassy have international electrical plugs?
|
||||
-----------------------------------------------------
|
||||
@@ -90,11 +90,11 @@ Yes.
|
||||
|
||||
Is the software Open Source?
|
||||
----------------------------
|
||||
Yes! EmbassyOS is open source under the `Start9 Personal Use License <https://start9.com/latest/about/license>`_. Some of our other projects are currently open sourced under MIT. You can find these in the Start9 `GitHub repository <https://github.com/Start9Labs>`_.
|
||||
Yes! embassyOS is open source under the `Start9 Personal Use License <https://start9.com/latest/about/license>`_. Some of our other projects are currently open sourced under MIT. You can find these in the Start9 `GitHub repository <https://github.com/Start9Labs>`_.
|
||||
|
||||
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.
|
||||
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?
|
||||
----------------------------
|
||||
@@ -115,9 +115,9 @@ What are you using for a store backend? Do you store my data?
|
||||
Here is our exact situation currently:
|
||||
Embassy device sales are processed through Shopify, which we do not like, but it was expedient in the early days, especially for shipping, so we went with it. Aside from a master list of email addresses for those who have explicitly opted in to our mailing list, all customer data is contained within Shopify. We do not duplicate it anywhere. We are asking Shopify to delete our customer data, but they claim it will take upward of 3 months to comply and we of course have no guarantee the data will actually be deleted permanently. This is partly why we exist...as such, we will be moving off of Shopify and onto a self-hosted solution, where Start9 alone controls our customer data for Embassy purchases, which we will delete as a matter of policy following a short grace period after delivery.
|
||||
|
||||
For EmbassyOS sales, we took the maximally private approach right out of the gate. When you buy EmbassyOS, the only thing we need is an email address, and you can only pay with bitcoin. That's it. Then, unless you have explicitly requested that we keep your email for mailing list purposes, we delete the email immediately upon transaction completion.
|
||||
For embassyOS sales, we took the maximally private approach right out of the gate. When you buy embassyOS, the only thing we need is an email address, and you can only pay with bitcoin. That's it. Then, unless you have explicitly requested that we keep your email for mailing list purposes, we delete the email immediately upon transaction completion.
|
||||
|
||||
So...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 buy EmbassyOS from us with bitcoin, which only requires an email, which is gets purged immediately.
|
||||
So...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 buy embassyOS from us with bitcoin, which only requires an email, which is gets purged immediately.
|
||||
|
||||
I want to help, but I'm not a developer. Are there any ways for non-coders to contribute?
|
||||
------------------------------------------------------------------------------------------
|
||||
|
||||
@@ -8,7 +8,7 @@ Packaging FAQ
|
||||
:depth: 2
|
||||
:local:
|
||||
|
||||
Do I need programming experience to package a service for EmbassyOS?
|
||||
Do I need programming experience to package a service for embassyOS?
|
||||
--------------------------------------------------------------------
|
||||
It would be helpful, but is not a pre-requisite. Linux, dev-ops, and/or systems administration experience would all be helpful as well. Keep in mind that everyone has to start somewhere, and perhaps your journey to development begins with packaging a service for EOS!
|
||||
|
||||
@@ -16,7 +16,7 @@ What considerations are there when choosing a service for packaging?
|
||||
--------------------------------------------------------------------
|
||||
There are several things you will want to consider. Requirements include:
|
||||
|
||||
#. Most importantly, pick a service you are passionate about seeing on EmbassyOS
|
||||
#. Most importantly, pick a service you are passionate about seeing on embassyOS
|
||||
#. Make sure it is :ref:`Open Source <open-source>`
|
||||
#. A service that incorporates a 'self-hosting' option, or is capable of being self-hosted
|
||||
|
||||
|
||||
@@ -26,7 +26,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 <https://github.com/awesome-selfhosted/awesome-selfhosted>`_ of self-hosted services, any of which can theoretically be run on EmbassyOS.
|
||||
Potentially. Here is a `comprehensive list <https://github.com/awesome-selfhosted/awesome-selfhosted>`_ 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?
|
||||
@@ -35,7 +35,7 @@ To get a general idea of what is required of an app, answer these questions:
|
||||
4. Does it ship with it's own web interface? Or is there a Tor-enabled client app?
|
||||
5. Is there someone willing to put in the time to package it up?
|
||||
|
||||
If all answers are yes, then it can run on EmbassyOS.
|
||||
If all answers are yes, then it can run on embassyOS.
|
||||
|
||||
Packing up a service for the Embassy does not require extensive development skills. If you are interested in doing do, please see our :ref:`Developer Docs <developer-docs>`.
|
||||
|
||||
@@ -80,7 +80,7 @@ I want to use BTCPayServer on my website, but Tor is the only option, how can vi
|
||||
--------------------------------------------------------------------------------------------------------------------
|
||||
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 <https://docs.btcpayserver.org/Deployment/ReverseProxyToTor/#reverse-proxy-to-tor/>`_.
|
||||
|
||||
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.
|
||||
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?
|
||||
--------------------------------------------------------------------------------
|
||||
|
||||
Reference in New Issue
Block a user