diff --git a/site/source/about/privacy.rst b/site/source/about/privacy.rst index 94e76a6..82f81d1 100644 --- a/site/source/about/privacy.rst +++ b/site/source/about/privacy.rst @@ -4,6 +4,10 @@ Privacy Policy ============== +.. contents:: + :depth: 2 + :local: + General Principles ------------------ diff --git a/site/source/about/start9.rst b/site/source/about/start9.rst index b6e2f91..94e826b 100644 --- a/site/source/about/start9.rst +++ b/site/source/about/start9.rst @@ -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: diff --git a/site/source/developer-docs/build-package-example/01_setup.rst b/site/source/developer-docs/build-package-example/01_setup.rst index dbb3e38..136143d 100644 --- a/site/source/developer-docs/build-package-example/01_setup.rst +++ b/site/source/developer-docs/build-package-example/01_setup.rst @@ -1,8 +1,12 @@ .. _packaging-framework: -================== -Step 1 - Framework -================== +============= +1 - Framework +============= + +.. contents:: + :depth: 2 + :local: What we'll build ---------------- diff --git a/site/source/developer-docs/build-package-example/02_create-service.rst b/site/source/developer-docs/build-package-example/02_create-service.rst index 30a8059..35a5569 100644 --- a/site/source/developer-docs/build-package-example/02_create-service.rst +++ b/site/source/developer-docs/build-package-example/02_create-service.rst @@ -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. diff --git a/site/source/developer-docs/build-package-example/03_hardware-compile.rst b/site/source/developer-docs/build-package-example/03_hardware-compile.rst index 15fc377..a0d78ac 100644 --- a/site/source/developer-docs/build-package-example/03_hardware-compile.rst +++ b/site/source/developer-docs/build-package-example/03_hardware-compile.rst @@ -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. diff --git a/site/source/developer-docs/build-package-example/04_docker-build.rst b/site/source/developer-docs/build-package-example/04_docker-build.rst index 5ea0ba9..41899f0 100644 --- a/site/source/developer-docs/build-package-example/04_docker-build.rst +++ b/site/source/developer-docs/build-package-example/04_docker-build.rst @@ -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. diff --git a/site/source/developer-docs/build-package-example/05_create-manifest.rst b/site/source/developer-docs/build-package-example/05_create-manifest.rst index 8ca1819..cadafb0 100644 --- a/site/source/developer-docs/build-package-example/05_create-manifest.rst +++ b/site/source/developer-docs/build-package-example/05_create-manifest.rst @@ -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. diff --git a/site/source/developer-docs/build-package-example/06_create-assets.rst b/site/source/developer-docs/build-package-example/06_create-assets.rst index 749de14..9d0eb01 100644 --- a/site/source/developer-docs/build-package-example/06_create-assets.rst +++ b/site/source/developer-docs/build-package-example/06_create-assets.rst @@ -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: diff --git a/site/source/developer-docs/build-package-example/07_create-s9pk.rst b/site/source/developer-docs/build-package-example/07_create-s9pk.rst index c2faafe..9e3f366 100644 --- a/site/source/developer-docs/build-package-example/07_create-s9pk.rst +++ b/site/source/developer-docs/build-package-example/07_create-s9pk.rst @@ -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. diff --git a/site/source/developer-docs/build-package-example/08_create-makefile.rst b/site/source/developer-docs/build-package-example/08_create-makefile.rst index a0a908a..3c39f7c 100644 --- a/site/source/developer-docs/build-package-example/08_create-makefile.rst +++ b/site/source/developer-docs/build-package-example/08_create-makefile.rst @@ -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 `_ to rebuild our project quickly. diff --git a/site/source/developer-docs/build-package-example/09_create-wrapper.rst b/site/source/developer-docs/build-package-example/09_create-wrapper.rst index ef49062..a7d17ef 100644 --- a/site/source/developer-docs/build-package-example/09_create-wrapper.rst +++ b/site/source/developer-docs/build-package-example/09_create-wrapper.rst @@ -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. diff --git a/site/source/developer-docs/build-package-example/10_install-package.rst b/site/source/developer-docs/build-package-example/10_install-package.rst index 6b2b944..3f799dc 100644 --- a/site/source/developer-docs/build-package-example/10_install-package.rst +++ b/site/source/developer-docs/build-package-example/10_install-package.rst @@ -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! diff --git a/site/source/developer-docs/build-package-example/resources.rst b/site/source/developer-docs/build-package-example/resources.rst index 540b6a9..6d68577 100644 --- a/site/source/developer-docs/build-package-example/resources.rst +++ b/site/source/developer-docs/build-package-example/resources.rst @@ -4,6 +4,10 @@ Resources ========= +.. contents:: + :depth: 2 + :local: + Get help -------- diff --git a/site/source/developer-docs/getting-started/quick-start.rst b/site/source/developer-docs/getting-started/checklist.rst similarity index 94% rename from site/source/developer-docs/getting-started/quick-start.rst rename to site/source/developer-docs/getting-started/checklist.rst index 4939219..b511a5b 100644 --- a/site/source/developer-docs/getting-started/quick-start.rst +++ b/site/source/developer-docs/getting-started/checklist.rst @@ -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 ` guide. diff --git a/site/source/developer-docs/getting-started/environment-setup.rst b/site/source/developer-docs/getting-started/environment-setup.rst index 6b306fa..e75b481 100644 --- a/site/source/developer-docs/getting-started/environment-setup.rst +++ b/site/source/developer-docs/getting-started/environment-setup.rst @@ -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 `. diff --git a/site/source/developer-docs/getting-started/index.rst b/site/source/developer-docs/getting-started/index.rst index 0599037..27ccfe8 100644 --- a/site/source/developer-docs/getting-started/index.rst +++ b/site/source/developer-docs/getting-started/index.rst @@ -60,4 +60,4 @@ Getting Started Overview environment-setup sdk - quick-start \ No newline at end of file + checklist \ No newline at end of file diff --git a/site/source/developer-docs/specification/properties.rst b/site/source/developer-docs/specification/properties.rst index 315f84b..767bc46 100644 --- a/site/source/developer-docs/specification/properties.rst +++ b/site/source/developer-docs/specification/properties.rst @@ -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 { diff --git a/site/source/diy.rst b/site/source/diy.rst index 254462f..3aef53a 100644 --- a/site/source/diy.rst +++ b/site/source/diy.rst @@ -4,6 +4,10 @@ DIY Guide ========= +.. contents:: + :depth: 2 + :local: + .. figure:: /_static/images/diy/pi.png :width: 40% :alt: Raspberry Pi diff --git a/site/source/learn/concepts/bitcoin-lightning.rst b/site/source/learn/concepts/bitcoin-lightning.rst index 2fac312..6f9edcb 100644 --- a/site/source/learn/concepts/bitcoin-lightning.rst +++ b/site/source/learn/concepts/bitcoin-lightning.rst @@ -4,6 +4,10 @@ Bitcoin and Lightning ===================== +.. contents:: + :depth: 2 + :local: + .. _bitcoin: Bitcoin diff --git a/site/source/learn/concepts/embassy.rst b/site/source/learn/concepts/embassy.rst index 29e20e8..453ff49 100644 --- a/site/source/learn/concepts/embassy.rst +++ b/site/source/learn/concepts/embassy.rst @@ -4,6 +4,10 @@ Embassy and EmbassyOS ===================== +.. contents:: + :depth: 2 + :local: + .. _embassy: Embassy diff --git a/site/source/learn/concepts/networks.rst b/site/source/learn/concepts/networks.rst index 829f9c3..95bfa9b 100644 --- a/site/source/learn/concepts/networks.rst +++ b/site/source/learn/concepts/networks.rst @@ -4,6 +4,10 @@ Networks ======== +.. contents:: + :depth: 2 + :local: + .. _lan: LAN diff --git a/site/source/learn/concepts/open-source.rst b/site/source/learn/concepts/open-source.rst index 047de81..4d40e71 100644 --- a/site/source/learn/concepts/open-source.rst +++ b/site/source/learn/concepts/open-source.rst @@ -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. diff --git a/site/source/learn/concepts/self-hosting.rst b/site/source/learn/concepts/self-hosting.rst index b191544..f82cd76 100644 --- a/site/source/learn/concepts/self-hosting.rst +++ b/site/source/learn/concepts/self-hosting.rst @@ -4,6 +4,10 @@ Hosting ======= +.. contents:: + :depth: 2 + :local: + Client-Server Model ------------------- diff --git a/site/source/support/common-issues.rst b/site/source/support/common-issues.rst index 820ff1e..c5edb3d 100644 --- a/site/source/support/common-issues.rst +++ b/site/source/support/common-issues.rst @@ -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 diff --git a/site/source/support/contact.rst b/site/source/support/contact.rst index 940a04f..d101df9 100644 --- a/site/source/support/contact.rst +++ b/site/source/support/contact.rst @@ -4,6 +4,10 @@ Contact Us ========== +.. contents:: + :depth: 2 + :local: + Community Channels ------------------ diff --git a/site/source/support/faq/faq-030.rst b/site/source/support/faq/faq-030.rst index 240017b..be7954d 100644 --- a/site/source/support/faq/faq-030.rst +++ b/site/source/support/faq/faq-030.rst @@ -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. diff --git a/site/source/support/faq/faq-basic-use.rst b/site/source/support/faq/faq-basic-use.rst index 56206a2..e658aa8 100644 --- a/site/source/support/faq/faq-basic-use.rst +++ b/site/source/support/faq/faq-basic-use.rst @@ -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. diff --git a/site/source/support/faq/faq-bitcoin.rst b/site/source/support/faq/faq-bitcoin.rst index ed49d1a..579f090 100644 --- a/site/source/support/faq/faq-bitcoin.rst +++ b/site/source/support/faq/faq-bitcoin.rst @@ -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. diff --git a/site/source/support/faq/faq-contributing.rst b/site/source/support/faq/faq-contributing.rst index 623244d..0e2e4b6 100644 --- a/site/source/support/faq/faq-contributing.rst +++ b/site/source/support/faq/faq-contributing.rst @@ -4,6 +4,10 @@ Contributing FAQ ================ +.. contents:: + :depth: 2 + :local: + We ❤️ contributions! Please follow the guide `here `_ and reach out to the `Community Dev `_ channel on Matrix with any questions. diff --git a/site/source/support/faq/faq-embassy.rst b/site/source/support/faq/faq-embassy.rst index 73c4388..5993332 100644 --- a/site/source/support/faq/faq-embassy.rst +++ b/site/source/support/faq/faq-embassy.rst @@ -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. diff --git a/site/source/support/faq/faq-general.rst b/site/source/support/faq/faq-general.rst index 47162ec..fbe0bf1 100644 --- a/site/source/support/faq/faq-general.rst +++ b/site/source/support/faq/faq-general.rst @@ -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. diff --git a/site/source/support/faq/faq-lightning.rst b/site/source/support/faq/faq-lightning.rst index 0f4dbfb..a7f5bda 100644 --- a/site/source/support/faq/faq-lightning.rst +++ b/site/source/support/faq/faq-lightning.rst @@ -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.' diff --git a/site/source/support/faq/faq-service-packaging.rst b/site/source/support/faq/faq-service-packaging.rst index 65bba38..b5fef8f 100644 --- a/site/source/support/faq/faq-service-packaging.rst +++ b/site/source/support/faq/faq-service-packaging.rst @@ -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! diff --git a/site/source/support/faq/faq-services.rst b/site/source/support/faq/faq-services.rst index ef0105f..e2a0572 100644 --- a/site/source/support/faq/faq-services.rst +++ b/site/source/support/faq/faq-services.rst @@ -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. diff --git a/site/source/support/faq/faq-troubleshooting.rst b/site/source/support/faq/faq-troubleshooting.rst index a49fd62..bfb33d3 100644 --- a/site/source/support/faq/faq-troubleshooting.rst +++ b/site/source/support/faq/faq-troubleshooting.rst @@ -4,6 +4,10 @@ Setup and Troubleshooting FAQ ============================= +.. contents:: + :depth: 2 + :local: + What do I do first? ------------------- Please check out the :ref:`Initial Setup ` page, and follow the instructions. diff --git a/site/source/user-manual/backups/backup-create.rst b/site/source/user-manual/backups/backup-create.rst index df1f8fa..1671b9d 100644 --- a/site/source/user-manual/backups/backup-create.rst +++ b/site/source/user-manual/backups/backup-create.rst @@ -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! diff --git a/site/source/user-manual/backups/backup-setup/backup-linux.rst b/site/source/user-manual/backups/backup-setup/backup-linux.rst index 5f381b2..d6592f0 100644 --- a/site/source/user-manual/backups/backup-setup/backup-linux.rst +++ b/site/source/user-manual/backups/backup-setup/backup-linux.rst @@ -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. diff --git a/site/source/user-manual/backups/backup-setup/backup-mac.rst b/site/source/user-manual/backups/backup-setup/backup-mac.rst index 39c6876..8afac08 100644 --- a/site/source/user-manual/backups/backup-setup/backup-mac.rst +++ b/site/source/user-manual/backups/backup-setup/backup-mac.rst @@ -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 diff --git a/site/source/user-manual/backups/backup-setup/backup-synology.rst b/site/source/user-manual/backups/backup-setup/backup-synology.rst index 5233d6b..e1f4a37 100644 --- a/site/source/user-manual/backups/backup-setup/backup-synology.rst +++ b/site/source/user-manual/backups/backup-setup/backup-synology.rst @@ -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. diff --git a/site/source/user-manual/backups/backup-setup/backup-windows.rst b/site/source/user-manual/backups/backup-setup/backup-windows.rst index d60d6c8..f7da547 100644 --- a/site/source/user-manual/backups/backup-setup/backup-windows.rst +++ b/site/source/user-manual/backups/backup-setup/backup-windows.rst @@ -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 diff --git a/site/source/user-manual/connecting/connecting-tor/tor-firefox/torff-ios.rst b/site/source/user-manual/connecting/connecting-tor/tor-firefox/torff-ios.rst index 24aacf2..4a0c9f7 100644 --- a/site/source/user-manual/connecting/connecting-tor/tor-firefox/torff-ios.rst +++ b/site/source/user-manual/connecting/connecting-tor/tor-firefox/torff-ios.rst @@ -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` 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` for details and workarounds. diff --git a/site/source/user-manual/customize.rst b/site/source/user-manual/customize.rst index 27728b2..01ca4e4 100644 --- a/site/source/user-manual/customize.rst +++ b/site/source/user-manual/customize.rst @@ -4,6 +4,10 @@ Customize ========= +.. contents:: + :depth: 2 + :local: + Name Your Device ---------------- diff --git a/site/source/user-manual/dashboard-overview.rst b/site/source/user-manual/dashboard-overview.rst index e12c8b1..f185a39 100644 --- a/site/source/user-manual/dashboard-overview.rst +++ b/site/source/user-manual/dashboard-overview.rst @@ -4,6 +4,10 @@ Dashboard Overview ================== +.. contents:: + :depth: 2 + :local: + Services Tab ------------ diff --git a/site/source/user-manual/device-guides/limitations/lim-android.rst b/site/source/user-manual/device-guides/limitations/lim-android.rst index 2fef9ab..0dbb4b6 100644 --- a/site/source/user-manual/device-guides/limitations/lim-android.rst +++ b/site/source/user-manual/device-guides/limitations/lim-android.rst @@ -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` and therefore cannot resolve ".local" addresses. diff --git a/site/source/user-manual/device-guides/limitations/lim-ios.rst b/site/source/user-manual/device-guides/limitations/lim-ios.rst index f968634..1d1cc96 100644 --- a/site/source/user-manual/device-guides/limitations/lim-ios.rst +++ b/site/source/user-manual/device-guides/limitations/lim-ios.rst @@ -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 `_. diff --git a/site/source/user-manual/forgot-password.rst b/site/source/user-manual/forgot-password.rst index 2722e64..89df43d 100644 --- a/site/source/user-manual/forgot-password.rst +++ b/site/source/user-manual/forgot-password.rst @@ -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 diff --git a/site/source/user-manual/initial-setup.rst b/site/source/user-manual/initial-setup.rst index 8f82a72..bd09b95 100644 --- a/site/source/user-manual/initial-setup.rst +++ b/site/source/user-manual/initial-setup.rst @@ -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 + +
+ Powering On ----------- diff --git a/site/source/user-manual/managing-services.rst b/site/source/user-manual/managing-services.rst index eb6652b..0b99c25 100644 --- a/site/source/user-manual/managing-services.rst +++ b/site/source/user-manual/managing-services.rst @@ -4,6 +4,10 @@ Managing Services ================= +.. contents:: + :depth: 2 + :local: + EmbassyOS provides a rich interface for managing installed Services. Service Dashboard diff --git a/site/source/user-manual/service-guides/bitcoin.rst b/site/source/user-manual/service-guides/bitcoin.rst index cfbec3c..cba3d87 100644 --- a/site/source/user-manual/service-guides/bitcoin.rst +++ b/site/source/user-manual/service-guides/bitcoin.rst @@ -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 diff --git a/site/source/user-manual/service-guides/lightning.rst b/site/source/user-manual/service-guides/lightning.rst index 06a58f3..4d24b1f 100644 --- a/site/source/user-manual/service-guides/lightning.rst +++ b/site/source/user-manual/service-guides/lightning.rst @@ -4,6 +4,10 @@ Lightning ========= +.. contents:: + :depth: 2 + :local: + Check out our `Getting Started with Lightning video `_ for an introduction to the Lightning Network using LND and RTL on Embassy! .. youtube:: KhU_sTiaN8w diff --git a/site/source/user-manual/service-guides/vaultwarden.rst b/site/source/user-manual/service-guides/vaultwarden.rst index 2b0cff1..12b4494 100644 --- a/site/source/user-manual/service-guides/vaultwarden.rst +++ b/site/source/user-manual/service-guides/vaultwarden.rst @@ -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 `_ for basic features and setup! diff --git a/site/source/user-manual/ssh.rst b/site/source/user-manual/ssh.rst index 647ee8e..b37544a 100644 --- a/site/source/user-manual/ssh.rst +++ b/site/source/user-manual/ssh.rst @@ -4,6 +4,10 @@ Using SSH ========= +.. contents:: + :depth: 2 + :local: + Creating an SSH Key ------------------- diff --git a/site/source/user-manual/updating.rst b/site/source/user-manual/updating.rst index 867288f..cae51be 100644 --- a/site/source/user-manual/updating.rst +++ b/site/source/user-manual/updating.rst @@ -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 diff --git a/site/source/user-manual/upgrade-02/upgrade-diy.rst b/site/source/user-manual/upgrade-02/upgrade-diy.rst index 9a502e1..b8a7b8b 100644 --- a/site/source/user-manual/upgrade-02/upgrade-diy.rst +++ b/site/source/user-manual/upgrade-02/upgrade-diy.rst @@ -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 diff --git a/site/source/user-manual/upgrade-02/upgrade-kit.rst b/site/source/user-manual/upgrade-02/upgrade-kit.rst index bca6c46..2ee71fc 100644 --- a/site/source/user-manual/upgrade-02/upgrade-kit.rst +++ b/site/source/user-manual/upgrade-02/upgrade-kit.rst @@ -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:: diff --git a/sphinx-scylladb-theme b/sphinx-scylladb-theme index 3e0c910..554c4a6 160000 --- a/sphinx-scylladb-theme +++ b/sphinx-scylladb-theme @@ -1 +1 @@ -Subproject commit 3e0c910002565211409da09c35223ae0f6a45cb1 +Subproject commit 554c4a61bd96b45ca743b7a68529d4270c46cc63