Start9/start-os
2
0
Fork 0
mirror of https://github.com/Start9Labs/start-os.git synced 2026-04-04 14:29:45 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update READMEs (#1885)

Browse Source 
* docs

* fix host key generation
This commit is contained in:
Aiden McClelland
2022-10-24 14:37:33 -06:00
parent 207020b7a0
commit 1cfd404321
4 changed files with 277 additions and 111 deletions
Download Patch File Download Diff File Expand all files Collapse all files

252
CONTRIBUTING.md
View File

@@ -1,11 +1,20 @@
<!-- omit in toc --> <!-- omit in toc -->
# Contributing to Embassy OS # Contributing to Embassy OS
First off, thanks for taking the time to contribute! ❤️ First off, thanks for taking the time to contribute! ❤️
All types of contributions are encouraged and valued. See the [Table of Contents](#table-of-contents) for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions. 🎉 All types of contributions are encouraged and valued. See the
[Table of Contents](#table-of-contents) for different ways to help and details
about how this project handles them. Please make sure to read the relevant
section before making your contribution. It will make it a lot easier for us
maintainers and smooth out the experience for all involved. The community looks
forward to your contributions. 🎉
> And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about: > And if you like the project, but just don't have time to contribute, that's
> fine. There are other easy ways to support the project and show your
> appreciation, which we would also be very happy about:
>
> - Star the project > - Star the project
> - Tweet about it > - Tweet about it
> - Refer this project in your project's readme > - Refer this project in your project's readme
@@ -13,6 +22,7 @@ All types of contributions are encouraged and valued. See the [Table of Contents
> - Buy an [Embassy](https://start9labs.com) > - Buy an [Embassy](https://start9labs.com)
<!-- omit in toc --> <!-- omit in toc -->
## Table of Contents ## Table of Contents
- [I Have a Question](#i-have-a-question) - [I Have a Question](#i-have-a-question)
@@ -33,15 +43,19 @@ All types of contributions are encouraged and valued. See the [Table of Contents
- [Join The Discussion](#join-the-discussion) - [Join The Discussion](#join-the-discussion)
- [Join The Project Team](#join-the-project-team) - [Join The Project Team](#join-the-project-team)
## I Have a Question ## I Have a Question
> If you want to ask a question, we assume that you have read the available [Documentation](https://docs.start9labs.com). > If you want to ask a question, we assume that you have read the available
> [Documentation](https://docs.start9labs.com).
Before you ask a question, it is best to search for existing [Issues](https://github.com/Start9Labs/embassy-os/issues) that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first. Before you ask a question, it is best to search for existing
[Issues](https://github.com/Start9Labs/embassy-os/issues) that might help you.
In case you have found a suitable issue and still need clarification, you can
write your question in this issue. It is also advisable to search the internet
for answers first.
If you then still feel the need to ask a question and need clarification, we recommend the following: If you then still feel the need to ask a question and need clarification, we
recommend the following:
- Open an [Issue](https://github.com/Start9Labs/embassy-os/issues/new). - Open an [Issue](https://github.com/Start9Labs/embassy-os/issues/new).
- Provide as much context as you can about what you're running into. - Provide as much context as you can about what you're running into.
@@ -67,100 +81,180 @@ Depending on how large the project is, you may want to outsource the questioning
## I Want To Contribute ## I Want To Contribute
> ### Legal Notice <!-- omit in toc --> > ### Legal Notice <!-- omit in toc -->
> When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license. >
> When contributing to this project, you must agree that you have authored 100%
> of the content, that you have the necessary rights to the content and that the
> content you contribute may be provided under the project license.
### Reporting Bugs ### Reporting Bugs
<!-- omit in toc --> <!-- omit in toc -->
#### Before Submitting a Bug Report #### Before Submitting a Bug Report
A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible. A good bug report shouldn't leave others needing to chase you up for more
information. Therefore, we ask you to investigate carefully, collect information
and describe the issue in detail in your report. Please complete the following
steps in advance to help us fix any potential bug as fast as possible.
- Make sure that you are using the latest version. - Make sure that you are using the latest version.
- Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions (Make sure that you have read the [documentation](https://start9.com/latest/user-manual). If you are looking for support, you might want to check [this section](#i-have-a-question)). - Determine if your bug is really a bug and not an error on your side e.g. using
- To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the [bug tracker](https://github.com/Start9Labs/embassy-os/issues?q=label%3Abug). incompatible environment components/versions (Make sure that you have read the
- Also make sure to search the internet (including Stack Overflow) to see if users outside of the GitHub community have discussed the issue. [documentation](https://start9.com/latest/user-manual). If you are looking for
support, you might want to check [this section](#i-have-a-question)).
- To see if other users have experienced (and potentially already solved) the
same issue you are having, check if there is not already a bug report existing
for your bug or error in the
[bug tracker](https://github.com/Start9Labs/embassy-os/issues?q=label%3Abug).
- Also make sure to search the internet (including Stack Overflow) to see if
users outside of the GitHub community have discussed the issue.
- Collect information about the bug: - Collect information about the bug:
- Stack trace (Traceback) - Stack trace (Traceback)
- Client OS, Platform and Version (Windows/Linux/macOS/iOS/Android, Firefox/Tor Browser/Consulate) - Client OS, Platform and Version (Windows/Linux/macOS/iOS/Android,
- Version of the interpreter, compiler, SDK, runtime environment, package manager, depending on what seems relevant. Firefox/Tor Browser/Consulate)
- Version of the interpreter, compiler, SDK, runtime environment, package
manager, depending on what seems relevant.
- Possibly your input and the output - Possibly your input and the output
- Can you reliably reproduce the issue? And can you also reproduce it with older versions? - Can you reliably reproduce the issue? And can you also reproduce it with
older versions?
<!-- omit in toc --> <!-- omit in toc -->
#### How Do I Submit a Good Bug Report? #### How Do I Submit a Good Bug Report?
> You must never report security related issues, vulnerabilities or bugs to the issue tracker, or elsewhere in public. Instead sensitive bugs must be sent by email to <security@start9labs.com>. > You must never report security related issues, vulnerabilities or bugs to the
> issue tracker, or elsewhere in public. Instead sensitive bugs must be sent by
> email to <security@start9labs.com>.
<!-- You may add a PGP key to allow the messages to be sent encrypted as well. --> <!-- You may add a PGP key to allow the messages to be sent encrypted as well. -->
We use GitHub issues to track bugs and errors. If you run into an issue with the project: We use GitHub issues to track bugs and errors. If you run into an issue with the
project:
- Open an [Issue](https://github.com/Start9Labs/embassy-os/issues/new/choose) selecting the appropriate type. - Open an [Issue](https://github.com/Start9Labs/embassy-os/issues/new/choose)
selecting the appropriate type.
- Explain the behavior you would expect and the actual behavior. - Explain the behavior you would expect and the actual behavior.
- Please provide as much context as possible and describe the *reproduction steps* that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem and create a reduced test case. - Please provide as much context as possible and describe the _reproduction
steps_ that someone else can follow to recreate the issue on their own. This
usually includes your code. For good bug reports you should isolate the
problem and create a reduced test case.
- Provide the information you collected in the previous section. - Provide the information you collected in the previous section.
Once it's filed: Once it's filed:
- The project team will label the issue accordingly. - The project team will label the issue accordingly.
- A team member will try to reproduce the issue with your provided steps. If there are no reproduction steps or no obvious way to reproduce the issue, the team will ask you for those steps and mark the issue as `Question`. Bugs with the `Question` tag will not be addressed until they are answered. - A team member will try to reproduce the issue with your provided steps. If
- If the team is able to reproduce the issue, it will be marked a scoping level tag, as well as possibly other tags (such as `Security`), and the issue will be left to be [implemented by someone](#your-first-code-contribution). there are no reproduction steps or no obvious way to reproduce the issue, the
team will ask you for those steps and mark the issue as `Question`. Bugs with
the `Question` tag will not be addressed until they are answered.
- If the team is able to reproduce the issue, it will be marked a scoping level
tag, as well as possibly other tags (such as `Security`), and the issue will
be left to be [implemented by someone](#your-first-code-contribution).
<!-- You might want to create an issue template for bugs and errors that can be used as a guide and that defines the structure of the information to be included. If you do so, reference it here in the description. --> <!-- You might want to create an issue template for bugs and errors that can be used as a guide and that defines the structure of the information to be included. If you do so, reference it here in the description. -->
### Suggesting Enhancements ### Suggesting Enhancements
This section guides you through submitting an enhancement suggestion for Embassy OS, **including completely new features and minor improvements to existing functionality**. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions. This section guides you through submitting an enhancement suggestion for Embassy
OS, **including completely new features and minor improvements to existing
functionality**. Following these guidelines will help maintainers and the
community to understand your suggestion and find related suggestions.
<!-- omit in toc --> <!-- omit in toc -->
#### Before Submitting an Enhancement #### Before Submitting an Enhancement
- Make sure that you are using the latest version. - Make sure that you are using the latest version.
- Read the [documentation](https://start9.com/latest/user-manual) carefully and find out if the functionality is already covered, maybe by an individual configuration. - Read the [documentation](https://start9.com/latest/user-manual) carefully and
- Perform a [search](https://github.com/Start9Labs/embassy-os/issues) to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one. find out if the functionality is already covered, maybe by an individual
- Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset. If you're just targeting a minority of users, consider writing an add-on/plugin library. configuration.
- Perform a [search](https://github.com/Start9Labs/embassy-os/issues) to see if
the enhancement has already been suggested. If it has, add a comment to the
existing issue instead of opening a new one.
- Find out whether your idea fits with the scope and aims of the project. It's
up to you to make a strong case to convince the project's developers of the
merits of this feature. Keep in mind that we want features that will be useful
to the majority of our users and not just a small subset. If you're just
targeting a minority of users, consider writing an add-on/plugin library.
<!-- omit in toc --> <!-- omit in toc -->
#### How Do I Submit a Good Enhancement Suggestion? #### How Do I Submit a Good Enhancement Suggestion?
Enhancement suggestions are tracked as [GitHub issues](https://github.com/Start9Labs/embassy-os/issues). Enhancement suggestions are tracked as
[GitHub issues](https://github.com/Start9Labs/embassy-os/issues).
- Use a **clear and descriptive title** for the issue to identify the suggestion. - Use a **clear and descriptive title** for the issue to identify the
- Provide a **step-by-step description of the suggested enhancement** in as many details as possible. suggestion.
- **Describe the current behavior** and **explain which behavior you expected to see instead** and why. At this point you can also tell which alternatives do not work for you. - Provide a **step-by-step description of the suggested enhancement** in as many
- You may want to **include screenshots and animated GIFs** which help you demonstrate the steps or point out the part which the suggestion is related to. You can use [this tool](https://www.cockos.com/licecap/) to record GIFs on macOS and Windows, and [this tool](https://github.com/colinkeenan/silentcast) or [this tool](https://github.com/GNOME/byzanz) on Linux. <!-- this should only be included if the project has a GUI --> details as possible.
- **Explain why this enhancement would be useful** to most Embassy OS users. You may also want to point out the other projects that solved it better and which could serve as inspiration. - **Describe the current behavior** and **explain which behavior you expected to
see instead** and why. At this point you can also tell which alternatives do
not work for you.
- You may want to **include screenshots and animated GIFs** which help you
demonstrate the steps or point out the part which the suggestion is related
to. You can use [this tool](https://www.cockos.com/licecap/) to record GIFs on
macOS and Windows, and [this tool](https://github.com/colinkeenan/silentcast)
or [this tool](https://github.com/GNOME/byzanz) on Linux.
<!-- this should only be included if the project has a GUI -->
- **Explain why this enhancement would be useful** to most Embassy OS users. You
may also want to point out the other projects that solved it better and which
could serve as inspiration.
<!-- You might want to create an issue template for enhancement suggestions that can be used as a guide and that defines the structure of the information to be included. If you do so, reference it here in the description. --> <!-- You might want to create an issue template for enhancement suggestions that can be used as a guide and that defines the structure of the information to be included. If you do so, reference it here in the description. -->
### Project Structure ### Project Structure
embassyOS is composed of the following components. Please visit the README for each component to understand the dependency requirements and installation instructions. embassyOS is composed of the following components. Please visit the README for
- [`ui`](frontend/README.md) (Typescript Ionic Angular) is the code that is deployed to the browser to provide the user interface for embassyOS. each component to understand the dependency requirements and installation
- [`backend`](backend/README.md) (Rust) is a command line utility, daemon, and software development kit that sets up and manages services and their environments, provides the interface for the ui, manages system state, and provides utilities for packaging services for embassyOS. instructions.
- `patch-db` - A diff based data store that is used to synchronize data between the front and backend.
- Notably, `patch-db` has a [client](https://github.com/Start9Labs/patch-db/tree/master/client) with its own dependency and installation requirements. - [`backend`](backend/README.md) (Rust) is a command line utility, daemon, and
- `rpc-toolkit` - A library for generating an rpc server with cli bindings from Rust functions. software development kit that sets up and manages services and their
- `system-images` - (Docker, Rust) A suite of utility Docker images that are preloaded with embassyOS to assist with functions relating to services (eg. configuration, backups, health checks). environments, provides the interface for the ui, manages system state, and
- [`setup-wizard`](frontend/README.md)- Code for the user interface that is displayed during the setup and recovery process for embassyOS. provides utilities for packaging services for embassyOS.
- [`diagnostic-ui`](frontend/README.md) - Code for the user interface that is displayed when something has gone wrong with starting up embassyOS, which provides helpful debugging tools. - [`build`](build/README.md) contains scripts and necessary for deploying
embassyOS to a debian/raspbian system.
- [`frontend`](frontend/README.md) (Typescript Ionic Angular) is the code that
is deployed to the browser to provide the user interface for embassyOS.
- `projects/ui` - Code for the user interface that is displayed when embassyOS
is running normally.
- `projects/setup-wizard`(frontend/README.md) - Code for the user interface
that is displayed during the setup and recovery process for embassyOS.
- `projects/diagnostic-ui` - Code for the user interface that is displayed
when something has gone wrong with starting up embassyOS, which provides
helpful debugging tools.
- `libs` (Rust) is a set of standalone crates that were separated out of
`backend` for the purpose of portability
- `patch-db` - A diff based data store that is used to synchronize data between
the front and backend.
- Notably, `patch-db` has a
[client](https://github.com/Start9Labs/patch-db/tree/master/client) with its
own dependency and installation requirements.
- `system-images` - (Docker, Rust) A suite of utility Docker images that are
preloaded with embassyOS to assist with functions relating to services (eg.
configuration, backups, health checks).
### Your First Code Contribution ### Your First Code Contribution
#### Setting Up Your Development Environment #### Setting Up Your Development Environment
First, clone the embassyOS repository and from the project root, pull in the submodules for dependent libraries. First, clone the embassyOS repository and from the project root, pull in the
submodules for dependent libraries.
```sh ```sh
git clone https://github.com/Start9Labs/embassy-os.git git clone https://github.com/Start9Labs/embassy-os.git
git submodule update --init --recursive git submodule update --init --recursive
``` ```
Depending on which component of the ecosystem you are interested in contributing to, follow the installation requirements listed in that component's README (linked [above](#project-structure)) Depending on which component of the ecosystem you are interested in contributing
to, follow the installation requirements listed in that component's README
(linked [above](#project-structure))
#### Building The Image #### Building The Raspberry Pi Image
This step is for setting up an environment in which to test your code changes if you do not yet have a embassyOS.
This step is for setting up an environment in which to test your code changes if
you do not yet have a embassyOS.
- Requirements - Requirements
- `ext4fs` (available if running on the Linux kernel) - `ext4fs` (available if running on the Linux kernel)
@@ -168,41 +262,79 @@ This step is for setting up an environment in which to test your code changes if
- GNU Make - GNU Make
- Building - Building
- see setup instructions [here](build/README.md) - see setup instructions [here](build/README.md)
- run `make` from the project root - run `make embassyos-raspi.img ARCH=aarch64` from the project root
### Improving The Documentation ### Improving The Documentation
You can find the repository for Start9's documentation [here](https://github.com/Start9Labs/documentation). If there is something you would like to see added, let us know, or create an issue yourself. Welcome are contributions for lacking or incorrect information, broken links, requested additions, or general style improvements.
Contributions in the form of setup guides for integrations with external applications are highly encouraged. If you struggled through a process and would like to share your steps with others, check out the docs for each [service](https://github.com/Start9Labs/documentation/blob/master/source/user-manuals/available-services/index.rst) we support. The wrapper repos contain sections for adding integration guides, such as this [one](https://github.com/Start9Labs/bitcoind-wrapper/tree/master/docs). These not only help out others in the community, but inform how we can create a more seamless and intuitive experience. You can find the repository for Start9's documentation
[here](https://github.com/Start9Labs/documentation). If there is something you
would like to see added, let us know, or create an issue yourself. Welcome are
contributions for lacking or incorrect information, broken links, requested
additions, or general style improvements.
Contributions in the form of setup guides for integrations with external
applications are highly encouraged. If you struggled through a process and would
like to share your steps with others, check out the docs for each
[service](https://github.com/Start9Labs/documentation/blob/master/source/user-manuals/available-services/index.rst)
we support. The wrapper repos contain sections for adding integration guides,
such as this
[one](https://github.com/Start9Labs/bitcoind-wrapper/tree/master/docs). These
not only help out others in the community, but inform how we can create a more
seamless and intuitive experience.
## Styleguides ## Styleguides
### Formatting ### Formatting
Each component of embassyOS contains its own style guide. Code must be formatted with the formatter designated for each component. These are outlined within each component folder's README.
Each component of embassyOS contains its own style guide. Code must be formatted
with the formatter designated for each component. These are outlined within each
component folder's README.
### Atomic Commits ### Atomic Commits
Commits [should be atomic](https://en.wikipedia.org/wiki/Atomic_commit#Atomic_commit_convention) and diffs should be easy to read.
Do not mix any formatting fixes or code moves with actual code changes. Commits
[should be atomic](https://en.wikipedia.org/wiki/Atomic_commit#Atomic_commit_convention)
and diffs should be easy to read. Do not mix any formatting fixes or code moves
with actual code changes.
### Commit Messages ### Commit Messages
If a commit touches only 1 component, prefix the message with the affected component. i.e. `backend: update to tokio v0.3`.
If a commit touches only 1 component, prefix the message with the affected
component. i.e. `backend: update to tokio v0.3`.
### Pull Requests ### Pull Requests
The body of a pull request should contain sufficient description of what the changes do, as well as a justification.
You should include references to any relevant [issues](https://github.com/Start9Labs/embassy-os/issues). The body of a pull request should contain sufficient description of what the
changes do, as well as a justification. You should include references to any
relevant [issues](https://github.com/Start9Labs/embassy-os/issues).
### Rebasing Changes ### Rebasing Changes
When a pull request conflicts with the target branch, you may be asked to rebase it on top of the current target branch. The `git rebase` command will take care of rebuilding your commits on top of the new base.
This project aims to have a clean git history, where code changes are only made in non-merge commits. This simplifies auditability because merge commits can be assumed to not contain arbitrary code changes. When a pull request conflicts with the target branch, you may be asked to rebase
it on top of the current target branch. The `git rebase` command will take care
of rebuilding your commits on top of the new base.
This project aims to have a clean git history, where code changes are only made
in non-merge commits. This simplifies auditability because merge commits can be
assumed to not contain arbitrary code changes.
## Join The Discussion ## Join The Discussion
Current or aspiring contributors? Join our community developer [Matrix channel](https://matrix.to/#/#community-dev:matrix.start9labs.com).
Just interested in or using the project? Join our community [Telegram](https://t.me/start9_labs) or [Matrix](https://matrix.to/#/#community:matrix.start9labs.com). Current or aspiring contributors? Join our community developer
[Matrix channel](https://matrix.to/#/#community-dev:matrix.start9labs.com).
Just interested in or using the project? Join our community
[Telegram](https://t.me/start9_labs) or
[Matrix](https://matrix.to/#/#community:matrix.start9labs.com).
## Join The Project Team ## Join The Project Team
Interested in becoming a part of the Start9 Labs team? Send an email to <jobs@start9labs.com>
Interested in becoming a part of the Start9 Labs team? Send an email to
<jobs@start9labs.com>
<!-- omit in toc --> <!-- omit in toc -->
## Attribution ## Attribution
This guide is based on the **contributing-gen**. [Make your own](https://github.com/bttger/contributing-gen)!
This guide is based on the **contributing-gen**.
[Make your own](https://github.com/bttger/contributing-gen)!

24
backend/README.md
View File

@@ -6,18 +6,22 @@
- [Docker](https://docs.docker.com/get-docker/) - [Docker](https://docs.docker.com/get-docker/)
- [Rust ARM64 Build Container](https://github.com/Start9Labs/rust-arm-builder) - [Rust ARM64 Build Container](https://github.com/Start9Labs/rust-arm-builder)
- Scripts (run withing the `./backend` directory) - Scripts (run withing the `./backend` directory)
- `build-prod.sh` - compiles a release build of the artifacts for running on ARM64 - `build-prod.sh` - compiles a release build of the artifacts for running on
- `build-dev.sh` - compiles a development build of the artifacts for running on ARM64 ARM64
- A Linux computer or VM - A Linux computer or VM
## Structure ## Structure
The embassyOS backend is broken up into 4 different binaries: The embassyOS backend is broken up into 4 different binaries:
- embassyd: This is the main workhorse of embassyOS - any new functionality you want will likely go here - embassyd: This is the main workhorse of embassyOS - any new functionality you
- embassy-init: This is the component responsible for allowing you to set up your device, and handles system initialization on startup want will likely go here
- embassy-cli: This is a CLI tool that will allow you to issue commands to embassyd and control it similarly to the UI - embassy-init: This is the component responsible for allowing you to set up
- embassy-sdk: This is a CLI tool that aids in building and packaging services you wish to deploy to the Embassy your device, and handles system initialization on startup
- embassy-cli: This is a CLI tool that will allow you to issue commands to
embassyd and control it similarly to the UI
- embassy-sdk: This is a CLI tool that aids in building and packaging services
you wish to deploy to the Embassy
Finally there is a library `embassy` that supports all four of these tools. Finally there is a library `embassy` that supports all four of these tools.
@@ -25,11 +29,15 @@ See [here](/backend/Cargo.toml) for details.
## Building ## Building
You can build the entire operating system image using `make` from the root of the embassyOS project. This will subsequently invoke the build scripts above to actually create the requisite binaries and put them onto the final operating system image. You can build the entire operating system image using `make` from the root of
the embassyOS project. This will subsequently invoke the build scripts above to
actually create the requisite binaries and put them onto the final operating
system image.
## Questions ## Questions
If you have questions about how various pieces of the backend system work. Open an issue and tag the following people If you have questions about how various pieces of the backend system work. Open
an issue and tag the following people
- dr-bonez - dr-bonez
- ProofOfKeags - ProofOfKeags

108
build/README.md
View File

@@ -1,79 +1,107 @@
# Building Embassy OS # Building Embassy OS
⚠️ The commands given assume a Debian or Ubuntu-based environment. *Building in a VM is NOT yet supported* ⚠️ ⚠️ The commands given assume a Debian or Ubuntu-based environment. _Building in
a VM is NOT yet supported_ ⚠️
## Prerequisites ## Prerequisites
1. Install dependencies 1. Install dependencies
- Avahi - Avahi
- `sudo apt install -y avahi-daemon` - `sudo apt install -y avahi-daemon`
- Installed by default on most Debian systems - https://avahi.org - Installed by default on most Debian systems - https://avahi.org
- Build Essentials (needed to run `make`) - Build Essentials (needed to run `make`)
- `sudo apt install -y build-essential` - `sudo apt install -y build-essential`
- Docker - Docker
- `curl -fsSL https://get.docker.com | sh` - `curl -fsSL https://get.docker.com | sh`
- https://docs.docker.com/get-docker - https://docs.docker.com/get-docker
- Add your user to the docker group: `sudo usermod -a -G docker $USER` - Add your user to the docker group: `sudo usermod -a -G docker $USER`
- Reload user environment `exec sudo su -l $USER` - Reload user environment `exec sudo su -l $USER`
- Prepare Docker environment - Prepare Docker environment
- Setup buildx (https://docs.docker.com/buildx/working-with-buildx/) - Setup buildx (https://docs.docker.com/buildx/working-with-buildx/)
- Create a builder: `docker buildx create --use` - Create a builder: `docker buildx create --use`
- Add multi-arch build ability: `docker run --rm --privileged linuxkit/binfmt:v0.8` - Add multi-arch build ability:
`docker run --rm --privileged linuxkit/binfmt:v0.8`
- Node Version 12+ - Node Version 12+
- snap: `sudo snap install node` - snap: `sudo snap install node`
- [nvm](https://github.com/nvm-sh/nvm#installing-and-updating): `nvm install --lts` - [nvm](https://github.com/nvm-sh/nvm#installing-and-updating):
- https://nodejs.org/en/docs `nvm install --lts`
- https://nodejs.org/en/docs
- NPM Version 7+ - NPM Version 7+
- apt: `sudo apt install -y npm` - apt: `sudo apt install -y npm`
- [nvm](https://github.com/nvm-sh/nvm#installing-and-updating): `nvm install --lts` - [nvm](https://github.com/nvm-sh/nvm#installing-and-updating):
- https://docs.npmjs.com/downloading-and-installing-node-js-and-npm `nvm install --lts`
- https://docs.npmjs.com/downloading-and-installing-node-js-and-npm
- jq - jq
- `sudo apt install -y jq` - `sudo apt install -y jq`
- https://stedolan.github.io/jq - https://stedolan.github.io/jq
- yq - yq
- snap: `sudo snap install yq` - snap: `sudo snap install yq`
- binaries: https://github.com/mikefarah/yq/releases/ - binaries: https://github.com/mikefarah/yq/releases/
- https://mikefarah.gitbook.io/yq - https://mikefarah.gitbook.io/yq
2. Clone the latest repo with required submodules 2. Clone the latest repo with required submodules
> :information_source: You chan check latest available version [here](https://github.com/Start9Labs/embassy-os/releases) > :information_source: You chan check latest available version
``` > [here](https://github.com/Start9Labs/embassy-os/releases)
git clone --recursive https://github.com/Start9Labs/embassy-os.git --branch latest ```
``` git clone --recursive https://github.com/Start9Labs/embassy-os.git --branch latest
```
## Build ## Build Raspberry Pi Image
``` ```
cd embassy-os cd embassy-os
make make embassyos-raspi.img ARCH=aarch64
``` ```
## Flash ## Flash
Flash the resulting `eos.img` to your SD Card (16GB required, any larger is neither necessary, nor advantageous) Flash the resulting `embassyos-raspi.img` to your SD Card
We recommend [Balena Etcher](https://www.balena.io/etcher/) We recommend [Balena Etcher](https://www.balena.io/etcher/)
## Setup ## Setup
Visit http://embassy.local from any web browser - We recommend [Firefox](https://www.mozilla.org/firefox/browsers) Visit http://embassy.local from any web browser - We recommend
[Firefox](https://www.mozilla.org/firefox/browsers)
Enter your product key. This is generated during the build process and can be found in `product_key.txt`, located in the root directory. Enter your product key. This is generated during the build process and can be
found in `product_key.txt`, located in the root directory.
## Troubleshooting ## Troubleshooting
1. I just flashed my SD card, fired up my Embassy, bootup sounds and all, but my browser is saying "Unable to connect" with embassy.local. 1. I just flashed my SD card, fired up my Embassy, bootup sounds and all, but my
browser is saying "Unable to connect" with embassy.local.
- Try doing a hard refresh on your browser, or opening the url in a private/incognito window. If you've ran an instance - Try doing a hard refresh on your browser, or opening the url in a
of Embassy before, sometimes you can have a stale cache that will block you from navigating to the page. private/incognito window. If you've ran an instance of Embassy before,
sometimes you can have a stale cache that will block you from navigating to
the page.
2. Flashing the image isn't working with balenaEtcher. I'm getting `Cannot read property 'message' of null` when I try. 2. Flashing the image isn't working with balenaEtcher. I'm getting
- The latest versions of Balena may not flash properly. This version here: https://github.com/balena-io/etcher/releases/tag/v1.5.122 should work properly. `Cannot read property 'message' of null` when I try.
3. Startup isn't working properly and I'm curious as to why. How can I view logs regarding startup for debugging? - The latest versions of Balena may not flash properly. This version here:
- During the Build step, instead of running just `make` run `ENVIRONMENT=dev make`. Flash like normal, and insert into your Embassy. Boot up your Embassy, and on another computer https://github.com/balena-io/etcher/releases/tag/v1.5.122 should work
on the same network, ssh into the Embassy with the username/password `ubuntu`. After logging in and changing the password, run `journalctl -u initialization.service -ef` to view the start up logs. properly.
3. Startup isn't working properly and I'm curious as to why. How can I view logs
regarding startup for debugging?
- Find the IP of your device
- Run `nc <ip> 8080` and it will print the logs
4. I need to ssh into my Embassy to fix something, but I cannot get to the
console to add ssh keys normally.
- During the Build step, instead of running just
`make embassyos-raspi.img ARCH=aarch64` run
`ENVIRONMENT=dev make embassyos-raspi.img ARCH=aarch64`. Flash like normal,
and insert into your Embassy. Boot up your Embassy, and on another computer on
the same network, ssh into the Embassy with the username `start9` password
`embassy`.
4. I need to reset my password, how can I do that? 4. I need to reset my password, how can I do that?
- At the time of writing, there is no way to do that in 0.3.0 cleanly. You'll need to reflash your device unfortunately.
- You will need to reflash your device. Select "Use Existing Drive" once you are
in setup, and it will prompt you to set a new password.

4
build/lib/scripts/install
View File

@@ -102,9 +102,7 @@ EOF
chroot /mnt/current systemd-machine-id-setup chroot /mnt/current systemd-machine-id-setup
# gen ssh host keys # gen ssh host keys
ssh-keygen -t rsa /mnt/current/etc/ssh_host_rsa_key chroot /mnt/current ssh-keygen -A
ssh-keygen -t ecdsa /mnt/current/etc/ssh_host_ecdsa_key
ssh-keygen -t ed25519 /mnt/current/etc/ssh_host_ed25519_key
mount --bind /dev /mnt/current/dev mount --bind /dev /mnt/current/dev
mount --bind /sys /mnt/current/sys mount --bind /sys /mnt/current/sys