mirror of
https://github.com/Start9Labs/documentation.git
synced 2026-03-26 02:11:55 +00:00
restructure docs
This commit is contained in:
@@ -103,7 +103,7 @@ html_theme_options = {
|
||||
"hide_version_dropdown": [],
|
||||
"github_issues_repository": "Start9Labs/documentation",
|
||||
"github_repository": "Start9Labs/documentation",
|
||||
"navigation_depth": 3,
|
||||
"navigation_depth": 2,
|
||||
"site_description": "Start9 documentation for sovereign computing with StartOS",
|
||||
}
|
||||
|
||||
|
||||
@@ -1,42 +0,0 @@
|
||||
.. _advanced-packaging:
|
||||
|
||||
========
|
||||
Advanced
|
||||
========
|
||||
|
||||
This section included advanced commands for working with packages in StartOS.
|
||||
|
||||
.. raw:: html
|
||||
|
||||
<div class="topics-grid grid-container full">
|
||||
|
||||
<div class="grid-x grid-margin-x">
|
||||
|
||||
.. topic-box::
|
||||
:title: Developer Tools
|
||||
:link: dev-tools
|
||||
:icon: scylla-icon scylla-icon--developers-blog
|
||||
:class: large-4
|
||||
:anchor: View
|
||||
|
||||
StartOS developer CLI tools
|
||||
|
||||
.. topic-box::
|
||||
:title: Service Containers
|
||||
:link: dev-tools/service-container
|
||||
:icon: scylla-icon scylla-icon--overview
|
||||
:class: large-4
|
||||
:anchor: View
|
||||
|
||||
How to interact with containers on the StartOS
|
||||
|
||||
.. raw:: html
|
||||
|
||||
</div></div>
|
||||
|
||||
.. This is for the side navigation display
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
:hidden:
|
||||
|
||||
dev-tools/index
|
||||
@@ -4,7 +4,7 @@
|
||||
Service Containers
|
||||
==================
|
||||
|
||||
For simplicity, StartOS is designed to be completely operated via the :ref:`WebUI <web-ui>`, however, your device belongs to you and if you want to "lift the hood" and access the internals of the software, you may do so. This guide will show you how to enter a Service's Docker container in order to directly interface with it and issue commands.
|
||||
For simplicity, StartOS is designed to be completely operated through its GUI, however, your device belongs to you and if you want to "lift the hood" and access the internals of the software, you may do so. This guide will show you how to enter a Service's Docker container in order to directly interface with it and issue commands.
|
||||
|
||||
.. warning:: The following guide is for those that have advanced command line skills, or those who are being guided by a Start9 support technician. Nothing you do inside a container is supported unless under the direction of Start9. Here be dragons!!
|
||||
|
||||
@@ -4,70 +4,13 @@
|
||||
Developer Docs
|
||||
==============
|
||||
|
||||
Welcome to the Service Packaging documentation for StartOS. If you are here, you have heard the call to help empower users with sovereign computing!
|
||||
Welcome to the Service Packaging documentation for StartOS. If you are here, you have heard the call to help empower users with sovereign computing!
|
||||
|
||||
.. raw:: html
|
||||
|
||||
<div class="topics-grid grid-container full">
|
||||
|
||||
<div class="grid-x grid-margin-x">
|
||||
|
||||
.. topic-box::
|
||||
:title: Listing a Service
|
||||
:link: submission
|
||||
:icon: scylla-icon scylla-icon--contact-us
|
||||
:class: large-4
|
||||
:anchor: Submit
|
||||
|
||||
The process for submitting a service to the Community Registry
|
||||
|
||||
.. topic-box::
|
||||
:title: Service Packaging
|
||||
:link: packaging
|
||||
:icon: scylla-icon scylla-icon--resource-center
|
||||
:class: large-4
|
||||
:anchor: Build
|
||||
|
||||
A concise guide to Service Packaging
|
||||
|
||||
.. topic-box::
|
||||
:title: Full Specification
|
||||
:link: specification
|
||||
:icon: scylla-icon scylla-icon--glossary
|
||||
:class: large-4
|
||||
:anchor: Read
|
||||
|
||||
Detailed service packaging specification and advanced features
|
||||
|
||||
.. topic-box::
|
||||
:title: Advanced Guides
|
||||
:link: advanced
|
||||
:icon: scylla-icon scylla-icon--integrations
|
||||
:class: large-4
|
||||
:anchor: Tinker
|
||||
|
||||
Guides for implementing advanced service configurations
|
||||
|
||||
.. topic-box::
|
||||
:title: Documentation
|
||||
:link: documentation
|
||||
:icon: scylla-icon scylla-icon--docs
|
||||
:class: large-4
|
||||
:anchor: Edit
|
||||
|
||||
Contribute to our documentation.
|
||||
|
||||
.. raw:: html
|
||||
|
||||
</div></div>
|
||||
|
||||
.. This is for the side navigation display
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:hidden:
|
||||
|
||||
submission
|
||||
packaging
|
||||
specification/index
|
||||
advanced/index
|
||||
documentation
|
||||
documentation
|
||||
dev-tools/index
|
||||
@@ -8,7 +8,7 @@ Service Packaging
|
||||
:depth: 2
|
||||
:local:
|
||||
|
||||
Welcome! Thank you for your interest in contributing to the growing ecosystem of open software. We call the software applications that run on :ref:`StartOS<start-os>` "services." This distinction is made to differentiate from "applications" (apps), which are generally run on a client, and used to access server-side software (services). To run services on StartOS, a package of file components needs to be composed. This guide will dive into the basic structure of how to compose this package.
|
||||
Welcome! Thank you for your interest in contributing to the growing ecosystem of open software. We call the software applications that run on StartOS services. This distinction is made to differentiate from "applications" (apps), which are generally run on a client, and used to access server-side software (services). To run services on StartOS, a package of file components needs to be composed. This guide will dive into the basic structure of how to compose this package.
|
||||
|
||||
Check out the :ref:`glossary <glossary>` to get acquainted with unfamiliar terms. The bottom of this guide also includes :ref:`support <packaging-support>` links, including a master checklist.
|
||||
|
||||
|
||||
@@ -1,21 +0,0 @@
|
||||
.. _compat:
|
||||
|
||||
============
|
||||
Compat Image
|
||||
============
|
||||
|
||||
With the release of StartOS v0.3.0, system utility Docker images are preloaded for service packager convenience.
|
||||
|
||||
The ``Compat`` image is a backwards compatible Docker image that hosts StartOS features used in the v0.2.x series. It was created as a convenience for service packagers to help migrate their service configurations from 0.2.x to 0.3.0.
|
||||
|
||||
It exposes functionality to make use of:
|
||||
|
||||
- ``ConfigRules`` language
|
||||
- Duplicity backups
|
||||
|
||||
|
||||
.. This is for the side navigation display
|
||||
.. toctree::
|
||||
:hidden:
|
||||
|
||||
rules
|
||||
@@ -1,111 +0,0 @@
|
||||
|
||||
.. _config_rules:
|
||||
|
||||
============
|
||||
Config Rules
|
||||
============
|
||||
|
||||
This file defines the configuration rules, or the rule-set that defines dependencies between config variables. In practice, config rules are for auto-configuring self dependencies. Self dependencies are internal dependencies of a service, such as if the setting of one config variable informs the option of another setting. These "dependencies" are configured as rules.
|
||||
|
||||
A rule is a boolean expression that we demand to be true. It is not true if the expression fails the rule parser. Set of predicates. xt
|
||||
|
||||
They follow the `Backus–Naur <https://en.wikipedia.org/wiki/Backus%E2%80%93Naur_form>`_ meta-syntax for writing rules.
|
||||
|
||||
Rules are composed of two main concepts:
|
||||
|
||||
* Variables - accessor into a configuration
|
||||
* Terms - either a variable or type literal (ie. a boolean term is a boolean variable, a boolean expression, or a comparison operation between numbers or strings)
|
||||
|
||||
Variables can be booleans, numbers, or strings, and have a different syntax depending on the type. These type annotations check your config rules against your config spec and throw an error if invalid.
|
||||
|
||||
- ``?`` - Casts to boolean value. If the value is not a boolean, this notes whether or not the value is null.
|
||||
- ``#`` - Treat the value as a number. If it is not a number, the value will be parsed as NaN. String numbers are not currently supported.
|
||||
- ``'`` - Cast the value into a string. Applies to any value except for an object or a list.
|
||||
- ``!`` - Equals not.
|
||||
|
||||
.. note::
|
||||
Config rules are processed in order.
|
||||
|
||||
If application does not satisfy a rule, a set of suggestions should be provided. These suggestions are in the form of the operation to preform:
|
||||
|
||||
- ``Set`` - set the value
|
||||
|
||||
- ``Push`` - add to the value (such as to a list)
|
||||
|
||||
- ``Delete`` - delete the value
|
||||
|
||||
.. code:: typescript
|
||||
|
||||
enum SuggestionVariant = Set | Delete | Push
|
||||
|
||||
interface Set {
|
||||
var: String, // fully qualified path without typecast
|
||||
// one of the following three variants are required
|
||||
to: Option<String> // a string expression, use when tying another config value
|
||||
to-value: Option<String>
|
||||
to-entropy: Option<{
|
||||
charset: String (eg. 'a-z,A-Z,0-9')
|
||||
len: Number
|
||||
}>
|
||||
}
|
||||
|
||||
interface Delete {
|
||||
src: String, // path to key - removes if in a list
|
||||
}
|
||||
|
||||
interface Push {
|
||||
to: String,
|
||||
value: String, // string literal of value to be set
|
||||
}
|
||||
|
||||
SET Examples
|
||||
------------
|
||||
|
||||
.. code:: yaml
|
||||
|
||||
- SET:
|
||||
# the key in config you want to set
|
||||
var: 'users.[first(item => ''item.name = "c-lightning")].password'
|
||||
# the value in config that you will set
|
||||
to-entropy:
|
||||
charset: "a-z,A-Z,0-9"
|
||||
len: 22
|
||||
|
||||
- SET:
|
||||
var: 'users.[first(item => ''item.name = "c-lightning")].fetch-blocks'
|
||||
to-value: true
|
||||
|
||||
|
||||
PUSH Examples
|
||||
-------------
|
||||
|
||||
.. code:: yaml
|
||||
|
||||
- PUSH:
|
||||
to: "users"
|
||||
value:
|
||||
name: c-lightning
|
||||
allowed-calls: []
|
||||
|
||||
- PUSH:
|
||||
to: 'users.[first(item => ''item.name = "c-lightning")].allowed-calls'
|
||||
value: "getnetworkinfo"
|
||||
|
||||
Full example from `c-lightning manifest <https://github.com/Start9Labs/c-lightning-wrapper/blob/master/manifest.yaml>`_:
|
||||
|
||||
.. code:: yaml
|
||||
|
||||
config:
|
||||
- rule: '''users.*.name = "c-lightning"'
|
||||
description: 'Must have an RPC user named "c-lightning"'
|
||||
suggestions:
|
||||
- PUSH:
|
||||
to: "users"
|
||||
value:
|
||||
name: c-lightning
|
||||
allowed-calls: []
|
||||
- SET:
|
||||
var: 'users.[first(item => ''item.name = "c-lightning")].password'
|
||||
to-entropy:
|
||||
charset: "a-z,A-Z,0-9"
|
||||
len: 22
|
||||
@@ -15,8 +15,6 @@ This may sound cool or neat, but it is more than that: *it's novel*. This has ne
|
||||
|
||||
The key to making the system work is a new, domain-specific-language (DSL) and set of standards that are used by developers to define the rules and requirements of their services. Run in the context of StartOS, these rules and requirements appear as simple UI elements, such as inputs, toggles, and drop downs, and they are enforced by validations and clear user instructions. Using this system, what previously required serious time and expertise, can now be done by anyone in a matter of seconds.
|
||||
|
||||
This DSL is utilized in the :ref:`config rules <config_rules>` and :ref:`dependencies <service-dependencies>` key in the service manifest.
|
||||
|
||||
Context
|
||||
-------
|
||||
|
||||
|
||||
@@ -6,98 +6,8 @@ Specification
|
||||
|
||||
The following guides provide an in depth overview of the full capabilities available for packaging a service.
|
||||
|
||||
.. raw:: html
|
||||
|
||||
<div class="topics-grid grid-container full">
|
||||
|
||||
<div class="grid-x grid-margin-x">
|
||||
|
||||
.. topic-box::
|
||||
:title: Docker
|
||||
:link: docker
|
||||
:class: large-4
|
||||
:anchor: View
|
||||
|
||||
Learn how to setup the main Docker image for your service.
|
||||
|
||||
.. topic-box::
|
||||
:title: Manifest
|
||||
:link: manifest
|
||||
:class: large-4
|
||||
:anchor: Begin
|
||||
|
||||
Understand the function of a Manifest file and its type.
|
||||
|
||||
.. topic-box::
|
||||
:title: Config Spec
|
||||
:link: config-spec
|
||||
:class: large-4
|
||||
:anchor: Begin
|
||||
|
||||
Learn the purpose and utility of a config specification.
|
||||
|
||||
.. topic-box::
|
||||
:title: JS Procedures
|
||||
:link: js-procedure
|
||||
:class: large-4
|
||||
:anchor: Begin
|
||||
|
||||
Learn how to use this operation configuration library.
|
||||
|
||||
.. topic-box::
|
||||
:title: Properties
|
||||
:link: properties
|
||||
:class: large-4
|
||||
:anchor: View
|
||||
|
||||
Understand the purpose and requirements of service properties.
|
||||
|
||||
.. topic-box::
|
||||
:title: Dependencies
|
||||
:link: dependencies
|
||||
:class: large-4
|
||||
:anchor: View
|
||||
|
||||
Learn how to configure dependency options.
|
||||
|
||||
.. topic-box::
|
||||
:title: Backups
|
||||
:link: advanced
|
||||
:class: large-4
|
||||
:anchor: View
|
||||
|
||||
Learn how to configure backup options.
|
||||
|
||||
.. topic-box::
|
||||
:title: Instructions
|
||||
:link: instructions
|
||||
:class: large-4
|
||||
:anchor: View
|
||||
|
||||
Understand how an instructions file is relevant to a service.
|
||||
|
||||
.. topic-box::
|
||||
:title: Package
|
||||
:link: package
|
||||
:class: large-4
|
||||
:anchor: View
|
||||
|
||||
Learn how to package service components into a single file format.
|
||||
|
||||
.. topic-box::
|
||||
:title: Wrapper
|
||||
:link: wrapper
|
||||
:class: large-4
|
||||
:anchor: View
|
||||
|
||||
Understand the purpose of a wrapper repository.
|
||||
|
||||
.. raw:: html
|
||||
|
||||
</div></div>
|
||||
|
||||
.. toctree::
|
||||
:hidden:
|
||||
:maxdepth: 2
|
||||
|
||||
docker
|
||||
manifest
|
||||
@@ -110,5 +20,4 @@ The following guides provide an in depth overview of the full capabilities avail
|
||||
wrapper
|
||||
makefile
|
||||
js-procedure
|
||||
compat/index
|
||||
checklist
|
||||
|
||||
@@ -19,7 +19,7 @@ Each time a service is updated, the Manifest should be updated to include the ne
|
||||
|
||||
There is nothing you need to do as a developer to set up Tor for running a service. This is *completely* handled by StartOS - a Tor address will be automatically generated when the service is installed. Just define an interface with a tor config in the Manifest file. You do, however, need to ensure the service is in fact capable of running over Tor.
|
||||
|
||||
The Manifest is also responsible for outlining service :ref:`dependencies <dependencies-spec>`. By defining rules using the :ref:`StartOS DSL specification <config_rules>`, users can easily and selectively install, uninstall, and update any service without getting stuck in dependency hell. StartOS presents this information in a polished install/uninstall/update wizard, so there's no need for editing configuration files or jumping into the command line. For you as a developer, this simply means populating this key in the manifest!
|
||||
The Manifest is also responsible for outlining service :ref:`dependencies <dependencies-spec>`. By defining rules using the :ref:`StartOS DSL specification <config_spec>`, users can easily and selectively install, uninstall, and update any service without getting stuck in dependency hell. StartOS presents this information in a polished install/uninstall/update wizard, so there's no need for editing configuration files or jumping into the command line. For you as a developer, this simply means populating this key in the manifest!
|
||||
|
||||
Formatting
|
||||
----------
|
||||
|
||||
15
site/source/device-guides/android/index.rst
Normal file
15
site/source/device-guides/android/index.rst
Normal file
@@ -0,0 +1,15 @@
|
||||
.. _android:
|
||||
|
||||
=======
|
||||
Android
|
||||
=======
|
||||
|
||||
Recommended Guides
|
||||
------------------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
ca-android
|
||||
tor-android
|
||||
ff-android
|
||||
@@ -3,7 +3,7 @@
|
||||
======================
|
||||
Running Tor on Android
|
||||
======================
|
||||
Some apps, such as :ref:`Tor Browser<tor-browser>`, have Tor built in. They do not require additional software or configurations to utilize Tor. Most apps, however, do not have Tor built in. They require an app called Orbot to be installed in order to utilize the Tor Network.
|
||||
Some apps, such as the official Tor Browser, have Tor built in. They do not require additional software or configurations to utilize Tor. Most apps, however, do not have Tor built in. They require an app called Orbot to be installed in order to utilize the Tor Network.
|
||||
|
||||
Running Orbot
|
||||
-------------
|
||||
@@ -75,7 +75,7 @@ Guides for integrating your client devices with your StartOS server.
|
||||
Guides for Truenas
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
:maxdepth: 1
|
||||
:hidden:
|
||||
|
||||
linux/index
|
||||
@@ -5,8 +5,6 @@ Trusting Your Server's Root CA on iOS
|
||||
=====================================
|
||||
Complete this guide to trust your server's Root Certificate Authority (Root CA) on iOS.
|
||||
|
||||
.. note:: This guide only applies to iOS v15+. For v14, see the `v14 guide </0.3.1.x/user-manual/connecting/connecting-lan/lan-os/lan-ios>`_.
|
||||
|
||||
#. Ensure you have already `downloaded your server's Root CA </getting-started/trust-ca/#download-root-ca>`_
|
||||
|
||||
#. Open your iCloud Downloads folder and click on the certificate. It will display a dialog box that says "Profile Downloaded." Click `Close`.
|
||||
14
site/source/device-guides/ios/index.rst
Normal file
14
site/source/device-guides/ios/index.rst
Normal file
@@ -0,0 +1,14 @@
|
||||
.. _ios:
|
||||
|
||||
===
|
||||
iOS
|
||||
===
|
||||
|
||||
Recommended Guides
|
||||
------------------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
ca-ios
|
||||
tor-ios
|
||||
23
site/source/device-guides/linux/index.rst
Normal file
23
site/source/device-guides/linux/index.rst
Normal file
@@ -0,0 +1,23 @@
|
||||
.. _linux:
|
||||
|
||||
=====
|
||||
Linux
|
||||
=====
|
||||
|
||||
Recommended Guides
|
||||
------------------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
ca-linux
|
||||
tor-linux
|
||||
ff-linux
|
||||
|
||||
Other Useful Guides
|
||||
-------------------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
backup-linux
|
||||
24
site/source/device-guides/mac/index.rst
Normal file
24
site/source/device-guides/mac/index.rst
Normal file
@@ -0,0 +1,24 @@
|
||||
.. _dg-mac:
|
||||
|
||||
===
|
||||
Mac
|
||||
===
|
||||
|
||||
Recommended Guides
|
||||
------------------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
ca-mac
|
||||
tor-mac
|
||||
ff-mac
|
||||
|
||||
Other Useful Guides
|
||||
-------------------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
backup-mac
|
||||
screenshare-mac
|
||||
13
site/source/device-guides/synology/index.rst
Normal file
13
site/source/device-guides/synology/index.rst
Normal file
@@ -0,0 +1,13 @@
|
||||
.. _dg-synology:
|
||||
|
||||
========
|
||||
Synology
|
||||
========
|
||||
|
||||
Recommended Guides
|
||||
------------------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
backup-synology
|
||||
13
site/source/device-guides/truenas/index.rst
Normal file
13
site/source/device-guides/truenas/index.rst
Normal file
@@ -0,0 +1,13 @@
|
||||
.. _dg-truenas:
|
||||
|
||||
=======
|
||||
TrueNas
|
||||
=======
|
||||
|
||||
Recommended Guides
|
||||
------------------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
backup-truenas
|
||||
23
site/source/device-guides/windows/index.rst
Normal file
23
site/source/device-guides/windows/index.rst
Normal file
@@ -0,0 +1,23 @@
|
||||
.. _windows:
|
||||
|
||||
=======
|
||||
Windows
|
||||
=======
|
||||
|
||||
Recommended Guides
|
||||
------------------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
ca-windows
|
||||
tor-windows
|
||||
ff-windows
|
||||
|
||||
Other Useful Guides
|
||||
-------------------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
backup-windows
|
||||
@@ -1,8 +1,8 @@
|
||||
.. _diy-pi:
|
||||
|
||||
=============================
|
||||
DIY Guidelines (Raspberry Pi)
|
||||
=============================
|
||||
==================
|
||||
DIY (Raspberry Pi)
|
||||
==================
|
||||
|
||||
.. contents::
|
||||
:depth: 2
|
||||
@@ -27,7 +27,7 @@ Flash and Install StartOS
|
||||
-------------------------
|
||||
.. topic-box::
|
||||
:title: Flashing (Raspberry Pi)
|
||||
:link: /latest/guides/flashing/flashing-pi
|
||||
:link: ../flashing-guides/os-pi
|
||||
:icon: scylla-icon scylla-icon--apps
|
||||
:class: large-4
|
||||
:anchor: View Guide
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
.. _diy-x86:
|
||||
|
||||
=======================
|
||||
DIY Guidelines (x86_64)
|
||||
=======================
|
||||
=======
|
||||
DIY x86
|
||||
=======
|
||||
|
||||
.. contents::
|
||||
:depth: 2
|
||||
@@ -40,8 +40,8 @@ If you intend to run Bitcoin or store any meaningful amount of data, we recommen
|
||||
Flash and Install StartOS
|
||||
-------------------------
|
||||
.. topic-box::
|
||||
:title: Flashing (x86_64)
|
||||
:link: /latest/guides/flashing/flashing-x86
|
||||
:title: Flashing (x86)
|
||||
:link: ../flashing-guides/os-x86
|
||||
:icon: scylla-icon scylla-icon--overview
|
||||
:class: large-4
|
||||
:anchor: View Guide
|
||||
|
||||
@@ -15,32 +15,7 @@ There are several reasons you might prefer to build your own server instead of p
|
||||
#. You do not want to share your shipping address.
|
||||
#. You like building things.
|
||||
|
||||
.. raw:: html
|
||||
|
||||
<div class="topics-grid grid-container full">
|
||||
|
||||
<div class="grid-x grid-margin-x">
|
||||
|
||||
.. topic-box::
|
||||
:title: DIY (Raspberry Pi)
|
||||
:link: diy-pi
|
||||
:icon: scylla-icon scylla-icon--apps
|
||||
:class: large-4
|
||||
:anchor: View Guidelines
|
||||
|
||||
Build a Start9 server using a Raspberry Pi
|
||||
|
||||
.. topic-box::
|
||||
:title: DIY (x86_64)
|
||||
:link: diy-x86
|
||||
:icon: scylla-icon scylla-icon--overview
|
||||
:class: large-4
|
||||
:anchor: View Guidelines
|
||||
|
||||
Build a Start9 server using an x86_64 machine
|
||||
|
||||
.. toctree::
|
||||
:hidden:
|
||||
:maxdepth: 1
|
||||
|
||||
diy-pi
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
.. _flashing-firmware:
|
||||
.. _flashing-firmware-pure:
|
||||
|
||||
===================
|
||||
Flashing (Firmware)
|
||||
===================
|
||||
======================
|
||||
Firmware (Server Pure)
|
||||
======================
|
||||
This page is for Server Pure / Purism Librem Mini users ONLY. This firmware is custom for these devices.
|
||||
|
||||
The source code can be viewed on Purism's `firmware git repo <https://source.puri.sm/firmware/releases/-/tree/master/librem_mini_v2/custom>`_. You will need a USB flash drive, formatted FAT32, to flash the firmware to your server.
|
||||
17
site/source/flashing-guides/index.rst
Normal file
17
site/source/flashing-guides/index.rst
Normal file
@@ -0,0 +1,17 @@
|
||||
.. _flashing:
|
||||
|
||||
===============
|
||||
Flashing Guides
|
||||
===============
|
||||
|
||||
Here you will find our flashing guides for the Raspberry Pi and x86_64 (most desktops, laptops, mini PCs, servers, etc) architectures. Librem Mini owners can use the firmware flashing guide to get StartOS-specific firmware.
|
||||
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
os-pi
|
||||
os-x86
|
||||
firmware-pure
|
||||
|
||||
Appreciate what we're doing? Please consider a `donation to Start9 <https://btcpay.start9.com/apps/2Et1JUmJnDwzKncfVBXvspeXiFsa/crowdfund>`_.
|
||||
@@ -1,8 +1,8 @@
|
||||
.. _flashing-pi:
|
||||
.. _flashing-os-pi:
|
||||
|
||||
=======================
|
||||
Flashing (Raspberry Pi)
|
||||
=======================
|
||||
======================
|
||||
StartOS (Raspberry Pi)
|
||||
======================
|
||||
This guide is for flashing StartOS to a micro SD card in order to install it on a Raspberry Pi with an external SSD. Please `contact support <https://start9.com/contact>`_ if you need to re-install your OS on a Server Lite (SD card storage).
|
||||
|
||||
.. warning:: If you are running in a "Lite" configuration (everything on an SD card), then flashing that SD card in the manner proscribed below WILL ERASE ALL YOUR DATA! If you need to reflash and you are NOT using an external SSD (ie. you have a Server Lite), please contact support for assistance instead.
|
||||
@@ -1,8 +1,8 @@
|
||||
.. _flashing-x86:
|
||||
.. _flashing-os-x86:
|
||||
|
||||
=================
|
||||
Flashing (x86_64)
|
||||
=================
|
||||
=============
|
||||
StartOS (x86)
|
||||
=============
|
||||
This guide is for flashing StartOS to a USB drive in order to install it to an x86_64 architecture device. This will include most desktops, laptops, mini PCs, and servers. For an up-to-date list of known-good hardware, please check out this `forum post <https://community.start9.com/t/known-good-hardware-master-list-hardware-capable-of-running-startos/>`_.
|
||||
|
||||
.. note:: You will need a USB drive of at least 8GB in size
|
||||
@@ -1,67 +0,0 @@
|
||||
.. _getting-started:
|
||||
|
||||
===============
|
||||
Getting Started
|
||||
===============
|
||||
The guides below are considered mandatory for a safe and smooth experience with StartOS
|
||||
|
||||
.. raw:: html
|
||||
|
||||
<div class="topics-grid grid-container full">
|
||||
|
||||
<div class="grid-x grid-margin-x">
|
||||
|
||||
.. topic-box::
|
||||
:title: Initial Setup
|
||||
:link: initial-setup
|
||||
:icon: scylla-icon scylla-icon--home
|
||||
:class: large-4
|
||||
:anchor: View
|
||||
|
||||
Step by step instructions for setting up your server
|
||||
|
||||
.. topic-box::
|
||||
:title: Trusting your Root CA
|
||||
:link: trust-ca
|
||||
:icon: scylla-icon scylla-icon--testing
|
||||
:class: large-4
|
||||
:anchor: View
|
||||
|
||||
Use encryption for a secure connection to your server
|
||||
|
||||
.. topic-box::
|
||||
:title: Configuring Firefox
|
||||
:link: configuring-ff
|
||||
:icon: scylla-icon scylla-icon--integrations
|
||||
:class: large-4
|
||||
:anchor: View
|
||||
|
||||
Configure Firefox for optimal Local and Tor connectivity
|
||||
|
||||
.. topic-box::
|
||||
:title: Connecting Locally
|
||||
:link: connecting-lan
|
||||
:icon: scylla-icon scylla-icon--networking
|
||||
:class: large-4
|
||||
:anchor: View
|
||||
|
||||
Connect to your server while on the same LAN
|
||||
|
||||
.. topic-box::
|
||||
:title: Connecting Remotely
|
||||
:link: connecting-tor
|
||||
:icon: scylla-icon scylla-icon--networking
|
||||
:class: large-4
|
||||
:anchor: View
|
||||
|
||||
Connect to your server remotely using Tor
|
||||
|
||||
.. toctree::
|
||||
:hidden:
|
||||
:maxdepth: 2
|
||||
|
||||
initial-setup
|
||||
trust-ca
|
||||
configuring-ff
|
||||
connecting-lan
|
||||
connecting-tor
|
||||
@@ -1,47 +0,0 @@
|
||||
.. _android:
|
||||
|
||||
=======
|
||||
Android
|
||||
=======
|
||||
It is recommended you complete all of the guides below.
|
||||
|
||||
.. raw:: html
|
||||
|
||||
<div class="topics-grid grid-container full">
|
||||
|
||||
<div class="grid-x grid-margin-x">
|
||||
|
||||
.. topic-box::
|
||||
:title: Trust Root CA
|
||||
:link: ca-android
|
||||
:icon: scylla-icon scylla-icon--partners
|
||||
:class: large-4
|
||||
:anchor: View
|
||||
|
||||
Trust your server's Root Certificate Authority for fast, secure connections
|
||||
|
||||
.. topic-box::
|
||||
:title: Connect to Tor Network
|
||||
:icon: scylla-icon scylla-icon--networking
|
||||
:link: tor-android
|
||||
:class: large-4
|
||||
:anchor: View
|
||||
|
||||
Run Tor natively for remote connectivity
|
||||
|
||||
.. topic-box::
|
||||
:title: Configure Firefox
|
||||
:link: ff-android
|
||||
:icon: scylla-icon scylla-icon--integrations
|
||||
:class: large-4
|
||||
:anchor: View
|
||||
|
||||
Configure Firefox for an optimal browser experience
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
:hidden:
|
||||
|
||||
ca-android
|
||||
tor-android
|
||||
ff-android
|
||||
@@ -1,37 +0,0 @@
|
||||
.. _ios:
|
||||
|
||||
===
|
||||
iOS
|
||||
===
|
||||
It is recommended you complete all of the guides below.
|
||||
|
||||
.. raw:: html
|
||||
|
||||
<div class="topics-grid grid-container full">
|
||||
|
||||
<div class="grid-x grid-margin-x">
|
||||
|
||||
.. topic-box::
|
||||
:title: Trust Root CA
|
||||
:link: ca-ios
|
||||
:icon: scylla-icon scylla-icon--partners
|
||||
:class: large-4
|
||||
:anchor: View
|
||||
|
||||
Trust your server's Root Certificate Authority for fast, secure connections
|
||||
|
||||
.. topic-box::
|
||||
:title: Connect to Tor Network
|
||||
:icon: scylla-icon scylla-icon--networking
|
||||
:link: tor-ios
|
||||
:class: large-4
|
||||
:anchor: View
|
||||
|
||||
Run Tor natively for remote connectivity
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
:hidden:
|
||||
|
||||
ca-ios
|
||||
tor-ios
|
||||
@@ -1,67 +0,0 @@
|
||||
.. _linux:
|
||||
|
||||
=====
|
||||
Linux
|
||||
=====
|
||||
Recommended Guides
|
||||
------------------
|
||||
|
||||
.. raw:: html
|
||||
|
||||
<div class="topics-grid grid-container full">
|
||||
|
||||
<div class="grid-x grid-margin-x">
|
||||
|
||||
.. topic-box::
|
||||
:title: Trust Root CA
|
||||
:link: ca-linux
|
||||
:icon: scylla-icon scylla-icon--partners
|
||||
:class: large-4
|
||||
:anchor: View
|
||||
|
||||
Trust your server's Root Certificate Authority for fast, secure connections
|
||||
|
||||
.. topic-box::
|
||||
:title: Connect to Tor Network
|
||||
:icon: scylla-icon scylla-icon--networking
|
||||
:link: tor-linux
|
||||
:class: large-4
|
||||
:anchor: View
|
||||
|
||||
Run Tor natively for remote connectivity
|
||||
|
||||
.. topic-box::
|
||||
:title: Configure Firefox
|
||||
:link: ff-linux
|
||||
:icon: scylla-icon scylla-icon--integrations
|
||||
:class: large-4
|
||||
:anchor: View
|
||||
|
||||
Configure Firefox for an optimal browser experience
|
||||
|
||||
Other Useful Guides
|
||||
-------------------
|
||||
|
||||
.. raw:: html
|
||||
|
||||
<div class="topics-grid grid-container full">
|
||||
|
||||
<div class="grid-x grid-margin-x">
|
||||
|
||||
.. topic-box::
|
||||
:title: Backup Config
|
||||
:link: backup-linux
|
||||
:icon: scylla-icon scylla-icon--cloud
|
||||
:class: large-4
|
||||
:anchor: View
|
||||
|
||||
Configure a Network Folder for storing StartOS backups
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
:hidden:
|
||||
|
||||
ca-linux
|
||||
tor-linux
|
||||
ff-linux
|
||||
backup-linux
|
||||
@@ -1,75 +0,0 @@
|
||||
.. _dg-mac:
|
||||
|
||||
===
|
||||
Mac
|
||||
===
|
||||
Recommended Guides
|
||||
------------------
|
||||
.. raw:: html
|
||||
|
||||
<div class="topics-grid grid-container full">
|
||||
|
||||
<div class="grid-x grid-margin-x">
|
||||
|
||||
.. topic-box::
|
||||
:title: Trust Root CA
|
||||
:link: ca-mac
|
||||
:icon: scylla-icon scylla-icon--partners
|
||||
:class: large-4
|
||||
:anchor: View
|
||||
|
||||
Trust your server's Root Certificate Authority for fast, secure connections
|
||||
|
||||
.. topic-box::
|
||||
:title: Connect to Tor Network
|
||||
:icon: scylla-icon scylla-icon--networking
|
||||
:link: tor-mac
|
||||
:class: large-4
|
||||
:anchor: View
|
||||
|
||||
Run Tor natively for remote connectivity
|
||||
|
||||
.. topic-box::
|
||||
:title: Configure Firefox
|
||||
:link: ff-mac
|
||||
:icon: scylla-icon scylla-icon--integrations
|
||||
:class: large-4
|
||||
:anchor: View
|
||||
|
||||
Configure Firefox for an optimal browser experience
|
||||
|
||||
Other Useful Guides
|
||||
-------------------
|
||||
.. raw:: html
|
||||
|
||||
<div class="topics-grid grid-container full">
|
||||
|
||||
<div class="grid-x grid-margin-x">
|
||||
|
||||
.. topic-box::
|
||||
:title: Backup Config
|
||||
:link: backup-mac
|
||||
:icon: scylla-icon scylla-icon--cloud
|
||||
:class: large-4
|
||||
:anchor: View
|
||||
|
||||
Configure a Network Folder for storing StartOS backups
|
||||
|
||||
.. topic-box::
|
||||
:title: Screensharing
|
||||
:link: screenshare-mac
|
||||
:icon: scylla-icon scylla-icon--workshop
|
||||
:class: large-4
|
||||
:anchor: Share Screen
|
||||
|
||||
Guide to allow screensharing with a Start9 Support Tech.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
:hidden:
|
||||
|
||||
ca-mac
|
||||
tor-mac
|
||||
ff-mac
|
||||
backup-mac
|
||||
screenshare-mac
|
||||
@@ -1,29 +0,0 @@
|
||||
.. _dg-synology:
|
||||
|
||||
========
|
||||
Synology
|
||||
========
|
||||
|
||||
Recommended Guides
|
||||
------------------
|
||||
|
||||
.. raw:: html
|
||||
|
||||
<div class="topics-grid grid-container full">
|
||||
|
||||
<div class="grid-x grid-margin-x">
|
||||
|
||||
.. topic-box::
|
||||
:title: Backup Config
|
||||
:link: backup-synology
|
||||
:icon: scylla-icon scylla-icon--cloud
|
||||
:class: large-4
|
||||
:anchor: View
|
||||
|
||||
Configure a Network Folder for storing StartOS backups
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
:hidden:
|
||||
|
||||
backup-synology
|
||||
@@ -1,29 +0,0 @@
|
||||
.. _dg-truenas:
|
||||
|
||||
=======
|
||||
TrueNas
|
||||
=======
|
||||
|
||||
Recommended Guides
|
||||
------------------
|
||||
|
||||
.. raw:: html
|
||||
|
||||
<div class="topics-grid grid-container full">
|
||||
|
||||
<div class="grid-x grid-margin-x">
|
||||
|
||||
.. topic-box::
|
||||
:title: Backup Config
|
||||
:link: backup-truenas
|
||||
:icon: scylla-icon scylla-icon--cloud
|
||||
:class: large-4
|
||||
:anchor: View
|
||||
|
||||
Configure a Network Folder for storing StartOS backups
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
:hidden:
|
||||
|
||||
backup-truenas
|
||||
@@ -1,67 +0,0 @@
|
||||
.. _windows:
|
||||
|
||||
=======
|
||||
Windows
|
||||
=======
|
||||
Recommended Guides
|
||||
------------------
|
||||
|
||||
.. raw:: html
|
||||
|
||||
<div class="topics-grid grid-container full">
|
||||
|
||||
<div class="grid-x grid-margin-x">
|
||||
|
||||
.. topic-box::
|
||||
:title: Trust Root CA
|
||||
:link: ca-windows
|
||||
:icon: scylla-icon scylla-icon--partners
|
||||
:class: large-4
|
||||
:anchor: View
|
||||
|
||||
Trust your server's Root Certificate Authority for fast, secure connections
|
||||
|
||||
.. topic-box::
|
||||
:title: Connect to Tor Network
|
||||
:icon: scylla-icon scylla-icon--networking
|
||||
:link: tor-windows
|
||||
:class: large-4
|
||||
:anchor: View
|
||||
|
||||
Run Tor natively for remote connectivity
|
||||
|
||||
.. topic-box::
|
||||
:title: Configure Firefox
|
||||
:link: ff-windows
|
||||
:icon: scylla-icon scylla-icon--integrations
|
||||
:class: large-4
|
||||
:anchor: View
|
||||
|
||||
Configure Firefox for an optimal browser experience
|
||||
|
||||
Other Useful Guides
|
||||
-------------------
|
||||
|
||||
.. raw:: html
|
||||
|
||||
<div class="topics-grid grid-container full">
|
||||
|
||||
<div class="grid-x grid-margin-x">
|
||||
|
||||
.. topic-box::
|
||||
:title: Backup Config
|
||||
:link: backup-windows
|
||||
:icon: scylla-icon scylla-icon--cloud
|
||||
:class: large-4
|
||||
:anchor: View
|
||||
|
||||
Configure a Network Folder for storing StartOS backups
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
:hidden:
|
||||
|
||||
ca-windows
|
||||
tor-windows
|
||||
ff-windows
|
||||
backup-windows
|
||||
@@ -1,50 +0,0 @@
|
||||
.. _flashing:
|
||||
|
||||
========
|
||||
Flashing
|
||||
========
|
||||
|
||||
Here you will find our flashing guides for the Raspberry Pi and x86_64 (most desktops, laptops, mini PCs, servers, etc) architectures. Librem Mini owners can use the firmware flashing guide to get StartOS-specific firmware.
|
||||
|
||||
.. raw:: html
|
||||
|
||||
<div class="topics-grid grid-container full">
|
||||
|
||||
<div class="grid-x grid-margin-x">
|
||||
|
||||
.. topic-box::
|
||||
:title: Flashing (Raspberry Pi)
|
||||
:link: flashing-pi
|
||||
:icon: scylla-icon scylla-icon--apps
|
||||
:class: large-4
|
||||
:anchor: View Guide
|
||||
|
||||
Flash StartOS for use on a Raspberry Pi
|
||||
|
||||
.. topic-box::
|
||||
:title: Flashing (x86_64)
|
||||
:link: flashing-x86
|
||||
:icon: scylla-icon scylla-icon--overview
|
||||
:class: large-4
|
||||
:anchor: View Guide
|
||||
|
||||
Flash StartOS for use on an x86_64 machine
|
||||
|
||||
.. topic-box::
|
||||
:title: Flashing (Firmware)
|
||||
:link: flashing-firmware
|
||||
:icon: scylla-icon scylla-icon--integrations
|
||||
:class: large-4
|
||||
:anchor: Librem Mini Firmware
|
||||
|
||||
Flash the custom firmware for StartOS on an existing Librem Mini
|
||||
|
||||
.. toctree::
|
||||
:hidden:
|
||||
:maxdepth: 2
|
||||
|
||||
flashing-pi
|
||||
flashing-x86
|
||||
flashing-firmware
|
||||
|
||||
Appreciate what we're doing? Please consider a `donation to Start9 <https://btcpay.start9.com/apps/2Et1JUmJnDwzKncfVBXvspeXiFsa/crowdfund>`_.
|
||||
@@ -1,16 +0,0 @@
|
||||
.. _guides:
|
||||
|
||||
======
|
||||
Guides
|
||||
======
|
||||
Guides for integrating your client devices with your Start9 server, building your own server (DIY), upgrading hardware, password resets, and more.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
device-guides/index
|
||||
service-guides/index
|
||||
upgrade-hardware/index
|
||||
flashing/index
|
||||
reset-password
|
||||
misc-guides/index
|
||||
@@ -1,112 +0,0 @@
|
||||
.. _lan-ff:
|
||||
|
||||
==================================
|
||||
Trusting Your Start9 CA in Firefox
|
||||
==================================
|
||||
This guide applies to Firefox, Firefox ESR, and Librewolf. Mozilla apps need to be configured to use the certificate store of your device. To find out why Mozilla does this differently, you can read their `blog post <https://blog.mozilla.org/security/2019/02/14/why-does-mozilla-maintain-our-own-root-certificate-store/>`_ on the topic.
|
||||
|
||||
.. caution:: You will first need to complete the :ref:`Trust Root CA <trust-ca>` guide for your device before continuing.
|
||||
|
||||
.. tabs::
|
||||
|
||||
.. group-tab:: Linux
|
||||
|
||||
#. Open Firefox and enter ``about:config`` in the URL bar. Accept any warnings that may appear about changing advanced configuration preferences.
|
||||
|
||||
#. Search for *security.enterprise_roots.enabled* and double click on *false* so that it turns to *true*:
|
||||
|
||||
.. figure:: /_static/images/ssl/browser/enterprise_roots_enabled_true.png
|
||||
:width: 80%
|
||||
:alt: Firefox security settings
|
||||
|
||||
Most Debian-based distributions (Debian, Linux Mint, PopOS, Ubuntu, etc) will require the following setup. If you run Arch, CentOS, Garuda, Fedora, etc, then you may skip all the way down to :ref:`Restart Firefox<restart-ff>`.
|
||||
|
||||
For each Mozilla-based application (Firefox, Firefox ESR, LibreWolf, Thunderbird, etc) you plan on using, you will need to complete the following guide. This is in order for them to trust your Start9 server's CA certificate directly from your Linux distribution's certificate trust store.
|
||||
|
||||
#. Select the hamgurger menu, then *Settings*, then search for "*security devices*", then select "*Security Devices...*"
|
||||
|
||||
.. figure:: /_static/images/ssl/linux/cert-trust-linux-firefox-p11kit-1.png
|
||||
:width: 60%
|
||||
:alt: Mozilla application p11kit trust #1
|
||||
|
||||
#. When the Device Manager dialog window opens, select "*Load*"
|
||||
|
||||
.. figure:: /_static/images/ssl/linux/cert-trust-linux-firefox-p11kit-2.png
|
||||
:width: 60%
|
||||
:alt: Mozilla application p11kit trust #2
|
||||
|
||||
#. Give the Module Name a title such as "*System CA Trust Module*" and for the Module filename, paste in ``/usr/lib/x86_64-linux-gnu/pkcs11/p11-kit-trust.so`` and hit *OK*:
|
||||
|
||||
.. figure:: /_static/images/ssl/linux/cert-trust-linux-firefox-p11kit-3.png
|
||||
:width: 60%
|
||||
:alt: Mozilla application p11kit trust #3
|
||||
|
||||
#. Verify that the new module shows up on the left hand side and select *OK* at the bottom right:
|
||||
|
||||
.. figure:: /_static/images/ssl/linux/cert-trust-linux-firefox-p11kit-4.png
|
||||
:width: 60%
|
||||
:alt: Mozilla application p11kit trust #4
|
||||
|
||||
.. _restart-ff:
|
||||
|
||||
Now restart Firefox (or other Mozilla application), and log in to your server using ``https``. You should now see this symbol indicating a secure connection:
|
||||
|
||||
.. figure:: /_static/images/ssl/browser/firefox-https-good.png
|
||||
:width: 80%
|
||||
:alt: Firefox security settings
|
||||
|
||||
.. tip:: If you see an exclamation point inside a triangle by the lock, you have made a security exception in the browser. You will need to remove it by clicking the lock and then "Connection not secure":
|
||||
|
||||
.. figure:: /_static/images/ssl/browser/cert-trust-exception-remove-1.png
|
||||
:width: 80%
|
||||
:alt: Firefox - Remove security exception (Part 1)
|
||||
|
||||
Then click "Remove Exception":
|
||||
|
||||
.. figure:: /_static/images/ssl/browser/cert-trust-exception-remove-2.png
|
||||
:width: 80%
|
||||
:alt: Firefox - Remove security exception (Part 2)
|
||||
|
||||
You should now see that the website is trusted as in the final step show above.
|
||||
|
||||
.. group-tab:: Mac/Windows
|
||||
|
||||
#. Open Firefox and enter ``about:config`` in the URL bar. Accept any warnings that may appear about changing advanced configuration preferences.
|
||||
|
||||
#. Search for *security.enterprise_roots.enabled* and double click on *false* so that it turns to *true*:
|
||||
|
||||
.. figure:: /_static/images/ssl/browser/enterprise_roots_enabled_true.png
|
||||
:width: 80%
|
||||
:alt: Firefox security settings
|
||||
|
||||
#. Now restart Firefox and you should now see this symbol indicating a secure connection:
|
||||
|
||||
.. figure:: /_static/images/ssl/browser/firefox-https-good.png
|
||||
:width: 80%
|
||||
:alt: Firefox security settings
|
||||
|
||||
.. note:: If you see an exclamation point inside a triangle by the lock, you have made a security exception in the browser. To remove it, click the lock and go to "Connection not secure":
|
||||
|
||||
.. figure:: /_static/images/ssl/browser/cert-trust-exception-remove-1.png
|
||||
:width: 80%
|
||||
:alt: Firefox - Remove security exception (Part 1)
|
||||
|
||||
Then click "Remove Exception":
|
||||
|
||||
.. figure:: /_static/images/ssl/browser/cert-trust-exception-remove-2.png
|
||||
:width: 80%
|
||||
:alt: Firefox - Remove security exception (Part 2)
|
||||
|
||||
You should now see that the website is trusted as in the final step show above.
|
||||
|
||||
.. group-tab:: Android
|
||||
|
||||
#. To setup in Firefox Beta or Fennec, tap the kebab menu, then go to *Settings > About Firefox Beta* and tap the Firefox logo five times until it says "Debug menu enabled."
|
||||
|
||||
#. Return to *Settings > Secret Settings* and enable "Use third party CA certificates".
|
||||
|
||||
.. group-tab:: iOS
|
||||
|
||||
No additional configuration for iOS is required, as all iOS browsers are really Safari under the hood.
|
||||
|
||||
|
||||
@@ -1,68 +0,0 @@
|
||||
.. _upgrade-hardware:
|
||||
|
||||
===============
|
||||
Hardware Guides
|
||||
===============
|
||||
.. raw:: html
|
||||
|
||||
<div class="topics-grid grid-container full">
|
||||
|
||||
<div class="grid-x grid-margin-x">
|
||||
|
||||
.. topic-box::
|
||||
:title: Migrate an LND Node to StartOS
|
||||
:link: lnd-migration
|
||||
:icon: scylla-icon scylla-icon--home
|
||||
:class: large-4
|
||||
:anchor: View
|
||||
|
||||
Migrating an LND from another server to StartOS without closing channels
|
||||
|
||||
.. topic-box::
|
||||
:title: Changing Your SSD
|
||||
:link: drive-upgrade
|
||||
:icon: scylla-icon scylla-icon--benchmarks
|
||||
:class: large-4
|
||||
:anchor: View
|
||||
|
||||
Replace or upgrade your SSD
|
||||
|
||||
.. topic-box::
|
||||
:title: Upgrade SSD ('22 Server One)
|
||||
:link: naspi-ssd-upgrade
|
||||
:icon: scylla-icon scylla-icon--benchmarks
|
||||
:class: large-4
|
||||
:anchor: View
|
||||
|
||||
This is for replacing or upgrading your 2022 Server One SSD
|
||||
|
||||
.. topic-box::
|
||||
:title: 2022 One to Pure Migration
|
||||
:link: upgrade-pure
|
||||
:icon: scylla-icon scylla-icon--enterprise
|
||||
:class: large-4
|
||||
:anchor: View
|
||||
|
||||
This is for migrating from a Server One (Raspberry Pi) to Server Pure
|
||||
|
||||
.. topic-box::
|
||||
:title: Upgrade to all-in-one NASPi case
|
||||
:link: naspi-upgrade
|
||||
:icon: scylla-icon scylla-icon--home
|
||||
:class: large-4
|
||||
:anchor: View
|
||||
|
||||
This is for upgrading a Pi to an all-in-one NASPi case
|
||||
|
||||
.. raw:: html
|
||||
|
||||
</div></div>
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
lnd-migration
|
||||
drive-upgrade
|
||||
upgrade-pure
|
||||
naspi-upgrade
|
||||
naspi-ssd-upgrade
|
||||
@@ -1,134 +0,0 @@
|
||||
.. _naspi-ssd-upgrade:
|
||||
|
||||
======================
|
||||
Upgrade Your NASPI SSD
|
||||
======================
|
||||
This guide will go over how to switch out an old drive on your server to a different drive and transfer the data from the old one to the new one.
|
||||
|
||||
This will preserve the entire state of your server, including all Tor and LAN addresses as well as channels you have open on the lightning network!
|
||||
|
||||
This is not the same as running a back up and restoring them onto a new server.
|
||||
|
||||
#. Start by shutting down your server:
|
||||
|
||||
.. figure:: /_static/images/walkthrough/shutdown.png
|
||||
:width: 50%
|
||||
|
||||
#. Remove the power and Ethernet cables:
|
||||
|
||||
.. figure:: /_static/images/hardware-pics/back-no-cables.jpg
|
||||
:width: 50%
|
||||
|
||||
#. Unscrew the two screws here and remove the USB adaptor:
|
||||
|
||||
.. figure:: /_static/images/hardware-pics/back-screws-usb-loop.jpg
|
||||
:width: 50%
|
||||
|
||||
#. Remove the micro SD card from the front:
|
||||
|
||||
.. figure:: /_static/images/hardware-pics/front-sd-card.jpg
|
||||
:width: 50%
|
||||
|
||||
#. Remove the bottom four screws:
|
||||
|
||||
.. figure:: /_static/images/hardware-pics/bottom-screws.jpg
|
||||
:width: 50%
|
||||
|
||||
#. Carefully slide the contents of the case out and disassemble the server by disconnecting the power wire and removing the 5 screws (and 4 brass spacers beneath the fan bracket) highlighted below:
|
||||
|
||||
.. figure:: /_static/images/hardware-pics/disassembly-0.png
|
||||
:width: 50%
|
||||
|
||||
#. This top section should lift off now and you'll be left with the SSD still attached. Remove the two screws shown below:
|
||||
|
||||
.. figure:: /_static/images/hardware-pics/disassembly-1.png
|
||||
:width: 50%
|
||||
|
||||
#. Now slide the **old** SSD off the connector:
|
||||
|
||||
.. figure:: /_static/images/hardware-pics/old-drive-exposed.jpg
|
||||
:width: 50%
|
||||
|
||||
#. Now take the **new** SSD, and connect it where the old one was:
|
||||
|
||||
.. figure:: /_static/images/hardware-pics/new-ssd-attach-0.png
|
||||
:width: 50%
|
||||
|
||||
#. Secure the SSD with the two silver screws:
|
||||
|
||||
.. figure:: /_static/images/hardware-pics/disassembly-1.png
|
||||
:width: 50%
|
||||
|
||||
#. Reattach the 4 brass spacers holding the Pi to the SSD board, followed by the 5 black screws to secure the fan bracket and power management board. Then reconnect the power wire:
|
||||
|
||||
.. figure:: /_static/images/hardware-pics/disassembly-0.png
|
||||
:width: 50%
|
||||
|
||||
#. Now reinsert the server back into the case and reattach the bottom four black screws:
|
||||
|
||||
.. figure:: /_static/images/hardware-pics/bottom-screws.jpg
|
||||
:width: 50%
|
||||
|
||||
#. Reconnect the USB adaptor and back two black screws:
|
||||
|
||||
.. figure:: /_static/images/hardware-pics/back-screws-usb-loop.jpg
|
||||
:width: 50%
|
||||
|
||||
#. Flash the micro SD card with a fresh install of StartOS - you can follow the flashing guide :ref:`here <flashing-pi>`
|
||||
|
||||
#. Once flashed, reinsert the micro SD card into the server:
|
||||
|
||||
.. figure:: /_static/images/hardware-pics/front-sd-card.jpg
|
||||
:width: 50%
|
||||
|
||||
#. Reconnect the Ethernet cable, make sure the USB adaptor is connect and then finally connect the power cable:
|
||||
|
||||
.. figure:: /_static/images/hardware-pics/plugged-in-back.jpg
|
||||
:width: 50%
|
||||
|
||||
.. figure:: /_static/images/hardware-pics/plugged-in-front.jpg
|
||||
:width: 50%
|
||||
|
||||
#. Head to http://start.local on any device on the same LAN
|
||||
|
||||
#. Select "Recover"
|
||||
|
||||
.. figure:: /_static/images/setup/screen0-recover.jpg
|
||||
:width: 60%
|
||||
|
||||
#. Select "Transfer"
|
||||
|
||||
.. figure:: /_static/images/setup/transfer.png
|
||||
:width: 60%
|
||||
|
||||
#. Now connect the **old ssd** to your server:
|
||||
|
||||
.. figure:: /_static/images/hardware-pics/attach-ssd.jpg
|
||||
:width: 60%
|
||||
|
||||
#. Select the **old drive** - the one that is externally connect to your server (you may need to hit *REFRESH*):
|
||||
|
||||
.. figure:: /_static/images/setup/transfer-from.png
|
||||
:width: 60%
|
||||
|
||||
#. Select the drive **inside the server** that you are migrating **to** - this is your **NEW** drive - and any data on this drive will be erased:
|
||||
|
||||
.. figure:: /_static/images/setup/transfer-to.png
|
||||
:width: 60%
|
||||
|
||||
#. You will be asked to create a password. It can be the same as it was previously:
|
||||
|
||||
.. figure:: /_static/images/setup/screen5-set_password.png
|
||||
:width: 60%
|
||||
|
||||
#. Your data will now transfer over - the length of this process will vary depending on how much data you have, but will likely take several hours:
|
||||
|
||||
.. figure:: /_static/images/setup/screen6-storage_initialize.jpg
|
||||
:width: 60%
|
||||
|
||||
#. You are now ready to proceed and use your server with its new drive! It will have the same addresses and root certificate as it did before migrating.
|
||||
|
||||
.. figure:: /_static/images/setup/screen7-startfresh_complete.jpg
|
||||
:width: 60%
|
||||
|
||||
.. warning:: Do not unders any circumstances use the old SSD to setup another server unless you wipe it first or wipe it during the initial setup proecess! If you have lightning channels you could lose all your funds!
|
||||
@@ -1,10 +0,0 @@
|
||||
.. _naspi-upgrade:
|
||||
|
||||
======================================
|
||||
Upgrading from an External Drive Setup
|
||||
======================================
|
||||
|
||||
If you already have a server with an external drive, you can follow along from the `written guide appendix <https://community.start9.com/t/diy-embassy-one-geekworm-naspi-case/49>`_ and/or check out the video below:
|
||||
|
||||
.. youtube:: 355BENA42s8
|
||||
:width: 100%
|
||||
@@ -1,165 +0,0 @@
|
||||
.. _upgrade-pure:
|
||||
|
||||
=============================================
|
||||
Migrating From 2022 Server One to Server Pure
|
||||
=============================================
|
||||
This guide is for Server One users upgrading from a NASPi (pictured below). If you're using an external drive, such as a Samsung T5/T7 please go :ref:`here <external-drives>`.
|
||||
|
||||
.. figure:: /_static/images/hardware-pics/server-one.png
|
||||
:width: 30%
|
||||
|
||||
You will need a high quality `USB-A to USB-A cable <https://www.amazon.com/UGREEN-Transfer-Enclosures-Printers-Cameras/dp/B00P0E3954/?th=1>`_, or a `USB-A to USB-C cable <https://www.amazon.com/AmazonBasics-Type-C-USB-Male-Cable/dp/B01GGKYKQM/?th=1>`_.
|
||||
|
||||
#. Shutdown your Server One.
|
||||
|
||||
.. figure:: /_static/images/walkthrough/shutdown.png
|
||||
:width: 60%
|
||||
|
||||
#. Listen out for the shutdown sounds, then after few more seconds, disconnect the power.
|
||||
|
||||
.. raw:: HTML
|
||||
|
||||
<audio controls>
|
||||
<source src="/_static/sounds/SHUTDOWN.mp3" type="audio/mpeg">
|
||||
Your browser does not support the audio element.
|
||||
</audio>
|
||||
|
||||
* Shutdown sound
|
||||
|
||||
#. Now disconnect the USB adapter found here:
|
||||
|
||||
.. figure:: /_static/images/hardware-pics/naspi-jameson-loop2.png
|
||||
:width: 60%
|
||||
|
||||
#. Connect the USB cable to the lowest blue USB port like this:
|
||||
|
||||
.. figure:: /_static/images/hardware-pics/usb-into-naspi-edited.jpg
|
||||
:width: 60%
|
||||
|
||||
#. Now connect the Ethernet cable and then the power to your Server Pro
|
||||
|
||||
.. figure:: /_static/images/hardware-pics/pro-all.jpg
|
||||
:width: 60%
|
||||
|
||||
#. Head to http://start.local on any device on the same LAN
|
||||
|
||||
#. Select "Recover"
|
||||
|
||||
.. figure:: /_static/images/setup/screen0-recover.jpg
|
||||
:width: 60%
|
||||
|
||||
#. Select "Transfer"
|
||||
|
||||
.. figure:: /_static/images/setup/transfer.png
|
||||
:width: 60%
|
||||
|
||||
#. Now connect the other end of the USB cable to either an Server Pure USB-3 port or the USB-C port:
|
||||
|
||||
.. figure:: /_static/images/hardware-pics/pro-all-highlighted.jpg
|
||||
:width: 60%
|
||||
|
||||
#. Connect the power to the NASPi - you will hear this sound and can ignore it:
|
||||
|
||||
.. raw:: HTML
|
||||
|
||||
<audio controls>
|
||||
<source src="/_static/sounds/BEETHOVEN.mp3" type="audio/mpeg">
|
||||
Your browser does not support the audio element.
|
||||
</audio>
|
||||
|
||||
* Beethoven's 5th
|
||||
|
||||
#. Select the drive inside the NASPi (you may need to hit refresh):
|
||||
|
||||
.. figure:: /_static/images/setup/transfer-from.png
|
||||
:width: 60%
|
||||
|
||||
#. Select the drive inside the Server Pure that you are migrating *to* (this will erase any data on this drive):
|
||||
|
||||
.. figure:: /_static/images/setup/transfer-to.png
|
||||
:width: 60%
|
||||
|
||||
#. You will be asked to create a password. It can be the same as it was previously:
|
||||
|
||||
.. figure:: /_static/images/setup/screen5-set_password.png
|
||||
:width: 60%
|
||||
|
||||
#. Your data will now transfer over - the length of this process will vary depending on how much data you have, but will likely take several hours:
|
||||
|
||||
.. figure:: /_static/images/setup/screen6-storage_initialize.jpg
|
||||
:width: 60%
|
||||
|
||||
#. You are now ready to proceed and use your Server Pro - it will have the same addresses and root certificate as it did before migrating.
|
||||
|
||||
.. figure:: /_static/images/setup/screen7-startfresh_complete.jpg
|
||||
:width: 60%
|
||||
|
||||
.. warning:: Do not unders any circumstances reassemble your Server One without wiping the SD card first and wiping the SSD during initial setup! If you do not this will cause serious problems! If you have lightning channels you could lose all your funds!
|
||||
|
||||
.. _external-drives:
|
||||
|
||||
External Drives
|
||||
===============
|
||||
For transferring from an USB-attached drive.
|
||||
|
||||
#. Shutdown your Server One
|
||||
|
||||
.. figure:: /_static/images/walkthrough/shutdown.png
|
||||
:width: 60%
|
||||
|
||||
#. Listen out for the shutdown sounds, then after few more seconds, disconnect the power.
|
||||
|
||||
.. raw:: HTML
|
||||
|
||||
<audio controls>
|
||||
<source src="/_static/sounds/SHUTDOWN.mp3" type="audio/mpeg">
|
||||
Your browser does not support the audio element.
|
||||
</audio>
|
||||
|
||||
* Shutdown sound
|
||||
|
||||
#. Now connect the Ethernet cable and then the power to your Server Pro
|
||||
|
||||
.. figure:: /_static/images/hardware-pics/pro-all.jpg
|
||||
:width: 60%
|
||||
|
||||
#. Head to http://start.local on any device on the same LAN
|
||||
|
||||
#. Select "Recover"
|
||||
|
||||
.. figure:: /_static/images/setup/screen0-recover.jpg
|
||||
:width: 60%
|
||||
|
||||
#. Select "Transfer"
|
||||
|
||||
.. figure:: /_static/images/setup/transfer.png
|
||||
:width: 60%
|
||||
|
||||
#. Now connect your Samsung T5/T7/alternative drive to any USB-3 or USB-C port on your Server Pure
|
||||
|
||||
#. Select this drive (you may need to hit refresh):
|
||||
|
||||
.. figure:: /_static/images/setup/transfer-from.png
|
||||
:width: 60%
|
||||
|
||||
#. Select the drive inside the Server Pure that you are migrating *to* (this will erase any data on this drive):
|
||||
|
||||
.. figure:: /_static/images/setup/transfer-to.png
|
||||
:width: 60%
|
||||
|
||||
#. You will be asked to create a password. It can be the same as it was previously:
|
||||
|
||||
.. figure:: /_static/images/setup/screen5-set_password.png
|
||||
:width: 60%
|
||||
|
||||
#. Your data will now transfer over - the length of this process will vary depending on how much data you have, but will likely take several hours:
|
||||
|
||||
.. figure:: /_static/images/setup/screen6-storage_initialize.jpg
|
||||
:width: 60%
|
||||
|
||||
#. You are now ready to proceed and use your Server Pure - it will have the same addresses and root certificate as it did before migrating.
|
||||
|
||||
.. figure:: /_static/images/setup/screen7-startfresh_complete.jpg
|
||||
:width: 60%
|
||||
|
||||
.. warning:: Do not unders any circumstances reassemble your Server One without wiping the SD card first and wiping the SSD during initial setup! If you do not this will cause serious problems! If you have lightning channels you could lose all your funds!
|
||||
@@ -20,8 +20,8 @@
|
||||
<div class="grid-x grid-margin-x">
|
||||
|
||||
.. topic-box::
|
||||
:title: Getting Started
|
||||
:link: getting-started
|
||||
:title: Quick Start
|
||||
:link: quick-start
|
||||
:icon: scylla-icon scylla-icon--getting-started
|
||||
:class: large-4
|
||||
:anchor: View
|
||||
@@ -38,22 +38,40 @@
|
||||
Understand and use your server
|
||||
|
||||
.. topic-box::
|
||||
:title: Guides
|
||||
:link: guides
|
||||
:title: Service Guides
|
||||
:link: service-guides
|
||||
:icon: scylla-icon scylla-icon--circe
|
||||
:class: large-4
|
||||
:anchor: View
|
||||
|
||||
Integrate your devices and tools
|
||||
Guides for officially supported services
|
||||
|
||||
.. topic-box::
|
||||
:title: Support
|
||||
:link: support
|
||||
:icon: scylla-icon scylla-icon--support
|
||||
:title: Device Guides
|
||||
:link: device-guides
|
||||
:icon: scylla-icon scylla-icon--circe
|
||||
:class: large-4
|
||||
:anchor: View
|
||||
|
||||
Find answers to your questions
|
||||
Guides for specific client devices
|
||||
|
||||
.. topic-box::
|
||||
:title: Flashing Guides
|
||||
:link: flashing-guides
|
||||
:icon: scylla-icon scylla-icon--circe
|
||||
:class: large-4
|
||||
:anchor: View
|
||||
|
||||
Guides for flashing firmware and StartOS
|
||||
|
||||
.. topic-box::
|
||||
:title: Misc Guides
|
||||
:link: misc-guides
|
||||
:icon: scylla-icon scylla-icon--circe
|
||||
:class: large-4
|
||||
:anchor: View
|
||||
|
||||
Miscellaneous guides you might find useful
|
||||
|
||||
.. topic-box::
|
||||
:title: DIY
|
||||
@@ -74,22 +92,25 @@
|
||||
Package a service for the Marketplace
|
||||
|
||||
.. topic-box::
|
||||
:title: Contact Us
|
||||
:link: https://start9.com/contact
|
||||
:icon: scylla-icon scylla-icon--contact-us
|
||||
:title: Get Help
|
||||
:link: support
|
||||
:icon: scylla-icon scylla-icon--support
|
||||
:class: large-4
|
||||
:anchor: View
|
||||
|
||||
Join us in our community channels or get support
|
||||
View common issues or contact support
|
||||
|
||||
.. This is for the side navigation display
|
||||
.. toctree::
|
||||
:maxdepth: 5
|
||||
:hidden:
|
||||
:maxdepth: 1
|
||||
|
||||
getting-started/index
|
||||
quick-start
|
||||
user-manual/index
|
||||
guides/index
|
||||
support/index
|
||||
service-guides/index
|
||||
device-guides/index
|
||||
flashing-guides/index
|
||||
misc-guides/index
|
||||
diy/index
|
||||
developer-docs/index
|
||||
support/index
|
||||
|
||||
@@ -6,10 +6,13 @@ Misc Guides
|
||||
Guides that do not fit into the categories of "devices" or "services."
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
:maxdepth: 1
|
||||
|
||||
lan-ff
|
||||
lan-thunderbird
|
||||
ca-ff
|
||||
lnd-migration
|
||||
upgrade-hardware/index
|
||||
thunderbird
|
||||
smtp
|
||||
backup-mount
|
||||
data-mount
|
||||
reset-password
|
||||
@@ -3,7 +3,7 @@
|
||||
==============
|
||||
Password Reset
|
||||
==============
|
||||
If you forgot or lost your StartOS master password, you can use this guide to reset it. If you simply want to change your password, that can be done via the web-UI by following the :ref:`change password guide<change-password>`.
|
||||
If you forgot or lost your StartOS master password, you can use this guide to reset it. If you simply want to change your password, that can be done via main StartOS UI by following the :ref:`change password guide<change-password>`.
|
||||
|
||||
.. contents::
|
||||
:depth: 2
|
||||
@@ -1,11 +1,9 @@
|
||||
.. _smtp:
|
||||
|
||||
=====================
|
||||
SMTP Setup (External)
|
||||
=====================
|
||||
There are several services that are able to take advantage of a Simple Mail Transfer Protocol (SMTP) server in order to send emails. The most common third party SMTP services are GMail and Amazon SES. Some example services that you may wish to use this functionality with are BTCPay Server, Ghost, Gitea, Nextcloud, Synapse, and Vaultwarden.
|
||||
|
||||
In order to get SMTP credentials for use in a StartOS service, you can follow one of these vendor specific guides.
|
||||
========================
|
||||
Getting SMTP Credentials
|
||||
========================
|
||||
There are several StartOS services that are capable of sending emails, such as BTCPay Server, Ghost, Gitea, Nextcloud, Synapse, and Vaultwarden, using third party email (SMTP) servers. The guides below are for using Gmail or Amazon SES for SMTP, but you may also use another third party provider of your choice.
|
||||
|
||||
.. tabs::
|
||||
.. group-tab:: Gmail
|
||||
@@ -56,4 +54,4 @@ In order to get SMTP credentials for use in a StartOS service, you can follow on
|
||||
|
||||
|
||||
.. group-tab:: Amazon SES
|
||||
For Amazon SES Configurarions please refer to `Amazon SMTP Credentials Setup Guide On Amazon Docs <https://docs.aws.amazon.com/ses/latest/dg/smtp-credentials.html>`_
|
||||
To use Amazon SES please refer to the `Amazon SES docs <https://docs.aws.amazon.com/ses/latest/dg/smtp-credentials.html>`_
|
||||
@@ -1,12 +1,12 @@
|
||||
.. _lan-thunderbird:
|
||||
.. _thunderbird:
|
||||
|
||||
=========================
|
||||
Thunderbird Configuration
|
||||
=========================
|
||||
=================
|
||||
Using Thunderbird
|
||||
=================
|
||||
.. caution:: You will first need to complete :ref:`device-guides` for your client before continuing. Take special note of the Thunderbird-specific instructions there.
|
||||
|
||||
Trusting Your Start9 CA in Thunderbird
|
||||
======================================
|
||||
Trusting Your Root CA in Thunderbird
|
||||
====================================
|
||||
|
||||
#. Open Thunderbird and do the following:
|
||||
|
||||
@@ -28,8 +28,8 @@ Trusting Your Start9 CA in Thunderbird
|
||||
:width: 60%
|
||||
:alt: Thunderbird enterprise_roots settings
|
||||
|
||||
Configure Tor in Thunderbird
|
||||
============================
|
||||
Configuring Tor
|
||||
===============
|
||||
|
||||
.. note:: This is not required if you have enabled a system-wide proxy configuration.
|
||||
|
||||
11
site/source/misc-guides/upgrade-hardware/index.rst
Normal file
11
site/source/misc-guides/upgrade-hardware/index.rst
Normal file
@@ -0,0 +1,11 @@
|
||||
.. _upgrade-hardware:
|
||||
|
||||
==================
|
||||
Upgrading Hardware
|
||||
==================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
drive-upgrade
|
||||
upgrade-pure
|
||||
92
site/source/misc-guides/upgrade-hardware/upgrade-pure.rst
Normal file
92
site/source/misc-guides/upgrade-hardware/upgrade-pure.rst
Normal file
@@ -0,0 +1,92 @@
|
||||
.. _upgrade-pi:
|
||||
|
||||
=========================
|
||||
Upgrade From Raspberry Pi
|
||||
=========================
|
||||
Follow this guide to upgrade from a Raspberry Pi StartOS server to a Server One, Server Pure, or similar device.
|
||||
|
||||
.. _external-drives:
|
||||
|
||||
External Drive
|
||||
==============
|
||||
If your current Raspberry Pi setup uses an external drive over USB.
|
||||
|
||||
#. Shutdown your Raspberry Pi server and disconnect from power. If you have a speaker, wait for shutdown noises.
|
||||
|
||||
.. figure:: /_static/images/walkthrough/shutdown.png
|
||||
:width: 60%
|
||||
|
||||
.. raw:: HTML
|
||||
|
||||
<audio controls>
|
||||
<source src="/_static/sounds/SHUTDOWN.mp3" type="audio/mpeg">
|
||||
Your browser does not support the audio element.
|
||||
</audio>
|
||||
|
||||
* Shutdown sound
|
||||
|
||||
#. Connect your new server to power and ethernet.
|
||||
|
||||
.. figure:: /_static/images/hardware-pics/pro-all.jpg
|
||||
:width: 60%
|
||||
|
||||
#. Visit http://start.local on any device on the same LAN.
|
||||
|
||||
#. Select "Recover".
|
||||
|
||||
.. figure:: /_static/images/setup/screen0-recover.jpg
|
||||
:width: 60%
|
||||
|
||||
#. Select "Transfer".
|
||||
|
||||
.. figure:: /_static/images/setup/transfer.png
|
||||
:width: 60%
|
||||
|
||||
#. Connect your previous external drive to any USB-3 or USB-C port on your new server.
|
||||
|
||||
#. Select this drive (you may need to hit refresh):
|
||||
|
||||
.. figure:: /_static/images/setup/transfer-from.png
|
||||
:width: 60%
|
||||
|
||||
#. Select the destination drive that you are migrating *to* (this will erase any data on this drive):
|
||||
|
||||
.. figure:: /_static/images/setup/transfer-to.png
|
||||
:width: 60%
|
||||
|
||||
#. You will be asked to create a password. It can be the same as it was previously.
|
||||
|
||||
.. figure:: /_static/images/setup/screen5-set_password.png
|
||||
:width: 60%
|
||||
|
||||
#. Your data will now transfer over - the length of this process will vary depending on how much data you have, but will likely take several hours.
|
||||
|
||||
.. figure:: /_static/images/setup/screen6-storage_initialize.jpg
|
||||
:width: 60%
|
||||
|
||||
#. You are now ready to proceed and use your new server - it will have the same addresses and Root CA as it did before.
|
||||
|
||||
.. figure:: /_static/images/setup/screen7-startfresh_complete.jpg
|
||||
:width: 60%
|
||||
|
||||
.. warning:: DO NOT reconnect your old server without first wiping the SD card and SSD! This can cause serious problems! If you have lightning channels you could lose your money!
|
||||
|
||||
NASPI (Embassy One)
|
||||
===================
|
||||
|
||||
.. figure:: /_static/images/hardware-pics/server-one.png
|
||||
:width: 30%
|
||||
|
||||
#. Get a high quality `USB-A to USB-A cable <https://www.amazon.com/UGREEN-Transfer-Enclosures-Printers-Cameras/dp/B00P0E3954/?th=1>`_, or a `USB-A to USB-C cable <https://www.amazon.com/AmazonBasics-Type-C-USB-Male-Cable/dp/B01GGKYKQM/?th=1>`_.
|
||||
|
||||
#. Disconnect the USB adapter.
|
||||
|
||||
.. figure:: /_static/images/hardware-pics/naspi-jameson-loop2.png
|
||||
:width: 60%
|
||||
|
||||
#. Connect one side of the USB-A cable to the lowest blue USB port on the NASPI, and the other side to your new server.
|
||||
|
||||
.. figure:: /_static/images/hardware-pics/usb-into-naspi-edited.jpg
|
||||
:width: 60%
|
||||
|
||||
#. Follow the instructions above.
|
||||
13
site/source/quick-start.rst
Normal file
13
site/source/quick-start.rst
Normal file
@@ -0,0 +1,13 @@
|
||||
.. _quick-start:
|
||||
|
||||
===========
|
||||
Quick Start
|
||||
===========
|
||||
|
||||
Complete the step below to get up and running with your server in the recommended way:
|
||||
|
||||
1. :ref:`initial-setup` (5 minutes)
|
||||
2. :ref:`trust-ca` (5 minutes)
|
||||
3. :ref:`configuring-ff` (3 minutes)
|
||||
4. :ref:`connecting-lan` (1-4 minutes)
|
||||
5. :ref:`connecting-tor` (4-8 minutes)
|
||||
@@ -4,7 +4,7 @@
|
||||
Bitcoin
|
||||
=======
|
||||
|
||||
These guides will help you to setup external tools to connect or interact with :ref:`Bitcoin<bitcoin>`, such as a wallet.
|
||||
These guides will help you to setup external tools to connect or interact with Bitcoin, such as a wallet.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
@@ -10,7 +10,7 @@ If you'd like to connect via `LNbits <https://marketplace.start9.com/marketplace
|
||||
|
||||
.. note:: We are going to connect using Tor so that Alby will be able to connect from anywhere.
|
||||
|
||||
#. Make sure you are already :ref:`running Tor<connecting-tor>` on your system and we suggest using Firefox which must be :ref:`configured to use Tor.<connecting-ff>`
|
||||
#. Make sure you are already :ref:`running Tor<connecting-tor>` on your system and we suggest using Firefox which must be :ref:`configured to use Tor.<configuring-ff>`
|
||||
|
||||
#. Download the Alby extension by visiting the `Alby Github <https://github.com/getAlby/lightning-browser-extension#installation>`_, selecting your browser, and installing.
|
||||
#. On the Alby welcome screen, select **Get Started**.
|
||||
@@ -9,7 +9,7 @@ Alby
|
||||
|
||||
Alby is a browser extension that can be connected to your lightning node a number of ways. This guide will go over connecting via LNbits which allows allocation of funds.
|
||||
|
||||
Make sure you are already :ref:`running Tor<connecting-tor>` on your system and we suggest using Firefox which must be :ref:`configured to use Tor.<connecting-ff>`
|
||||
Make sure you are already :ref:`running Tor<connecting-tor>` on your system and we suggest using Firefox which must be :ref:`configured to use Tor.<configuring-ff>`
|
||||
|
||||
#. Download the Alby extension by visiting the `Alby Github <https://github.com/getAlby/lightning-browser-extension#installation>`_, selecting your browser, and installing.
|
||||
#. On the Alby welcome screen, select **Get Started**.
|
||||
@@ -66,7 +66,7 @@ Make sure you are already :ref:`running Tor<connecting-tor>` on your system and
|
||||
:width: 45%
|
||||
:alt: alby-lnbits-fields-complete
|
||||
|
||||
.. tip:: Make sure to include the http:// at the start of the address. If it is not working make sure that you are already :ref:`running Tor<connecting-tor>` on your system and that your browser is :ref:`configured to use Tor.<connecting-ff>`
|
||||
.. tip:: Make sure to include the http:// at the start of the address. If it is not working make sure that you are already :ref:`running Tor<connecting-tor>` on your system and that your browser is :ref:`configured to use Tor.<configuring-ff>`
|
||||
|
||||
#. Once connected you should see the following success page:
|
||||
|
||||
@@ -10,7 +10,7 @@ If you'd like to connect via `LNbits <https://marketplace.start9.com/marketplace
|
||||
|
||||
.. note:: We are going to connect using Tor so that Alby will be able to connect from anywhere.
|
||||
|
||||
#. Make sure you are already :ref:`running Tor<connecting-tor>` on your system and we suggest using Firefox which must be :ref:`configured to use Tor.<connecting-ff>`
|
||||
#. Make sure you are already :ref:`running Tor<connecting-tor>` on your system and we suggest using Firefox which must be :ref:`configured to use Tor.<configuring-ff>`
|
||||
|
||||
#. Download the Alby extension by visiting the `Alby Github <https://github.com/getAlby/lightning-browser-extension#installation>`_, selecting your browser, and installing.
|
||||
#. On the Alby welcome screen, select **Get Started**.
|
||||
@@ -39,7 +39,7 @@ If you'd like to connect via `LNbits <https://marketplace.start9.com/marketplace
|
||||
:width: 50%
|
||||
:alt: alby-lnd-rest-entered
|
||||
|
||||
.. note:: If this does not work, please ensure that :ref:`Tor is running on your system<connecting-tor>` and that :ref:`Firefox is configured to use it.<connecting-ff>` If you can't get this to work it's OK to use the Companion App - but you will have a better experience with your Start9 server elsewhere if you take the time to get Tor running on your devices.
|
||||
.. note:: If this does not work, please ensure that :ref:`Tor is running on your system<connecting-tor>` and that :ref:`Firefox is configured to use it.<configuring-ff>` If you can't get this to work it's OK to use the Companion App - but you will have a better experience with your Start9 server elsewhere if you take the time to get Tor running on your devices.
|
||||
|
||||
#. Once connection is completed you will see a success page that displays the balance of your LND node in Sats.
|
||||
|
||||
@@ -21,7 +21,7 @@ If you are looking to connect the `Alby <https://github.com/getAlby/lightning-br
|
||||
Setting up LNbits
|
||||
-----------------
|
||||
|
||||
.. note:: You will need a Tor enabled browser. We suggest using Firefox which will need to have been setup to use Tor - if you have yet to do this please see our guide :ref:`here<connecting-ff>`. This also requires having :ref:`native tor setup<connecting-tor>`.
|
||||
.. note:: You will need a Tor enabled browser. We suggest using Firefox which will need to have been setup to use Tor - if you have yet to do this please see our guide :ref:`here<configuring-ff>`. This also requires having :ref:`native tor setup<connecting-tor>`.
|
||||
|
||||
#. Start by ensuring that you have LNbits installed already as well as LND or Core Lightning (CLN). You also need your lightning node to have at least one channel set up otherwise payments will not work. If you have not set up a channel yet, please follow :ref:`this guide<lightning-intro>`.
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user