mirror of
https://github.com/Start9Labs/documentation.git
synced 2026-03-26 02:11:55 +00:00
Fix/updates (#82)
* style updats * remove step from title * add contents for small screen submenu display * adjust footer
This commit is contained in:
Lucy C
@@ -4,6 +4,10 @@
|
||||
Privacy Policy
|
||||
==============
|
||||
|
||||
.. contents::
|
||||
:depth: 2
|
||||
:local:
|
||||
|
||||
General Principles
|
||||
------------------
|
||||
|
||||
|
||||
@@ -4,6 +4,10 @@
|
||||
Start9 Labs
|
||||
===========
|
||||
|
||||
.. contents::
|
||||
:depth: 2
|
||||
:local:
|
||||
|
||||
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:
|
||||
|
||||
@@ -1,8 +1,12 @@
|
||||
.. _packaging-framework:
|
||||
|
||||
==================
|
||||
Step 1 - Framework
|
||||
==================
|
||||
=============
|
||||
1 - Framework
|
||||
=============
|
||||
|
||||
.. contents::
|
||||
:depth: 2
|
||||
:local:
|
||||
|
||||
What we'll build
|
||||
----------------
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
.. _packaging-create-service:
|
||||
|
||||
=======================
|
||||
Step 2 - Create Service
|
||||
=======================
|
||||
==================
|
||||
2 - Create Service
|
||||
==================
|
||||
|
||||
For this example, we are going to create a simple Rust project that serves a static web page.
|
||||
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
.. _packaging-compile-raspi:
|
||||
|
||||
=======================
|
||||
Step 3 - Hardware Build
|
||||
=======================
|
||||
==================
|
||||
3 - Hardware Build
|
||||
==================
|
||||
|
||||
EmbassyOS is run on the arm-v8 architecture, specifically the aarch64 state, for the RaspberryPi.
|
||||
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
.. _packaging-docker-build:
|
||||
|
||||
=====================
|
||||
Step 4 - Docker Build
|
||||
=====================
|
||||
================
|
||||
4 - Docker Build
|
||||
================
|
||||
|
||||
Now that we have our code properly built/compiled, we can create a Dockerfile. This file defines how to build the Docker image for the service by declaring the environment, building stages, and copying any binaries or assets needed to run the service to the Docker image filesystem.
|
||||
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
.. _packaging-create-manifest:
|
||||
|
||||
========================
|
||||
Step 5 - Create Manifest
|
||||
========================
|
||||
===================
|
||||
5 - Create Manifest
|
||||
===================
|
||||
|
||||
The Manifest file specifies the details EmbassyOS needs to operate a service. It is the connection point between your service and EmbassyOS.
|
||||
|
||||
|
||||
@@ -1,8 +1,12 @@
|
||||
.. _packaging-create-assets:
|
||||
|
||||
======================
|
||||
Step 6 - Create Assets
|
||||
======================
|
||||
=================
|
||||
6 - Create Assets
|
||||
=================
|
||||
|
||||
.. contents::
|
||||
:depth: 2
|
||||
:local:
|
||||
|
||||
Each ``s9pk`` package contains a set of assets. They include:
|
||||
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
.. _packaging-create-s9pk:
|
||||
|
||||
=======================
|
||||
Step 7 - Format Package
|
||||
=======================
|
||||
==================
|
||||
7 - Format Package
|
||||
==================
|
||||
|
||||
We now have all of the necessary components to package the service into the format needed for the OS. This format is a custom filetype with an extension of ``.s9pk``, short for Start9 Package.
|
||||
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
.. _packaging-makefile:
|
||||
|
||||
========================
|
||||
Step 8 - Create Makefile
|
||||
========================
|
||||
===================
|
||||
8 - Create Makefile
|
||||
===================
|
||||
|
||||
For convenience and repeatability, let's combine all of these commands into a Makefile. Then, we can use `make <https://www.gnu.org/software/make/>`_ to rebuild our project quickly.
|
||||
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
.. _packaging-create-wrapper:
|
||||
|
||||
=======================
|
||||
Step 9 - Create Wrapper
|
||||
=======================
|
||||
==================
|
||||
9 - Create Wrapper
|
||||
==================
|
||||
|
||||
In order for the Start9 team to review your package for submission to the Start9 Marketplace, we ask that you create a wrapper repository for the project and its components. This repo should contain everything you need to build the service.
|
||||
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
.. _packaging-install:
|
||||
|
||||
=================
|
||||
Step 10 - Install
|
||||
=================
|
||||
============
|
||||
10 - Install
|
||||
============
|
||||
|
||||
Now that we have a process for iterating on producing a valid package for EmbassyOS, let's load it onto an Embassy!
|
||||
|
||||
|
||||
@@ -4,6 +4,10 @@
|
||||
Resources
|
||||
=========
|
||||
|
||||
.. contents::
|
||||
:depth: 2
|
||||
:local:
|
||||
|
||||
Get help
|
||||
--------
|
||||
|
||||
|
||||
@@ -1,8 +1,12 @@
|
||||
.. _packaging-quick-start:
|
||||
|
||||
=====================
|
||||
Packaging Quick Start
|
||||
=====================
|
||||
=========
|
||||
Checklist
|
||||
=========
|
||||
|
||||
.. contents::
|
||||
:depth: 2
|
||||
:local:
|
||||
|
||||
This guide outlines a checklist of steps to complete in order to package a service for EmbassyOS. For a more in depth example, visit the :ref:`build your first package <build-package-example>` guide.
|
||||
|
||||
@@ -4,6 +4,10 @@
|
||||
Environment Setup
|
||||
=================
|
||||
|
||||
.. contents::
|
||||
:depth: 2
|
||||
:local:
|
||||
|
||||
To get started packaging a service for EmbassyOS, some basic knowledge of software development is required. Don't worry if you are inexperienced, we will provide enough context to get you started, and you can always reach out with questions.
|
||||
|
||||
If you are already an experienced developer, :ref:`jump ahead <environment-quick-start>`.
|
||||
|
||||
@@ -60,4 +60,4 @@ Getting Started Overview
|
||||
|
||||
environment-setup
|
||||
sdk
|
||||
quick-start
|
||||
checklist
|
||||
@@ -15,7 +15,7 @@ Due to the fact that config variables are only available when the service is run
|
||||
Service Properties
|
||||
|
||||
|
||||
.. code-block:: javascript
|
||||
.. code-block:: TypeScript
|
||||
:caption: Properties Type
|
||||
|
||||
interface Properties {
|
||||
|
||||
@@ -4,6 +4,10 @@
|
||||
DIY Guide
|
||||
=========
|
||||
|
||||
.. contents::
|
||||
:depth: 2
|
||||
:local:
|
||||
|
||||
.. figure:: /_static/images/diy/pi.png
|
||||
:width: 40%
|
||||
:alt: Raspberry Pi
|
||||
|
||||
@@ -4,6 +4,10 @@
|
||||
Bitcoin and Lightning
|
||||
=====================
|
||||
|
||||
.. contents::
|
||||
:depth: 2
|
||||
:local:
|
||||
|
||||
.. _bitcoin:
|
||||
|
||||
Bitcoin
|
||||
|
||||
@@ -4,6 +4,10 @@
|
||||
Embassy and EmbassyOS
|
||||
=====================
|
||||
|
||||
.. contents::
|
||||
:depth: 2
|
||||
:local:
|
||||
|
||||
.. _embassy:
|
||||
|
||||
Embassy
|
||||
|
||||
@@ -4,6 +4,10 @@
|
||||
Networks
|
||||
========
|
||||
|
||||
.. contents::
|
||||
:depth: 2
|
||||
:local:
|
||||
|
||||
.. _lan:
|
||||
|
||||
LAN
|
||||
|
||||
@@ -4,6 +4,10 @@
|
||||
Open Source
|
||||
===========
|
||||
|
||||
.. contents::
|
||||
:depth: 2
|
||||
:local:
|
||||
|
||||
The Internet itself was built on free and publicly available code, with the values of collaboration, peer review, communication, and openness built into its very foundation. This decentralized model evolved into the open source movement, which uses these values to discover new ways to solve problems across boundaries and industries.
|
||||
|
||||
Open source software centered around the concept of user freedoms: freedom to see, modify, and redistribute the code to make it work for the user in whatever way they needed. It does not necessarily mean free to use. It means that the software will be better, cheaper, and more flexible if it is freely accessible, openly modifiable, and shared.
|
||||
|
||||
@@ -4,6 +4,10 @@
|
||||
Hosting
|
||||
=======
|
||||
|
||||
.. contents::
|
||||
:depth: 2
|
||||
:local:
|
||||
|
||||
Client-Server Model
|
||||
-------------------
|
||||
|
||||
|
||||
@@ -4,6 +4,10 @@
|
||||
Common Issues
|
||||
=============
|
||||
|
||||
.. contents::
|
||||
:depth: 2
|
||||
:local:
|
||||
|
||||
Sometimes things don't go as planned. Check here for solutions to common problems with your Embassy.
|
||||
|
||||
Embassy will not boot
|
||||
|
||||
@@ -4,6 +4,10 @@
|
||||
Contact Us
|
||||
==========
|
||||
|
||||
.. contents::
|
||||
:depth: 2
|
||||
:local:
|
||||
|
||||
Community Channels
|
||||
------------------
|
||||
|
||||
|
||||
@@ -4,6 +4,10 @@
|
||||
EOS Version 0.3.0 FAQ
|
||||
=====================
|
||||
|
||||
.. contents::
|
||||
:depth: 2
|
||||
:local:
|
||||
|
||||
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.
|
||||
|
||||
@@ -4,6 +4,10 @@
|
||||
Basic Use FAQ
|
||||
=============
|
||||
|
||||
.. contents::
|
||||
:depth: 2
|
||||
:local:
|
||||
|
||||
Is it easy to use?
|
||||
------------------
|
||||
Yes! The Embassy is designed to be plugged into power and internet, and after a short setup, is immediately ready to use. Getting Services is as easy as getting apps for a smartphone.
|
||||
|
||||
@@ -4,6 +4,10 @@
|
||||
Bitcoin FAQ
|
||||
===========
|
||||
|
||||
.. contents::
|
||||
:depth: 2
|
||||
:local:
|
||||
|
||||
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 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.
|
||||
|
||||
@@ -4,6 +4,10 @@
|
||||
Contributing FAQ
|
||||
================
|
||||
|
||||
.. contents::
|
||||
:depth: 2
|
||||
:local:
|
||||
|
||||
We ❤️ contributions!
|
||||
|
||||
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.
|
||||
|
||||
@@ -4,6 +4,10 @@
|
||||
Embassy FAQ
|
||||
===========
|
||||
|
||||
.. contents::
|
||||
:depth: 2
|
||||
:local:
|
||||
|
||||
Can I run EmbassyOS on a VPS or VM?
|
||||
-----------------------------------
|
||||
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.
|
||||
|
||||
@@ -4,6 +4,10 @@
|
||||
General FAQ
|
||||
===========
|
||||
|
||||
.. contents::
|
||||
:depth: 2
|
||||
:local:
|
||||
|
||||
What is Start9Labs?
|
||||
-------------------
|
||||
Start9Labs is a small, but quickly growing group of builders based in Denver, CO that build Embassy and EmbassyOS.
|
||||
|
||||
@@ -4,6 +4,10 @@
|
||||
The Lightning Network FAQ
|
||||
=========================
|
||||
|
||||
.. contents::
|
||||
:depth: 2
|
||||
:local:
|
||||
|
||||
Why would I want to run a lightning node?
|
||||
-----------------------------------------
|
||||
The Lightning Network (LN) is a second 'layer,' built on top of the Bitcoin Protocol. As a result all transactions on LN are backed up by the full security of the Bitcoin network. Lightning is designed for instant payments between nodes, but similar to running a Bitcoin node, running your own is the only way to be sovereign. When you have your own node, you will have the convenience of linking a Lightning wallet, for use on the go. It is also possible to earn an income (granted a very small one at this time), if you are willing to learn how to become a 'routing node.'
|
||||
|
||||
@@ -1,13 +1,13 @@
|
||||
.. _faq-service-packaging:
|
||||
|
||||
.. contents::
|
||||
:depth: 3
|
||||
:local:
|
||||
|
||||
=============
|
||||
Packaging FAQ
|
||||
=============
|
||||
|
||||
.. contents::
|
||||
:depth: 2
|
||||
:local:
|
||||
|
||||
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!
|
||||
|
||||
@@ -4,6 +4,10 @@
|
||||
Services FAQ
|
||||
============
|
||||
|
||||
.. contents::
|
||||
:depth: 2
|
||||
:local:
|
||||
|
||||
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.
|
||||
|
||||
@@ -4,6 +4,10 @@
|
||||
Setup and Troubleshooting FAQ
|
||||
=============================
|
||||
|
||||
.. contents::
|
||||
:depth: 2
|
||||
:local:
|
||||
|
||||
What do I do first?
|
||||
-------------------
|
||||
Please check out the :ref:`Initial Setup <initial-setup>` page, and follow the instructions.
|
||||
|
||||
@@ -4,6 +4,10 @@
|
||||
Backup
|
||||
======
|
||||
|
||||
.. contents::
|
||||
:depth: 2
|
||||
:local:
|
||||
|
||||
Backing up your Embassy is easy and secure. Backups are encrypted with your master password.
|
||||
|
||||
.. warning:: Create frequent backups to avoid loss of data!
|
||||
|
||||
@@ -3,6 +3,10 @@
|
||||
=======================
|
||||
Linux LAN Shared Folder
|
||||
=======================
|
||||
|
||||
.. contents::
|
||||
:depth: 2
|
||||
:local:
|
||||
|
||||
Use this guide to setup a LAN Shared folder on your Linux machine, such that you may create encrypted, private backups of all your Embassy data.
|
||||
|
||||
|
||||
@@ -4,6 +4,10 @@
|
||||
Mac LAN Shared Folder
|
||||
=====================
|
||||
|
||||
.. contents::
|
||||
:depth: 2
|
||||
:local:
|
||||
|
||||
Use this guide to setup a LAN Shared Folder on your Mac (or attached drive), such that you may create encrypted, private backups of all your Embassy data.
|
||||
|
||||
Setup LAN Shared Folder
|
||||
|
||||
@@ -3,6 +3,10 @@
|
||||
==========================
|
||||
Synology LAN Shared Folder
|
||||
==========================
|
||||
|
||||
.. contents::
|
||||
:depth: 2
|
||||
:local:
|
||||
|
||||
.. note:: This guide was created by a Start9 community member. This is not yet officially supported. Please report any feedback that may help improve the process.
|
||||
|
||||
|
||||
@@ -4,6 +4,10 @@
|
||||
Windows LAN Shared Folder
|
||||
=========================
|
||||
|
||||
.. contents::
|
||||
:depth: 2
|
||||
:local:
|
||||
|
||||
Use this guide to setup a LAN Shared Folder on your Windows machine (or attached drive), such that you may create encrypted, private backups of all your Embassy data.
|
||||
|
||||
Setup LAN Shared Folder
|
||||
|
||||
@@ -4,4 +4,4 @@
|
||||
Configuring Firefox for Tor on iOS
|
||||
==================================
|
||||
|
||||
Unforutnately, it is not currently possible to run Tor natively on iOS. This means that Firefox cannot be configured to use tor. Please see :ref:`iOS Limitations<lim-ios>` for details and workarounds.
|
||||
Unfortunately, it is not currently possible to run Tor natively on iOS. This means that Firefox cannot be configured to use tor. Please see :ref:`iOS Limitations<lim-ios>` for details and workarounds.
|
||||
|
||||
@@ -4,6 +4,10 @@
|
||||
Customize
|
||||
=========
|
||||
|
||||
.. contents::
|
||||
:depth: 2
|
||||
:local:
|
||||
|
||||
Name Your Device
|
||||
----------------
|
||||
|
||||
|
||||
@@ -4,6 +4,10 @@
|
||||
Dashboard Overview
|
||||
==================
|
||||
|
||||
.. contents::
|
||||
:depth: 2
|
||||
:local:
|
||||
|
||||
Services Tab
|
||||
------------
|
||||
|
||||
|
||||
@@ -4,6 +4,10 @@
|
||||
Android
|
||||
=======
|
||||
|
||||
.. contents::
|
||||
:depth: 2
|
||||
:local:
|
||||
|
||||
LAN Access
|
||||
----------
|
||||
Android versions below 12 (as well as some custom ROMs, such as Graphene/Calyx) do not have native support for :ref:`mDNS<mdns>` and therefore cannot resolve ".local" addresses.
|
||||
|
||||
@@ -4,6 +4,10 @@
|
||||
iOS
|
||||
===
|
||||
|
||||
.. contents::
|
||||
:depth: 2
|
||||
:local:
|
||||
|
||||
Tor
|
||||
---
|
||||
It is not currently possible to run Tor natively (in the background) on iOS. This means that many iOS apps will be unable to connect to your Embassy. The best chance for a Tor background process on iOS in the future is via the `iCepa Project <https://github.com/iCepa>`_.
|
||||
|
||||
@@ -4,6 +4,10 @@
|
||||
Forgot Password
|
||||
===============
|
||||
|
||||
.. contents::
|
||||
:depth: 2
|
||||
:local:
|
||||
|
||||
.. note:: There is currently no way to reset you Embassy master password through a standard UI flow.
|
||||
|
||||
Using SSH
|
||||
|
||||
@@ -4,11 +4,19 @@
|
||||
Initial Setup
|
||||
=============
|
||||
|
||||
.. contents::
|
||||
:depth: 2
|
||||
:local:
|
||||
|
||||
Check out our quick setup video below, and follow along with the steps in this guide:
|
||||
|
||||
.. youtube:: DmTlwp5_zvY
|
||||
:width: 100%
|
||||
|
||||
.. raw:: html
|
||||
|
||||
<br>
|
||||
|
||||
Powering On
|
||||
-----------
|
||||
|
||||
|
||||
@@ -4,6 +4,10 @@
|
||||
Managing Services
|
||||
=================
|
||||
|
||||
.. contents::
|
||||
:depth: 2
|
||||
:local:
|
||||
|
||||
EmbassyOS provides a rich interface for managing installed Services.
|
||||
|
||||
Service Dashboard
|
||||
|
||||
@@ -4,6 +4,10 @@
|
||||
Bitcoin
|
||||
=======
|
||||
|
||||
.. contents::
|
||||
:depth: 2
|
||||
:local:
|
||||
|
||||
Here you will find guides on how to connect different kinds of Bitcoin wallets (hardware and software) to your Embassy node, to complete your sovereign Bitcoin stack!
|
||||
|
||||
Tested Wallets
|
||||
|
||||
@@ -4,6 +4,10 @@
|
||||
Lightning
|
||||
=========
|
||||
|
||||
.. contents::
|
||||
:depth: 2
|
||||
:local:
|
||||
|
||||
Check out our `Getting Started with Lightning video <https://www.youtube.com/watch?v=KhU_sTiaN8w>`_ for an introduction to the Lightning Network using LND and RTL on Embassy!
|
||||
|
||||
.. youtube:: KhU_sTiaN8w
|
||||
|
||||
@@ -4,6 +4,10 @@
|
||||
Vaultwarden
|
||||
===========
|
||||
|
||||
.. contents::
|
||||
:depth: 2
|
||||
:local:
|
||||
|
||||
.. note:: The version of Bitwarden server used on the Embassy is a fork called "Vaultwarden." Despite this, it still functions with several of the apps/integrations that are built for, and still named after, "Bitwarden." We apologize for any confusion this may cause.
|
||||
|
||||
Check out our `Vaultwarden video <https://www.youtube.com/watch?v=YcxxVHpm9j0>`_ for basic features and setup!
|
||||
|
||||
@@ -4,6 +4,10 @@
|
||||
Using SSH
|
||||
=========
|
||||
|
||||
.. contents::
|
||||
:depth: 2
|
||||
:local:
|
||||
|
||||
Creating an SSH Key
|
||||
-------------------
|
||||
|
||||
|
||||
@@ -4,6 +4,10 @@
|
||||
Updating EmbassyOS
|
||||
==================
|
||||
|
||||
.. contents::
|
||||
:depth: 2
|
||||
:local:
|
||||
|
||||
.. note:: EmbassyOS will **NEVER** update itself without your approval. But we highly recommended keeping EmbassyOS up to date for the latest security and performance patches, as well as to take advantage of new features.
|
||||
|
||||
How to Update
|
||||
|
||||
@@ -4,6 +4,10 @@
|
||||
Using your own hardware
|
||||
=======================
|
||||
|
||||
.. contents::
|
||||
:depth: 2
|
||||
:local:
|
||||
|
||||
This guide will cover how to upgrade from EmbassyOS version 0.2.x to version 0.3.0 with your own equipment.
|
||||
|
||||
Hardware Requirements
|
||||
|
||||
@@ -4,6 +4,10 @@
|
||||
Setup with Upgrade Kit
|
||||
======================
|
||||
|
||||
.. contents::
|
||||
:depth: 2
|
||||
:local:
|
||||
|
||||
This guide will cover how to upgrade from EmbassyOS version 0.2.x to version 0.3.0.
|
||||
|
||||
.. note::
|
||||
|
||||
Reference in New Issue
Block a user