Start9/documentation
2
0
Fork 0
mirror of https://github.com/Start9Labs/documentation.git synced 2026-03-30 04:01:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

restructure docs

Browse Source
This commit is contained in:
Matt Hill
2023-11-06 12:34:37 -07:00
parent 80651a6609
commit fe79d71e7c
150 changed files with 404 additions and 1866 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
site/source/service-guides/bitcoin/bitcoin-cli.rst Normal file
View File

@@ -0,0 +1,26 @@
.. _bitcoin-cli:
===========
Bitcoin CLI
===========
Instructions for accessing the bitcoind service in order to issue commands directly.
.. warning:: This is an advanced feature and should be used with caution. Start9 is not responsible for any damage you might cause through SSH access.
#. First, you will need SSH access. Please see the :ref:`setup instructions <ssh>` for details.
#. Access your server and then you can interact with the bitcoind docker container using the following syntax:
.. code-block:: bash
sudo docker exec -ti bitcoind.embassy bitcoin-cli COMMAND
.. tip:: For example ``sudo docker exec -ti bitcoind.embassy bitcoin-cli getnetworkinfo``
A list of possible commands can be found `here <https://developer.bitcoin.org/reference/rpc/>`__.
You can also drop into a shell using::
sudo docker exec -ti bitcoind.embassy bash
and then enter ``bitcoin-cli`` commands. When you are finished, simply type ``exit``...

176
site/source/service-guides/bitcoin/bitcoin-integrations.rst Normal file
View File

@@ -0,0 +1,176 @@
.. _bitcoin-integrations:
====================
Bitcoin Integrations
====================
.. contents::
:depth: 2
:local:
Here you will find guides on how to connect different kinds of Bitcoin wallets (hardware and software) to your server's node, to complete your sovereign Bitcoin stack!
.. _blockstream-green:
Blockstream Green
-----------------
**Available For**
- Android
- iOS
- Linux
- macOS
- Windows
**Instructions**
Follow the `guide <https://github.com/Start9Labs/electrs-wrapper/blob/master/docs/integrations/blockstreamgreen/guide.md>`__.
.. _blue-wallet-bitcoin:
BlueWallet
----------
**Available For**
- Android
- iOS
**Instructions**
Follow the `guide <https://github.com/Start9Labs/electrs-wrapper/blob/master/docs/integrations/bluewallet/guide.md>`__.
.. _electrum:
Electrum
--------
**Available For**
- Android
- Linux
- macOS
- Windows
**Instructions**
Follow the `guide <https://github.com/Start9Labs/electrs-wrapper/blob/master/docs/integrations/electrum/guide.md>`__.
.. _fully-noded:
FullyNoded
----------
**Available For**
- iOS
- macOS
**Instructions**
#. In Fully Noded, go to `Settings > Node Manager > +`
#. Enter your Bitcoin Core credentials. You can do this in one of two ways:
(A) Use Fully Noded to scan your QuickConnect QR code (located in `Services > Bitcoin Core > properties`); or
(B) copy/paste your Bitcoin Core Tor Address (located in `Services > Bitcoin Core > Interfaces`) with :8332 appended, as well as you rpc username and password (located in `Services > Bitcoin Core > Config > RPC Settings`).
.. _ledger-live:
.. Ledger Live
.. ===========
.. .. tip:: Built for use with Ledger hardware devices
.. .. warning:: UNTESTED
.. _nunchuk:
Nunchuk
-------
**Available For**
- Android
- iOS
- Linux
- macOS
- Windows
**Instructions**
#. Install the `Electrs` service from the Start9 Marketplace
#. Follow the `guide <https://github.com/Start9Labs/electrs-wrapper/blob/master/docs/integrations/nunchuk/guide.md>`__.
.. _samourai:
Samourai
--------
.. note:: Not Possible at this time - Requires Dojo Stack
.. _sparrow:
Sparrow
-------
**Available For**
- Linux
- macOS
- Windows
**Instructions**
Connect Sparrow directly to your `Bitcoin Core`:
* Follow this `guide <https://github.com/Start9Labs/bitcoind-wrapper/blob/master/docs/integrations/sparrow/guide.md>`__.
**CAUTION** Until we get per-user rpc restrictions built into Bitcoin Core, this is technically more dangerous than using the electrum server method, because it requires createwallet and similar RPC calls. However, exploiting it relies on there being a vulnerability in Bitcoin Core. Likely there isn't, but if this makes you uneasy, please use the electrs method below.
**OPTIONAL** (but less reliable) -- Connect Sparrow to Electrs via Tor:
#. Install the `Electrs` service from the Start9 Marketplace
#. Follow this `guide <https://github.com/Start9Labs/electrs-wrapper/blob/master/docs/integrations/sparrow/guide.md>`__.
.. _specter-wallet:
Specter
-------
**Available For**
- Linux
- macOS
- StartOS
- Windows
**Instructions**
Follow the guide for `macOS <https://github.com/Start9Labs/bitcoind-wrapper/blob/master/docs/integrations/specter/macos.md>`__ or `Windows <https://github.com/Start9Labs/bitcoind-wrapper/blob/master/docs/integrations/specter/windows.md>`__.
.. _trezor-suite:
Trezor Suite
------------
.. tip:: Built for use with Trezor hardware devices
**Available For**
- Linux
- macOS
- Windows
**Instructions**
Follow the `guide <https://github.com/Start9Labs/electrs-wrapper/blob/master/docs/integrations/trezor/guide.md>`__.

60
site/source/service-guides/bitcoin/blockchain-copy.rst Normal file
View File

@@ -0,0 +1,60 @@
.. _blockchain-copy:
====================
Blockchain Migration
====================
.. contents::
:depth: 2
:local:
.. warning:: This is an advanced feature and should be used with caution. Start9 is not responsible for any damage you might cause through SSH access.
If you have already synced the Bitcoin blockchain to the tip on one server, and would like to skip IBD on another server, follow this guide.
.. note:: The following guide requires that you have already :ref:`setup SSH on both Start9 servers<ssh>`.
In this guide, we will refer to your synced server as example-aaa.local and the server with no Bitcoin synced as example-bbb.local. Of course, please replace example-aaa and example-bbb with your corresponding Start9 servers' unique `adjective-noun` names.
**Install but don't start Bitcoin Core on the blockchain-less server**
#. Log into `https://example-bbb.local` and install Bitcoin Core (**Marketplace > Bitcoin > Bitcoin Core > Install**). Do *NOT* yet **CONFIGURE** or **START** Bitcoin Core.
**Prep your server with the synced blockchain**
#. Stop the Bitcoin Core service on `https://example-aaa.local` (**Services > Bitcoin Core > Stop**)
#. :ref:`Open an ssh session <connecting-via-ssh>` to example-aaa.local
#. Once at the shell, perform the following commands
.. code-block:: bash
sudo -i
mkdir -m 0700 -p .ssh
ssh-keygen -t ed25519 -N '' -f .ssh/example-bbb.key
chmod 600 .ssh/example-bbb.key*
cat .ssh/example-bbb.key.pub
#. Copy the output from the cat command into example-bbb's **System > SSH > Add New Key** text field:
.. figure:: /_static/images/walkthrough/ssh_key_add.jpg
#. Back on the shell of example-aaa.local, do the following (don't forget to replace example-bbb in the rsync command below before you perform it):
.. code-block:: bash
cd /embassy-data/package-data/volumes/bitcoind/data/main/
rsync -e "ssh -i ~/.ssh/example-bbb.key" -povgr --append-verify --rsync-path="sudo mkdir -p /embassy-data/package-data/volumes/bitcoind/data/main ; sudo rsync" ./{blocks,chainstate} start9@example-bbb.local:/embassy-data/package-data/volumes/bitcoind/data/main/
#. Wait some hours until the copy is complete. On a gigabit network, the limiting factor will be the write speed of your SSD on the receiving server. When it is complete, clean up a bit:
.. code-block:: bash
rm .ssh/example-bbb.key*
exit
#. Switch back to `https://example-bbb.local`, selecting **Services > Bitcoin Core**, **CONFIGURE**, configure it as desired, **SAVE** and then **START** your Bitcoin Core service. You should see it begin at 99%+ pre-synced.
#. You can now restart your Bitcoin Core service on `https://example-aaa.local` via **Services > Bitcoin Core > Start**.
.. _bitcoin-service:

14
site/source/service-guides/bitcoin/index.rst Normal file
View File

@@ -0,0 +1,14 @@
.. _bitcoin-service:
=======
Bitcoin
=======
These guides will help you to setup external tools to connect or interact with Bitcoin, such as a wallet.
.. toctree::
:maxdepth: 1
bitcoin-integrations
bitcoin-cli
blockchain-copy

17
site/source/service-guides/index.rst Normal file
View File

@@ -0,0 +1,17 @@
.. _service-guides:
==============
Service Guides
==============
These guides will help you to setup external tools to connect or interact with specific :ref:`Services<managing-services>`.
.. toctree::
:maxdepth: 2
bitcoin/index
jellyfin/index
lightning/index
matrix
nextcloud/index
specter/index
vaultwarden/index

16
site/source/service-guides/jellyfin/index.rst Normal file
View File

@@ -0,0 +1,16 @@
.. _jellyfin-service:
========
Jellyfin
========
Jellyfin is a self-hosted media server capable of serving a variety of content such as movies, shows, music, books, and photos.
.. note:: Jellyfin is not configured to store media files; Instead the media files 'live' on service dependencies - Filebrowser and/or Nextcloud.
Follow the guide below to get the most out of your Jellyfin server.
.. toctree::
:maxdepth: 2
jellyfin-clients

87
site/source/service-guides/jellyfin/jellyfin-clients.rst Normal file
View File

@@ -0,0 +1,87 @@
.. _jellyfin-clients:
================
Jellyfin Clients
================
.. contents::
:depth: 2
:local:
.. _jellyfin-webapp:
After setup has been completed per the Instructions on the StartOS Jellyfin service page, there are many ways to connect to and use your Jellyfin server.
.. note:: While the Jellyfin server is accessable over tor for many clients, connecting over LAN via your Jellyfin ``.local`` URL is recommended for the best streaming experience.
Web Application
---------------
1. Launch the Jellyfin web application from the desired interface (``.local`` recommended). If you are having trouble connecting, make sure your browser and OS have been setup to connect to :ref:`LAN <connecting-lan>` or :ref:`Tor <connecting-tor>` depending on the interface you are using.
Mobile Apps
-----------
Android
=======
Before proceeding, make sure your Android device has been setup to connect over :ref:`LAN <ca-android>`. If you are connecting over tor, you will need to :ref:`Setup Tor <tor-android>`.
1. Visit the app store of your choice and download the `Jellyfin Android app <https://jellyfin.org/downloads>`_.
2. Open the app, you will be prompted for a host; paste the URL (``.local`` recommended) from your Jellyfin service page -> Interfaces in this field.
.. tip:: If you are getting connection errors, make sure you are connected to the same LAN and a VPN is not blocking use on your Android device.
iOS
===
Before proceeding, make sure your Apple device has been setup to connect over :ref:`LAN <ca-ios>`. If you are connecting over tor, you will need to :ref:`Setup Tor <tor-ios>`.
1. Open the Apple app store and download the `Jellyfin iOS app <https://apps.apple.com/pl/app/jellyfin-mobile/id1480192618>`_.
2. Open the app, you will be prompted for a server address; paste the URL (``.local`` recommended) from your Jellyfin service page -> Interfaces.
.. figure:: /_static/images/services/jellyfin/jellyfin-iOS-1.png
:width: 40%
:alt: Server address
3. Next enter your username and password and tap "Sign In".
.. figure:: /_static/images/services/jellyfin/jellyfin-iOS-2.png
:width: 40%
:alt: sign in
.. tip:: If you encounter connection errors, please ensure that you are connected to the same LAN, and there is no VPN blocking use on your Apple device.
Desktop Apps
------------
MacOS
=====
Before proceeding, make sure your Apple device has been setup to connect over :ref:`LAN <ca-mac>`.
1. Download the .dmg file for `Jellyfin Media Player <https://github.com/jellyfin/jellyfin-media-player/releases>`_
2. Upon opening the client, you will be prompted to add server. Click "Add Server".
.. figure:: /_static/images/services/jellyfin/jellyfin-mac-1.png
:width: 60%
:alt: add server
3. Next you will be prompted for a server address; paste the URL (``.local`` recommended) from Jellyfin service interfaces and click "Connect".
.. figure:: /_static/images/services/jellyfin/jellyfin-mac-2.png
:width: 60%
:alt: server address
4. Next enter your username and password and click "Sign In".
.. figure:: /_static/images/services/jellyfin/jellyfin-mac-3.png
:width: 60%
:alt: sign in
That's it. You should be connected to your Jellyfin server. If you encounter connection errors, please ensure that you are connected to the same LAN, and there is no VPN active on your Apple device.
Other Clients
-------------
Jellyfin has numerous other `clients <https://jellyfin.org/downloads/>`_, not all of which have been tested at the time of this writing. If you are able to test (successfully or unsucessfully) an app not documented in this guide, your feedback would be much appreciated.
.. note:: Some clients such as 'Jellyfin for Roku' and 'Swiftfin' (tvOS) are not configured to use Local DNS - as a result, these clients are unable to resolve private urls like ``.local``.

73
site/source/service-guides/lightning/alby-cln.rst Normal file
View File

@@ -0,0 +1,73 @@
.. _alby-cln:
====
Alby
====
Alby is a browser extension that can be connected to your lightning node a number of ways. This guide will go over direct connections between Alby and your **Core Lightning** node.
If you'd like to connect via `LNbits <https://marketplace.start9.com/marketplace/lnbits>`_ which allows allocation of funds, please see :ref:`this guide<connecting-lnbits>`.
.. 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.<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**.
#. Create a strong password and store it somewhere safe, like your Vaultwarden password manager.
#. On the next screen, select **Other Wallets** and click **Connect**.
#. Click **Start9** then **Core Lightning**.
.. figure:: /_static/images/lightning/alby-start9.png
:width: 50%
:alt: alby-start9
.. figure:: /_static/images/lightning/alby-cln-0.png
:width: 50%
:alt: alby-cln-0
#. You will see the following fields to fill out:
.. figure:: /_static/images/lightning/alby-cln-empty.png
:width: 40%
:alt: alby-cln-empty
#. For "Host" this is your Peer Interface - find this at the top of **Interfaces** within the CLN service on your Start9 server. Copy the address shown here but remove the *http://* at the start and paste it into **Host** within Alby:
.. figure:: /_static/images/lightning/cln-peer-interface.png
:width: 40%
:alt: cln-peer-interface
#. For **Public key** enter your **Node Id** found at the top of **Properties** within the CLN service on your server.
.. figure:: /_static/images/lightning/cln-nodeid.png
:width: 40%
:alt: cln-nodeid
#. For **Rune** you will need to install the `Spark <https://marketplace.start9.com/marketplace/spark-wallet>`_ service on your server, launch the UI, click in the bottom left where you see "v0.3.2" or something similar, and click **Console**.
.. figure:: /_static/images/lightning/enable-console-spark.png
:width: 40%
:alt: enable-console-spark
#. Enter "commando-rune", hit **execute** and then copy what you see after **rune:** and paste it into Alby.
.. figure:: /_static/images/lightning/commando-rune.png
:width: 40%
:alt: commando-rune
#. Leave the **Port** as 9735. It should look like this:
.. figure:: /_static/images/lightning/alby-cln-filled-out.png
:width: 40%
:alt: alby-cln-filled-out
#. Click **Continue**. Once the connection is completed you will see a success page that displays the balance of your CLN node in Sats.
.. figure:: /_static/images/lightning/alby-cln-success.png
:width: 40%
:alt: alby-cln-success
Alby is now connected to your CLN node over Tor!

87
site/source/service-guides/lightning/alby-lnbits.rst Normal file
View File

@@ -0,0 +1,87 @@
.. _alby-lnbits:
Alby
----
.. note:: This guide assumes you have already setup LNbits as per :ref:`this guide <connecting-lnbits>`.
.. note:: This will work with either LND *or* CLN as your underlying node!
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.<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**.
#. Create a strong password and store it somewhere safe, like your Vaultwarden password manager.
#. On the next screen, select **Other Wallets** and click **Connect**.
#. Click **Start9** then **LNbits**:
.. figure:: /_static/images/lightning/alby-start9.png
:width: 50%
:alt: alby-start9
.. figure:: /_static/images/services/lnbits/alby-lnbits-select.png
:width: 50%
:alt: alby-lnbits-select
#. You will be brought to this page:
.. figure:: /_static/images/services/lnbits/alby-lnbits-fields.png
:width: 40%
:alt: alby-lnbits-fields
#. Head back to LNbits and select the wallet you created then click on the arrow to the right of **API Info**:
.. figure:: /_static/images/services/lnbits/lnbits-api-dropdown.png
:width: 55%
:alt: api-info-dropdown
#. Copy the **Admin key** and paste it into Alby:
.. figure:: /_static/images/services/lnbits/lnbits-admin-key.png
:width: 50%
:alt: lnbits-admin-key
.. figure:: /_static/images/services/lnbits/alby-lnbits-admin-key.png
:width: 45%
:alt: alby-lnbits-admin-key
#. Head back to your Start9 server's LNbits service page and select **Interfaces**:
.. figure:: /_static/images/services/lnbits/lnbits-interfaces.png
:width: 55%
:alt: lnbits-interfaces
#. Copy the Tor Address:
.. figure:: /_static/images/services/lnbits/lnbits-interfaces-tor-address.png
:width: 65%
:alt: lnbits-interfaces-tor-address
#. Head back to Alby and paste what you just copied into **LNbits URL**, select **Tor (native)** then hit **Continue**:
.. figure:: /_static/images/services/lnbits/alby-lnbits-fields-complete.png
: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.<configuring-ff>`
#. Once connected you should see the following success page:
.. figure:: /_static/images/lightning/alby-cln-success.png
:width: 40%
:alt: alby-cln-success
Alby is now connected to your lightning node via LNbits!
#. In addition to allocating sats to this wallet via the LNbits Superuser Account (see "Funding LNbits section" :ref:`here<connecting-lnbits>`), you can also receive funds the normal way by hitting **Receive** within Alby.
.. figure:: /_static/images/services/lnbits/alby-receive.png
:width: 25%
:alt: alby-receive
.. note:: Funds received this way must be sent from another lightning node, not the node underneath LNbits. A lightning payment that originates and terminates at the same node is technically a rebalance, not a normal payment.
You're now setup with Alby and LNbits!

45
site/source/service-guides/lightning/alby-lnc.rst Normal file
View File

@@ -0,0 +1,45 @@
.. _alby-lnc:
====
Alby
====
Alby is a browser extension that can be connected to your lightning node a number of ways.
This guide will go over **direct connections** between **Alby and LND** using **LNC**.
.. tip:: If you'd like to connect using LND's REST API see :ref:`here<alby-lnd>`. If you'd like to connect via LNbits which allows allocation of funds, please see :ref:`this guide<connecting-lnbits>`.
.. note:: Requires the `Lightning Terminal <https://marketplace.start9.com/marketplace/lightning-terminal>`_ service and only possible with LND nodes.
Available For:
- Chrome-based browsers
- Firefox
#. 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**.
#. Create a strong password and store it somewhere safe, like your Vaultwarden password manager.
#. On the next screen, select **Other Wallets** and click **Connect**.
#. Click on **Start9** then on **Lightning Terminal (LNC)**.
.. figure:: /_static/images/lightning/alby-start9.png
:width: 50%
:alt: alby-start9
.. figure:: /_static/images/lightning/alby-start9-lnc.png
:width: 50%
:alt: alby-start9-lnc
#. You will see the following screen. Launch the Lightning Terminal service UI from your Start9 server and do as instructed below:
.. figure:: /_static/images/lightning/alby-lnc-fields.png
:width: 50%
:alt: alby-lnd-fields
#. Click **Continue** and you will see this once you successfully connect:
.. figure:: /_static/images/lightning/alby-success.png
:width: 50%
:alt: alby-success

49
site/source/service-guides/lightning/alby-lnd.rst Normal file
View File

@@ -0,0 +1,49 @@
.. _alby-lnd:
====
Alby
====
Alby is a browser extension that can be connected to your lightning node a number of ways. This guide will go over direct connections between Alby and your **LND node**.
If you'd like to connect via `LNbits <https://marketplace.start9.com/marketplace/lnbits>`_ which allows allocation of funds, please see :ref:`this guide<connecting-lnbits>`.
.. 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.<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**.
#. Create a strong password and store it somewhere safe, like your Vaultwarden password manager.
#. On the next screen, select **Other Wallets** and click **Connect**.
#. Select **Start9** and then **LND**:
.. figure:: /_static/images/lightning/alby-start9.png
:width: 50%
:alt: alby-start9
.. figure:: /_static/images/lightning/alby-select-lnd.png
:width: 50%
:alt: alby-select-lnd
#. Copy the **LND Connect REST URL** from your LND service page's **Properties** section and paste it into Alby:
.. figure:: /_static/images/lightning/lnd-connect-rest-url.png
:width: 60%
:alt: lnd-connect-rest-url
#. Alby will pick up that you are connecting over Tor and suggest using their Companion App (only needed if your browser isn't setup to use Tor) or using Tor natively which you will be able to do. Select **TOR (native)** and click **Continue**:
.. figure:: /_static/images/lightning/alby-lnd-rest-entered.png
: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.<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.
.. figure:: /_static/images/lightning/alby-success.png
:width: 60%
You are now setup to use your LND node from anywhere using Alby!

115
site/source/service-guides/lightning/bluewallet.rst Normal file
View File

@@ -0,0 +1,115 @@
.. _blue-wallet:
BlueWallet
----------
.. note:: This guide assumes you have already setup LNbits as per :ref:`this guide <connecting-lnbits>` with **LND** as your underlying node.
.. warning:: **This will not work with CLN as your underlying node!**
#. Bluewallet requires that we use the LnbHub extension in order to connect to LNbits.
#. To do this, click **Manage Extensions**:
.. figure:: /_static/images/services/lnbits/manage-extensions.png
:width: 50%
:alt: manage-extensions
#. Click **MANAGE** under the LndHub extension:
.. figure:: /_static/images/services/lnbits/lndhub-manage.png
:width: 40%
:alt: lndhub-manage
#. Click the two arrows on the right, then click install:
.. figure:: /_static/images/services/lnbits/arrows-install.png
:width: 40%
:alt: arrows-install
#. Now ensure that it says **Activated** underneath LndHub and then click **Extensions** on the left:
.. figure:: /_static/images/services/lnbits/activated-click-extensions.png
:width: 40%
:alt: activated-click-extensions
#. Click **ENABLE**:
.. figure:: /_static/images/services/lnbits/extensions-enable.png
:width: 40%
:alt: extensions-enable
#. Click **OPEN** *or* **LndHub** under *Extensions*:
.. figure:: /_static/images/services/lnbits/lndhub-open.png
:width: 40%
:alt: lndhub-open
#. Make sure the wallet you just created is selected below the two QR codes:
.. figure:: /_static/images/services/lnbits/lndhub-select-wallet.png
:width: 40%
:alt: lndhub-select-wallet
#. Open up BlueWallet and click on the three dots in the top right:
.. figure:: /_static/images/services/lnbits/bluewallet-three-dots.jpg
:width: 20%
#. Click "Network" then "Tor settings":
.. figure:: /_static/images/services/lnbits/bluewallet-network.jpg
:width: 20%
.. figure:: /_static/images/services/lnbits/bluewallet-tor-settings.jpg
:width: 20%
#. Click "Start" and it should say "Done" after a short time:
.. figure:: /_static/images/services/lnbits/bluewallet-tor-start.jpg
:width: 20%
.. figure:: /_static/images/services/lnbits//bluewallet-tor-done.jpg
:width: 20%
#. Head back to the main screen and click the **"+"** sign:
.. figure:: /_static/images/services/lnbits/bluewallet-add-wallet.jpg
:width: 20%
#. Click "Import wallet":
.. figure:: /_static/images/services/lnbits/bluewallet-plus.jpg
:width: 20%
#. Click "Scan or import a file"
.. note:: Screenshots not possible for this step!
#. *If you only want this wallet to be able to RECEIVE PAYMENTS, scan this QR code:*
.. figure:: /_static/images/services/lnbits/left-qr.png
:width: 40%
:alt: left-qr
*If you are happy for this wallet to be able to both receive and MAKE payments scan this QR code:*
.. figure:: /_static/images/services/lnbits/right-qr.png
:width: 40%
:alt: right-qr
#. You'll see this once the wallet is added:
.. figure:: /_static/images/services/lnbits/bluewallet-wallet-added.jpg
:width: 30%
:alt: bluewallet-with-funds
#. In addition to allocating sats to this wallet via the LNbits Superuser Account (see "Funding LNbits section" :ref:`here<connecting-lnbits>`), you can also receive funds the normal way by hitting "Receive" within BlueWallet.
.. figure:: /_static/images/services/lnbits/blue-wallet-receive.jpg
:width: 25%
:alt: blue-wallet-receive
.. note:: Funds received this way must be sent from another lightning node, not the LND node underneath LNbits. A lightning payment that originates and terminates at the same node is technically a rebalance, not a normal payment.
Congratulations! BlueWallet is set up and ready to use lightning via your own lightning node - furthermore it will only be able to use your node in the way you allow it, via LNbits.

18
site/source/service-guides/lightning/connecting-cln.rst Normal file
View File

@@ -0,0 +1,18 @@
.. _connecting-cln:
==================================
Connect Directly to Core Lightning
==================================
Core Lightning is one of the two lightning implementations found on Start9 servers. It was created and is maintained by `Blockstream <https://blockstream.com>`_.
If you want to connect a wallet to it, you can do so using one of the following guides:
.. toctree::
:maxdepth: 1
alby-cln
fully-noded-cln
ride-the-lightning
spark
zeus-cln-direct

84
site/source/service-guides/lightning/connecting-lnbits.rst Normal file
View File

@@ -0,0 +1,84 @@
.. _connecting-lnbits:
======
LNbits
======
The concept
-----------
LNbits allows you to create a wallet that makes use of your node with only an alloted amount of sats. This restriction can be very helpful for if you only want to have a small amount for spending on your phone without making your entire lightning balance available. You can even allow other people to have wallets you create for them - think giving your children an allowance. They can start with a set amount (can be zero) and simply spend what you initially make available. They can also earn more for themselves as they will have the freedom to issue their own invoices - all while making use of your node.
.. tip:: All wallets created this way are ultimately bound by the capacity of your node. If one wallet is allocated 10,000 sats but your underlying node only has 9000 sats of outbound capacity, payments will simply fail.
What lightning node should I use?
---------------------------------
This will work for both **Core Lightning (CLN)** and **LND** *but* if you want to connect :ref:`Zeus<zeus-lnbits>` or :ref:`BlueWallet<blue-wallet>` to LNbits then **this will only work with LND** as the underlying node. This is because the LNDhub plugin will be required.
If you are looking to connect the `Alby <https://github.com/getAlby/lightning-browser-extension#installation>`_ browser extension to your LNbits wallet, that will work with **both CLN** *and* **LND**.
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<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>`.
.. figure:: /_static/images/services/lnbits/lnbits-lnd-cln-installed.png
:width: 40%
:alt: lnbits-lnd-cln-installed
.. tip:: Remember - if you intend to connect BlueWallet or Zeus, that will only be possible with LND. Alby can work with both.
#. Head to LNbits on your server, click on **Properties** and copy the address under **(Tor) Superuser Account**:
.. figure:: /_static/images/services/lnbits/tor-super-user.png
:width: 40%
:alt: tor-super-user
#. Paste this address into your browser and you'll see the following screen - click **I understand**:
.. figure:: /_static/images/services/lnbits/superuser-first-open.png
:width: 60%
:alt: superuser-first-open
.. note:: This isn't a concern on StartOS as all wallets created will have the address they generated stored within **Properties** within the LNbits serivce.
#. Now a default wallet will have already been generated - highlighted on the top left. We'll rename it by clicking **Rename wallet** entering **android-zeus-wallet** then clicking **UPDATE NAME**:
.. figure:: /_static/images/services/lnbits/rename-default-wallet.png
:width: 60%
:alt: rename-default-wallet
.. note:: I have called the wallet "android-zeus-wallet" but it is fine to use other wallets.
Now you can proceed to connect one of the following wallets to LNbits using the guides below:
.. toctree::
:maxdepth: 1
alby-lnbits
bluewallet
zeus-lnbits
Funding LNbits
--------------
After any of the above wallets has been setup with the corresponding instructions, you can allocate sats to this wallet within LNbits by clicking the **"+"** icon here:
.. figure:: /_static/images/services/lnbits/plus-icon.png
:width: 60%
:alt: plus-icon
Let's add 1000 satoshis:
.. figure:: /_static/images/services/lnbits/add-1000-sats.png
:width: 60%
:alt: add-1000-sats
.. figure:: /_static/images/services/lnbits/1k-sats.png
:width: 60%
:alt: 1k-sats
Your newly created LNbits wallet has now been funded and is ready to send sats over the Lightning Network!

18
site/source/service-guides/lightning/connecting-lnd.rst Normal file
View File

@@ -0,0 +1,18 @@
.. _connecting-lnd:
=======================
Connect Directly to LND
=======================
The following wallets can connect directly to LND via LND's REST API.
.. tip:: If you'd like to connect via LNbits instead, click :ref:`here<connecting-lnbits>`.
.. toctree::
:maxdepth: 1
alby-lnd
fully-noded-lnd
ride-the-lightning
zap
zeus-lnd-direct

19
site/source/service-guides/lightning/connecting-lndc.rst Normal file
View File

@@ -0,0 +1,19 @@
.. _connecting-lndc:
===============================================
Connect to LND via Lightning Node Connect (LNC)
===============================================
Lightning Node Connect (LNC) provides a very simple way to connect to an LND node that **does not require the Tor network**.
This is **not** the same as **connecting directly to LND** for which guides can be found :ref:`here<connecting-lnd>`.
.. note:: This requires installing the `Lightning Terminal <https://marketplace.start9.com/marketplace/lightning-terminal>`_ service on your Start9 server.
The following two guides go over how to connect wallets to LND via LNC.
.. toctree::
:maxdepth: 1
alby-lnc
zeus-lnc

26
site/source/service-guides/lightning/fully-noded-cln.rst Normal file
View File

@@ -0,0 +1,26 @@
.. _fully-noded-cln:
===========
Fully Noded
===========
Sovereign, secure, powerful, and easy-to-use wallet that utilizes your own CLN node as a backend.
Available For:
- iOS
- macOS
.. note:: Works with both Core Lightning (CLN) and LND! If you'd like to connect Fully Noded to LND instead - please use :ref:`this guide<fully-noded-lnd>`.
#. Download Fully Noded from the Apple app store.
#. Log into your Start9 server UI and select Services -> Core Lightning -> Properties -> Sparko Properties.
.. note:: Unfortunately Fully Noded does not yet support connecting to Sparko via QR code; Instead the Address and Sparko key will need to be individually scanned/copied and pasted into the respective fields in the Fully Noded app.
#. Click the QR code icon next to "Sparko Address" to display the QR code and scan this with your iPhone/mac, or copy/paste through another channel to your client.
#. In Fully Noded, go to Settings -> Node Manager -> + -> Core Lightning
#. Paste the "Sparko Address" from above into the "Address" field, appending a colon and the port i.e. ``:9737`` after ``.onion``
#. Back in your CLN service page, get your "Sparko key" and scan/copy it into the "Sparko key" field in the Fully Noded app.
#. Press "SAVE"
You can now use Fully Noded with your CLN node to send/receive bitcoin over the lightning network, open/close channels, connect to peers, etc!

20
site/source/service-guides/lightning/fully-noded-lnd.rst Normal file
View File

@@ -0,0 +1,20 @@
.. _fully-noded-lnd:
===========
Fully Noded
===========
Sovereign, secure, powerful, and easy-to-use wallet that utilizes your own LND node as a backend.
Available For:
- iOS
- macOS
.. note:: Works with both Core Lightning (CLN) and LND! If you'd like to connect Fully Noded to CLN instead - please use :ref:`this guide<fully-noded-cln>`.
#. Download Fully Noded from the Apple app store.
#. Log into your Start9 server UI and select Services -> LND -> Properties.
#. Click the QR code icon next to "LND Connect REST URL" to display the QR code and scan/copy this with your iPhone/mac.
#. Press "SAVE"
You can now use Fully Noded with your LND node to send/receive bitcoin over the lightning network, open/close channels, connect to peers, etc!

43
site/source/service-guides/lightning/index.rst Normal file
View File

@@ -0,0 +1,43 @@
.. _lightning-service:
=========
Lightning
=========
The following guide will get you up and running with a lightning node and walk you through opening your first channel.
.. toctree::
:maxdepth: 1
lightning-first-channel
Now that you're up and running, it's time to connect an interface so that you can use your node to make and receive payments from anywhere!
If you're using **Core Lightning (CLN)** and would like a direct connection you can select one of the following options:
.. toctree::
:maxdepth: 2
connecting-cln
If you're using **LND**, you can select one of the following options:
.. toctree::
:maxdepth: 2
connecting-lnd
If you would like to connect to LND via Lightning Node Connect **(LNC)** in order to avoid using Tor, you can do so with Alby and Zeus via the Lightning Terminal service:
.. toctree::
:maxdepth: 2
connecting-lndc
If you'd like to allocate only a portion of your lightning node's liquidity to a wallet or have a wallet that can receive but not make payments, you can use **LNbits** - LNbits allows you to create a wallet that makes use of your node with only an alloted amount of sats and it works with both **Core Lightning** and **LND**.
.. toctree::
:maxdepth: 3
connecting-lnbits

194
site/source/service-guides/lightning/lightning-first-channel.rst Normal file
View File

@@ -0,0 +1,194 @@
.. _lightning-intro:
==========================
Opening Your First Channel
==========================
.. contents::
:depth: 2
:local:
Here we'll show you how to install a lightning node and how to open a channel with Start9!
Running a Node and Making a Channel with Start9
_______________________________________________
#. First, ensure that you have Bitcoin Core installed, running, and synced:
.. figure:: /_static/images/lightning/bitcoin-synced.png
:width: 60%
:alt: bitcoin-synced
#. Install a lightning node. There are two options we offer on the `Start9 marketplace <https://marketplace.start9.com>`_ - LND and Core Lightning. In this guide we're going to use Core Lightning (CLN). Though you can use LND and the process will be almost exactly the same.
.. figure:: /_static/images/lightning/two-impls-marketplace.png
:width: 60%
:alt: two-impls-marketplace
#. Install one of the above lightning implementations - as mentioned in this guide we'll use CLN.
.. figure:: /_static/images/lightning/cln-installing.png
:width: 60%
:alt: cln-installing
#. You'll see CLN say **Needs Config**. Click **Configure**:
.. figure:: /_static/images/lightning/cln-needs-config.png
:width: 60%
:alt: cln-needs-config
#. You can leave the settings as their default values and hit **SAVE**.
.. figure:: /_static/images/lightning/cln-save-config.png
:width: 60%
:alt: cln-save-config
#. Now hit **Start** and wait for CLN to sync up to the network. This may take a few hours.
.. figure:: /_static/images/lightning/cln-syncing.png
:width: 60%
:alt: cln-syncing
#. Once the **Synced** health check turns green (as below) you can proceed to the next step.
.. figure:: /_static/images/lightning/cln-green.png
:width: 60%
:alt: cln-green
#. To interact with your node we will use Ride The Lightning (RTL) - this is a service that provides a graphical user interface for our lightning node.
This will work with either (or both!) lightning implementations.
.. figure:: /_static/images/lightning/rtl-in-marketplace1.png
:width: 60%
:alt: rtl-marketplace
#. Install it and click on **Configure** just like with CLN.
.. figure:: /_static/images/lightning/rtl-needs-config.png
:width: 60%
:alt: rtl-needs-config
#. It will default to LND. In this case we are using a CLN node instead, so we will change the default setting as shown:
.. figure:: /_static/images/lightning/rtl-config-lnd.png
:width: 60%
:alt: rtl-config-lnd
Change to Core Lightning (CLN) and hit OK:
.. figure:: /_static/images/lightning/rtl-change-to-cln.png
:width: 60%
:alt: rtl-change-to-cln
Hit **Save**:
.. figure:: /_static/images/lightning/rtl-config-save.png
:width: 60%
:alt: rtl-config-save
#. Now hit **Start**:
.. figure:: /_static/images/lightning/rtl-start.png
:width: 60%
:alt: rtl-start
#. With RTL started, click **Properties**:
.. figure:: /_static/images/lightning/rtl-click-properties.png
:width: 60%
:alt: rtl-click-properties
#. Copy the automatically generated password:
.. figure:: /_static/images/lightning/rtl-copy-pass.png
:width: 60%
:alt: rtl-copy-pass
#. Head back to the RTL service and click **Launch UI**:
.. figure:: /_static/images/lightning/rtl-launch-ui.png
:width: 60%
:alt: rtl-launch-ui
Enter the copied password and log in:
.. figure:: /_static/images/lightning/rtl-enter-pass.png
:width: 60%
:alt: rtl-enter-pass
.. note:: You can add the password to your password manager for convenience.
#. Once in RTL, click **On-chain** then click **Generate Address**:
.. figure:: /_static/images/lightning/rtl-generate-address.png
:width: 60%
:alt: rtl-generate-address
#. Send bitcoin to the generated address to add funds to your lightning wallet:
.. figure:: /_static/images/lightning/rtl-address-generated.png
:width: 60%
:alt: rtl-address-generated
.. note:: Please do not send money to the address pictured above as we will not receive it. If you are intent on sending us money please `head here <https://donate.start9.com>`_
#. Once your sats confirm on-chain you'll see this:
.. figure:: /_static/images/lightning/rtl-on-chain.png
:width: 60%
:alt: rtl-on-chain
#. Now we must add a peer with which to make channels. In this example we will be opening a channel with Start9 so we will add Start9's node as a peer. Click **Peers/Channels**:
.. figure:: /_static/images/lightning/rtl-peers-channels.png
:width: 60%
:alt: rtl-peers-channels
#. Click **Peers** then **Add Peer**:
.. figure:: /_static/images/lightning/rtl-peers-add-peer.png
:width: 60%
:alt: rtl-peers-add-peer
#. Enter the details of the lightning node you'd like to open a channel with. Start9's node can be found `here <https://1ml.com/node/025d28dc4c4f5ce4194c31c3109129cd741fafc1ff2f6ea53f97de2f58877b2295>`_ and is what we'll use in this example. You can use another node if you like - ideally one that is well connected. Once chosen and added as below, click **Add Peer**:
.. figure:: /_static/images/lightning/rtl-start9-node-info.png
:width: 60%
:alt: rtl-start9-node-info
.. note:: The syntax is as follows **NodePublicKey@ipaddress:port** - If it's a Tor node it will be **PublicKey.onion:port** instead.
#. Then you can enter an amount (the size of the channel), select Private Channel (unless you want a public channel - see below), and a Fee Rate (check a `block explorer <https://mempool.space>`_ for an idea of current necessary fees):
.. figure:: /_static/images/lightning/rtl-open-channel.png
:width: 60%
:alt: rtl-open-channel
.. note:: Here we are creating a very small channel with a capacity for payments of only a few dollars. You will likely want your channel to be larger than this so that it's actually usable for reasonably sized payments. Channels this small may well get closed by the remote peer.
.. note:: Using a private channel is what we advise as a default. You may wish for the channel to be public if you intend on becoming a routing node or for other reasons.
#. You will now see your channel in **Channels** -> **Pending/Inactive**:
.. figure:: /_static/images/lightning/rtl-pending-inactive.png
:width: 60%
:alt: rtl-pending-inactive
#. Once the transaction opening the channel gets added to a block your channel will soon appear here under **Open**:
.. figure:: /_static/images/lightning/rtl-open-channels.png
:width: 60%
:alt: rtl-open-channels
#. To make a payment head to the **Transactions** tab and press **Send Payment**:
.. figure:: /_static/images/lightning/rtl-transactions-tab.png
:width: 60%
:alt: rtl-transactions-tab
#. That's it! You now have a lightning node running with a channel open ready to send payments on the lightning network!
.. note:: You will not be able to receive payments until you have inbound liquidity in your channel. After completing the above process you will only have outbound liquidity. Inbound liquidity can be created by making payments, having someone open a channel to you or via more sophisticated channel creation.
If you want to connect other applications or wallets to your node, please see the guides :ref:`here<lightning-service>`.

10
site/source/service-guides/lightning/ride-the-lightning.rst Normal file
View File

@@ -0,0 +1,10 @@
.. _rtl:
Ride the Lightning
------------------
This can simply be installed by going to your Start9 Server's marketplace, clicking on **Ride The Lightning** and then installing the latest version. Once installed you can configure it to work with either - or both - Core Lightning and LND!
.. figure:: /_static/images/lightning/marketplace-rtl.png
:width: 55%
:alt: rtl-within-marketplace

36
site/source/service-guides/lightning/spark.rst Normal file
View File

@@ -0,0 +1,36 @@
.. _spark:
Spark
-----
.. note:: Compatible with Core Lightning (CLN) only
Available For:
- `Android <https://github.com/shesek/spark-wallet/releases>`_
- `StartOS <https://marketplace.start9.com/marketplace/spark-wallet>`_
- `iOS as a PWA <https://github.com/shesek/spark-wallet#progressive-web-app>`_
.. warning:: Please be careful - there are multiple fake "Spark Wallets" out there. The above links have been verified and can be trusted.
To use Spark, you simply install it as a service on your Start9 Server. You can then use it to operate your CLN node by clicking **Launch UI** within the service:
.. note:: This will act as a server as well, and is required if you want to use the mobile app.
.. figure:: /_static/images/lightning/spark-launch-ui.png
:width: 45%
:alt: spark-launch-ui
If you would like to connect a mobile client you can click **Properties**:
.. figure:: /_static/images/lightning/spark-properties.png
:width: 45%
:alt: spark-properties
and then click on the button below to reveal the **Pairing URL** which you then scan with your mobile device.
.. figure:: /_static/images/lightning/spark-pairing.png
:width: 45%
:alt: spark-pairing
.. tip:: On iOS you cannot scan this QR code due to PWAs being forbidden from using the camera. You can instead simply copy and paste the Pairing URL.

27
site/source/service-guides/lightning/zap.rst Normal file
View File

@@ -0,0 +1,27 @@
.. _zap:
Zap
---
Available on `Android <https://play.google.com/store/apps/details?id=zapsolutions.zap>`_ and `iOS <https://apps.apple.com/us/app/zap-bitcoin-lightning-wallet/id1406311960>`_.
.. note:: Compatible with LND only
#. Install Zap via your phone's app store.
#. Go to Settings and activate Tor.
#. Go to **Add a Wallet**
#. Locate the **LND Connect REST URL** from your LND service page's **Properties** section:
.. figure:: /_static/images/lightning/lnd-properties.png
:width: 55%
:alt: lnd-properties
#. Display the QR code by clicking on the following button:
.. figure:: /_static/images/lightning/lnd-connect-qr-code.png
:width: 55%
:alt: lnd-rest
#. Scan the QR code with your phone.
Zap is now connected to your LND node!

40
site/source/service-guides/lightning/zeus-cln-direct.rst Normal file
View File

@@ -0,0 +1,40 @@
.. _zeus-cln:
Zeus
----
.. note:: You must first :ref:`connect to tor on your device<connecting-tor>`.
Zeus is a powerful mobile wallet that can be connected directly to both LND and Core Lightning. If you'd like to connect via LNbits, which allows allocation of funds, please see :ref:`this guide<connecting-lnbits>`.
Available For:
- Android
- iOS
.. note:: Works with both Core Lightning (CLN) and LND! If you'd like to connect Zeus to LND instead - please use :ref:`this guide<zeus-lnd>`.
#. Download `Zeus <https://zeusln.app/>`_ for your device.
#. Log into StartOS and select Services -> Core Lightning -> Properties.
.. figure:: /_static/images/lightning/zeus-cln-direct-step3.png
:width: 60%
#. Tap the QR code icon for "REST Quick Connect" to display the QR code.
.. figure:: /_static/images/lightning/zeus-cln-direct-step4.png
:width: 60%
#. In Zeus, tap "Scan node config". Allow camera access, scan the QR code, and then tap 'Save node config'.
.. figure:: /_static/images/lightning/zeus-cln-direct-step5.png
:width: 60%
.. note:: If you already have other nodes configured in Zeus, go to Settings.-> Connect a node -> + . Then scan the QR code, and tap "Save node config".
.. figure:: /_static/images/lightning/zeus-cln-direct-step6.png
:width: 40%
#. That's it. You can now use your Core Lightning Node via Zeus.

108
site/source/service-guides/lightning/zeus-lnbits.rst Normal file
View File

@@ -0,0 +1,108 @@
.. _zeus-lnbits:
Zeus
----
.. note:: This is not the same as connecting Zeus directly to your lightning node - using LNbits allows us to allocate a specific amount of funds to Zeus instead of giving it full access to your lightning node. We can also use LNbits to permit Zeus to **just receive** satoshis, or the ability to both **receive and spend** satoshis.
.. note:: This guide assumes you have already setup LNbits as per :ref:`this guide <connecting-lnbits>` with **LND** as your underlying node.
.. warning:: **This will not work with CLN as your underlying node!**
#. Zeus requires that we use the LnbHub extension in order to connect to LNbits.
#. To do this, click **Manage Extensions**:
.. figure:: /_static/images/services/lnbits/manage-extensions.png
:width: 50%
:alt: manage-extensions
#. Click **MANAGE** under the LndHub extension:
.. figure:: /_static/images/services/lnbits/lndhub-manage.png
:width: 40%
:alt: lndhub-manage
#. Click the two arrows on the right, then click install:
.. figure:: /_static/images/services/lnbits/arrows-install.png
:width: 40%
:alt: arrows-install
#. Now ensure that it says **Activated** underneath LndHub and then click **Extensions** on the left:
.. figure:: /_static/images/services/lnbits/activated-click-extensions.png
:width: 40%
:alt: activated-click-extensions
#. Click **ENABLE**:
.. figure:: /_static/images/services/lnbits/extensions-enable.png
:width: 40%
:alt: extensions-enable
#. Click **OPEN** *or* **LndHub** under *Extensions*:
.. figure:: /_static/images/services/lnbits/lndhub-open.png
:width: 40%
:alt: lndhub-open
#. Make sure the wallet you just created is selected below the two QR codes:
.. figure:: /_static/images/services/lnbits/lndhub-select-wallet.png
:width: 40%
:alt: lndhub-select-wallet
#. Install `Zeus <https://zeusln.app/>`_.
#. Open it up and click **SCAN NODE CONFIG**.
.. figure:: /_static/images/services/lnbits/scan-node-config.jpg
:width: 25%
:alt: scan-node-config
#. *If you only want this wallet to be able to RECEIVE PAYMENTS, scan this QR code:*
.. figure:: /_static/images/services/lnbits/left-qr.png
:width: 40%
:alt: left-qr
*If you are happy for this wallet to be able to both receive and MAKE payments scan this QR code:*
.. figure:: /_static/images/services/lnbits/right-qr.png
:width: 40%
:alt: right-qr
#. Once scanned, name the wallet if you wish, then hit **SAVE NODE CONFIG**.
.. figure:: /_static/images/services/lnbits/save-node-config.jpg
:width: 25%
:alt: save-node-config
#. Zeus will now connect to your node and you'll see this screen:
.. figure:: /_static/images/services/lnbits/new-wallet-screen-zeus.png
:width: 25%
:alt: new-wallet-screen-zeus
.. tip:: If it doesn't work, please manually restart the Zeus app.
#. In addition to allocating sats to this wallet via the LNbits Superuser Account (see "Funding LNbits section" :ref:`here<connecting-lnbits>`), you can also receive funds the normal way by hitting **Request** within Zeus.
.. figure:: /_static/images/services/lnbits/zeus-request.png
:width: 20%
:alt: zeus-request
.. note:: This will only work if your node has inbound liquidity. And you cannot send sats from the LND node LNbits is using as that is not a regular lightning payment - that is a reblanace.
#. Once you have added sats, you can click on this button within Zeus and see your new balance:
.. figure:: /_static/images/services/lnbits/zeus-balance-button.png
:width: 20%
:alt: zeus-balance-button
.. figure:: /_static/images/services/lnbits/zeus-balance.png
:width: 20%
:alt: zeus-balance
Congratulations! Zeus is set up and ready to use lightning via your own lightning node - furthermore it will only be able to use your node in the way you allow it, via LNbits.

77
site/source/service-guides/lightning/zeus-lnc.rst Normal file
View File

@@ -0,0 +1,77 @@
.. _zeus-lnc:
====
Zeus
====
Lightning Node Connect (LNC) provides a very simple way to connect to an LND node. In this guide we'll cover how to connect to LND via LNC with Zeus.
Zeus is available for `Android <https://zeusln.app/zeus-v0.7.5-universal.apk>`_ & `iOS <https://apps.apple.com/us/app/zeus-ln/id1456038895>`_.
.. note:: If you'd like to connect to LND using LND REST instead, follow :ref:`this guide<zeus-lnd>`. If you'd like to connect to LND via LNbits which allows allocation of funds, follow :ref:`this guide<connecting-lnbits>`.
#. Install `Lightning Terminal <https://marketplace.start9.com/marketplace/lightning-terminal>`_
#. Click **LAUNCH UI**:
.. figure:: /_static/images/lightning/lit-launch-ui.png
:width: 40%
:alt: lit-launchUI
#. The password can be found in **Properties**:
.. figure:: /_static/images/lightning/lit-properties.png
:width: 40%
:alt: lit-properties
#. Copy it by clicking this square:
.. figure:: /_static/images/lightning/lit-properties-x.png
:width: 40%
:alt: copy-password
#. Paste it into Lightning Terminal and click **Submit**:
.. figure:: /_static/images/lightning/lit-paste-pass.png
:width: 40%
:alt: lit-paste-pass
#. Click on **Lightning Node Connect**:
.. figure:: /_static/images/lightning/lit-lnc1.png
:width: 40%
:alt: lit-lnc1
#. Click **Create a new session**:
.. figure:: /_static/images/lightning/lit-lnc2.png
:width: 40%
:alt: lit-lnc2
#. Name the wallet and click **Submit**:
.. figure:: /_static/images/lightning/lit-lnc3.png
:width: 40%
:alt: lit-lnc3
#. Click on the QR code:
.. figure:: /_static/images/lightning/lit-lnc4.png
:width: 40%
:alt: lit-lnc4
#. Install `Zeus <https://zeusln.app/>`_ if not already installed.
#. Open up Zeus and click **SCAN NODE CONFIG** then scan the QR code.
.. figure:: /_static/images/lightning/zeus-scan-node-config.jpg
:width: 25%
:alt: zeus-scan-node-config
#. Click **SAVE NODE CONFIG**:
.. figure:: /_static/images/lightning/zeus-save-node-config.jpg
:width: 25%
:alt: zeus-save-node-config
Zeus is now setup to connect to your LND node via LNC!

44
site/source/service-guides/lightning/zeus-lnd-direct.rst Normal file
View File

@@ -0,0 +1,44 @@
.. _zeus-lnd:
Zeus
----
Zeus is a powerful mobile wallet that can be connected directly to both LND and Core Lightning (CLN). If you'd like to connect via LNbits which allows allocation of funds, please see :ref:`this guide<connecting-lnbits>`.
Zeus is available for `Android <https://zeusln.app/zeus-v0.7.5-universal.apk>`_ & `iOS <https://apps.apple.com/us/app/zeus-ln/id1456038895>`_.
This guide will go over how to connect Zeus to **LND**. If you'd like to connect Zeus to CLN instead - please use :ref:`this guide<zeus-cln>`.
#. Download the Zeus from your mobile device's application store.
#. In your Start9 server's **services** tab, select **LND**.
.. figure:: /_static/images/lightning/lnd-within-services.png
:width: 40%
:alt: lnd-services
#. Click **Properties**:
.. figure:: /_static/images/lightning/lnd-properties.png
:width: 40%
:alt: lnd-properties
#. Click the QR code icon highlighted below to display the **LND Connect REST URL** QR code:
.. figure:: /_static/images/lightning/lnd-connect-qr-code.png
:width: 40%
:alt: lnd-connect-qrcode
#. Open Zeus on your mobile device and click **SCAN NODE CONFIG**:
.. figure:: /_static/images/services/lnbits/scan-node-config.jpg
:width: 25%
:alt: scan-node-config
#. Scan the QR Code displayed on the server's LND Connect REST URL screen.
#. Zeus will fill in your node details based on the information in the QR code.
#. Click **SAVE NODE CONFIG**
Zeus is now setup to access and control your LND node!

34
site/source/service-guides/matrix.rst Normal file
View File

@@ -0,0 +1,34 @@
.. _matrix:
======
Matrix
======
Synapse
-------
With registrations disabled, the only way to create an account on your Server is through the Admin Portal. The Admin Portal is the preferred method for creating an account.
#. In your Start9 UI, under `Services > Synapse`, click "Launch UI"
#. Log in with your Admin Username and Password (located in Properties). For "Homeserver URL", do `not` enter your Homeserver address. Instead, enter your Admin Portal URL.
.. note:: This is the URL currently showing in your browser URL bar, excluding the path. e.g. https://exampleaddress.local or http://exampleaddress.onion.
.. figure:: /_static/images/services/matrix/synapse-admin-1.png
:width: 60%
:alt: Synapse Admin
#. In the "Users" tab, you will notice the admin user already created.
#. In the "Users" tab, click "+ Create"
.. figure:: /_static/images/services/matrix/synapse-admin-2.png
:width: 60%
:alt: Synapse Admin
#. Choose a User-ID, Displayname, and Password for your account. Optionally enter an email address under the 3PIDs section. It is not recommended to make this user a Server Administrator, as it is best to limit admin access.
.. figure:: /_static/images/services/matrix/synapse-admin-3.png
:width: 60%
:alt: Synapse Admin

13
site/source/service-guides/nextcloud/index.rst Normal file
View File

@@ -0,0 +1,13 @@
.. _nextcloud-service:
=========
Nextcloud
=========
These guides will help you to setup tools to connect or interact with Nextcloud.
.. toctree::
:maxdepth: 1
nextcloud-setup/index
nextcloud-apps/index

34
site/source/service-guides/nextcloud/nextcloud-apps/index.rst Normal file
View File

@@ -0,0 +1,34 @@
.. _nextcloud-apps:
=============================
Nextcloud Apps & Integrations
=============================
Nextcloud is highly extensible and even has its own `App Store <https://apps.nextcloud.com/>`_. The following guides will help you with the setup, connection, and use of Start9-curated Nextcloud Apps as well as third-party integrations for your server.
Apps
----
.. toctree::
:maxdepth: 1
nc-bookmarks
nc-calendar
nc-contacts
nc-cookbook
nc-files
nc-maps
nc-memories
nc-music
nc-news
nc-notes
nc-photos
Integrations
------------
.. toctree::
:maxdepth: 1
joplin
thunderbird

105
site/source/service-guides/nextcloud/nextcloud-apps/joplin.rst Normal file
View File

@@ -0,0 +1,105 @@
.. _nc-joplin:
==================
Joplin Integration
==================
`Joplin <https://joplinapp.org/>`_ is an open source note-taking app. Capture your thoughts and securely access them from any device. First set up your :ref:`client devices<nextcloud-setup>`, so that Nextcloud will automatically keep your notes synced.
Clients available for:
- Desktop
- Linux
- Mac
- Windows
- Mobile
- Android
- iOS
Connecting Joplin to Nextcloud (Mac Desktop Example)
----------------------------------------------------
This guide will go over how to connect Joplin running on a desktop machine to your Start9 server's Nextcloud over LAN.
.. note:: This guide assumes your Nextcloud username is "embassy," replace with your username if different.
You will need your device set up to connect via :ref:`LAN<connecting-lan>` first.
#. First go into Nextcloud on your server and click on the "Files" app icon.
.. figure:: /_static/images/nextcloud/joplin/joplin-setup0.png
:width: 30%
:alt: Click on Folders
#. Click on the + icon, then "New folder".
.. figure:: /_static/images/nextcloud/joplin/joplin-setup1.png
:width: 30%
:alt: New Folder
#. Create a new folder called "joplin" and click the arrow to the right.
.. figure:: /_static/images/nextcloud/joplin/joplin-setup3.png
:width: 30%
:alt: Joplin Directory
#. Click on "Files settings" in the bottom left and copy the WebDAV link.
.. figure:: /_static/images/nextcloud/joplin/joplin-setup4.png
:width: 30%
:alt: Files Settings
.. figure:: /_static/images/nextcloud/joplin/joplin-setup5.png
:width: 30%
:alt: WedDAV Link
#. Open up Joplin, click on "Joplin" in the top left and click "Preferences" (on Mac).
.. figure:: /_static/images/nextcloud/joplin/joplin-setup7.png
:width: 30%
:alt: Preferences
#. Click on "Synchronisation".
.. figure:: /_static/images/nextcloud/joplin/joplin-setup8.png
:width: 30%
:alt: Click on Synchronisation
#. Under "Synchronisation target" select "Nextcloud", paste the WebDAV and append onto the end of it "joplin" so the entire URL should look like this (replace ``xxxx`` with your unique Nextcloud LAN address): ``https://xxxx.local/remote.php/dav/files/embassy/joplin``.
.. figure:: /_static/images/nextcloud/joplin/joplin-setup9.png
:width: 30%
:alt: Click on Synchronization
#. Under "Nextcloud username" enter "embassy" (or your username).
#. Under "Nextcloud password" enter your password.
#. The username and password for your Nextcloud can be found in your server's UI by clicking on the Nextcloud service then clicking on "Properties".
.. figure:: /_static/images/nextcloud/joplin/joplin-setup10.png
:width: 30%
:alt: Select Nextcloud and enter URL
.. figure:: /_static/images/nextcloud/joplin/joplin-setup11.png
:width: 30%
:alt: Select Nextcloud and enter URL
#. Now click "Show advanced settings".
.. figure:: /_static/images/nextcloud/joplin/joplin-setup12.png
:width: 30%
:alt: Select Nextcloud and enter URL
#. Scroll down then check the box that says "Ignore TLS certificate errors".
.. figure:: /_static/images/nextcloud/joplin/joplin-setup13.png
:width: 30%
:alt: Select Nextcloud and enter URL
#. Now scroll back up and select "Check sychronisation configuration" and you should see the following success message:
.. figure:: /_static/images/nextcloud/joplin/joplin-setup14.png
:width: 30%
:alt: Select Nextcloud and enter URL
#. You have now connected your Joplin client to your Start9 server's Nextcloud and your notes will sync automatically!

46
site/source/service-guides/nextcloud/nextcloud-apps/nc-bookmarks.rst Normal file
View File

@@ -0,0 +1,46 @@
.. _nc-bookmarks:
===================
Nextcloud Bookmarks
===================
`Nextcloud Bookmarks <https://apps.nextcloud.com/apps/bookmarks>`_ is software for sorting, tagging, searching, sharing, and (most importantly) syncing your browser's bookmarks via your server. First set up your :ref:`client devices<nextcloud-setup>`, so that Nextcloud will automatically keep your bookmarks synced.
Clients available for:
- Mobile
- Android
- Desktop Browsers
- Chrome
- Edge
- Firefox
NC App Setup
------------
#. Begin by downloading Bookmarks from your Nextcloud service's App Store (Top-right menu -> Apps).
.. tip:: Use the "Search" function to quickly find the App you are looking for
#. Once installed/enabled, you will get a new icon in your top menu for "Bookmarks." Click it to get started.
- At this point you can begin adding bookmarks directly into the app, or import them from a browser. These are always available by accessing your Nextcloud from your client devices.
- The real power here is in the ability to import or sync across devices. There are several clients that can accomplish this, which can be found on the `NC Bookmarks Github Page <https://github.com/nextcloud/bookmarks#third-party-clients>`_. For our example, and the recommended option if you click "Sync with your browser" from the Bookmarks welcome page, is `Floccus <https://floccus.org/>`_.
#. (Optional) In the "Settings" menu in the bottom-left, you may change the Nextcloud location in which to store your bookmarks. If you change this or create a new folder, be sure to reflect this change in Floccus below.
Browser & Mobile Setups
-----------------------
Floccus (Browser & Android)
...........................
#. Download the appropriate Floccus extension for your browser or app from the App Store, F-Droid, or Play Store.
#. Open the Floccus browser extension and click "+NEW ACCOUNT", select "Nextcloud Bookmarks", and then add your server address and login via Nextcloud.
#. (Optional) Edit the folder paths if changed above and select a local folder to save bookmarks to.
#. On the final setup page, use the defaults unless you are absolutely sure what you are doing. Click "Continue" and you're ready to sync!
.. note:: Repeat this process for any additional devices or browsers that you'd like to keep in sync.

31
site/source/service-guides/nextcloud/nextcloud-apps/nc-calendar.rst Normal file
View File

@@ -0,0 +1,31 @@
.. _nc-calendar:
==================
Nextcloud Calendar
==================
`Nextcloud Calendar <https://apps.nextcloud.com/apps/calendar>`_ is software for managing and syncing calendars, events, and tasks between your devices. First set up your :ref:`client devices<nextcloud-setup>`, so that Nextcloud will automatically keep your calendars synced.
Integrations available for:
- Mobile
- Android
- iOS
- Desktop
- Linux
- Mac
- Windows
NC App Setup
------------
#. On the latest Start9 Nextcloud service, Calendar is included by default. If coming from an older install, begin by downloading Calendar from your Nextcloud service's App Store (Top-right menu -> Apps).
.. tip:: Use the "Search" function to quickly find the App you are looking for
#. Once installed/enabled, you will get a new icon in your top menu for "Calendar." Click it to get started.
- At this point you can begin using the Calendar right away in the web UI. All changes will be reflected in any currently synced client devices, or on any added in future.
Client Integrations
-------------------
Client integrations can all be found in the :ref:`initial setup guides<nextcloud-setup>` for your device.

31
site/source/service-guides/nextcloud/nextcloud-apps/nc-contacts.rst Normal file
View File

@@ -0,0 +1,31 @@
.. _nc-contacts:
==================
Nextcloud Contacts
==================
`Nextcloud Contacts <https://apps.nextcloud.com/apps/contacts>`_ is software for managing and syncing your contacts between your devices. First set up your :ref:`client devices<nextcloud-setup>`, so that Nextcloud will automatically keep your contacts synced.
Integrations available for:
- Mobile
- Android
- iOS
- Desktop
- Linux
- Mac
- Windows
NC App Setup
------------
#. On the latest Start9 Nextcloud service, Contacts is included by default. If coming from an older install, begin by downloading Contacts from your Nextcloud service's App Store (Top-right menu -> Apps).
.. tip:: Use the "Search" function to quickly find the App you are looking for
#. Once installed/enabled, you will get a new icon in your top menu for "Contacts." There is also a quick access icon in the top-right. Click either to get started.
- At this point you can begin using your Contacts app right away in the WebUI. All changes will be reflected in any currently synced client devices, or on any added in future.
Client Integrations
-------------------
Client integrations can all be found in the :ref:`initial setup guides<nextcloud-setup>` for your device.

45
site/source/service-guides/nextcloud/nextcloud-apps/nc-cookbook.rst Normal file
View File

@@ -0,0 +1,45 @@
.. _nc-cookbook:
==================
Nextcloud Cookbook
==================
`Nextcloud Cookbook <https://apps.nextcloud.com/apps/cookbook>`_ is software for viewing, syncing, and organizing recipes. First set up your :ref:`client devices<nextcloud-setup>`, so that Nextcloud will automatically keep your recipes synced.
Clients available for:
- Mobile
- Android
- iOS
NC App Setup
------------
#. Begin by downloading Cookbook from your Nextcloud service's App Store (Top-right menu -> Apps).
.. tip:: Use the "Search" function to quickly find the App you are looking for
#. Once installed/enabled, you will get a new icon in your top menu for "Cookbook." Click it to get started.
#. You can now start adding recipes. Simply find a recipe online and copy the URL into the box on the left. In most cases, this will be translated into an easy-to-read recipe with ingredients and steps, and without all the distractions and junk included with most recipe pages.
.. tip:: Tag and categorize your recipes! Basic settings are available in the bottom-left menu.
Mobile Setups
-------------
Nextcloud Cookbook (Android / iOS)
..................................
There are 2 versions of this app available on Android, and one on iOS. Check this `repository <https://github.com/nextcloud/cookbook/>`_ for details.
#. Go to your app store of choice and install the Nextcloud Cookbook app.
#. (Android connection) You can select a previously connected Nextcloud account, or scan an app-specific QR, created under Nextcloud's main menu -> Personal Settings -> Security
#. (iOS connection) You will be prompted to enter the following:
- Server URL - get this from your server's Services -> Nextcloud -> Interfaces (LAN is recommended)
- Username - get this from your server's Services -> Nextcloud -> Properties (admin is default)
- Password - get this from your server's Services -> Nextcloud -> Properties
.. note:: You may need to enable "self-signed certificates" for LAN. This is safe to do as you are the signer of the cert and owner of all involved hardware.
#. As soon as you connect and sync, you will see your Cookbook!

29
site/source/service-guides/nextcloud/nextcloud-apps/nc-files.rst Normal file
View File

@@ -0,0 +1,29 @@
.. _nc-files:
===============
Nextcloud Files
===============
Nextcloud Files is software for managing and syncing your data between your devices. In practice it functions similarly to the file explorer on your computer. Files also serves as the base storage on your server for all the other apps that may need to access your data, such as documents, multimedia, and syncing apps. This even includes data storage for other Start9 services on your server, such as Jellyfin and Start9 Pages.
Integrations available for:
- Mobile
- Android
- iOS
- Desktop
- Linux
- Mac
- Windows
NC App Setup
------------
#. You will find an icon in your top menu for "Files." Click here to get started.
- You can begin using your Files app right away in the web UI. All changes will be reflected in any currently synced client devices, or on any added in future.
.. warning:: Keep in mind that if you delete a file in one location, it may be deleted across all locations!! Start with some test folders/files in order to understand how the syncing system works with your devices.
Client Integrations
-------------------
Client integrations can all be found in the :ref:`initial setup guides<nextcloud-setup>` for your device.

22
site/source/service-guides/nextcloud/nextcloud-apps/nc-maps.rst Normal file
View File

@@ -0,0 +1,22 @@
.. _nc-maps:
==============
Nextcloud Maps
==============
`Nextcloud Maps <https://apps.nextcloud.com/apps/maps>`_ is software for viewing and managing your places. First set up your :ref:`client devices<nextcloud-setup>`, so that Nextcloud will automatically keep your maps synced.
No clients available at this time.
NC App Setup
------------
#. Begin by downloading Maps from your Nextcloud service's App Store (Top-right menu -> Apps).
.. tip:: Use the "Search" function to quickly find the App you are looking for
#. Once installed/enabled, you will get a new icon in your top menu for "Maps." Click it to get started.
#. You can now browse `OpenStreetMap <https://www.openstreetmap.org/>`_, get directions, create favorite locations, add photos, and share custom maps.
.. tip:: You can find the settings for Maps in the bottom-left
.. note:: This is basic software at this time, havnig just reached 1.0, but features are planned by the developers for linking mobile devices for finding a lost or stolen device as well as fitness tracking and other modern location services.

27
site/source/service-guides/nextcloud/nextcloud-apps/nc-memories.rst Normal file
View File

@@ -0,0 +1,27 @@
.. _nc-memories:
==================
Nextcloud Memories
==================
`Nextcloud Memories <https://apps.nextcloud.com/apps/memories>`_ is software for viewing, managing, and organizing your photos. First set up your :ref:`client devices<nextcloud-setup>`, so that Nextcloud will automatically keep your photos synced.
Clients available for:
- Mobile
- Android
NC App Setup
------------
#. Begin by downloading Memories from your Nextcloud service's App Store (Top-right menu -> Apps).
.. tip:: Use the "Search" function to quickly find the App you are looking for
#. Once installed/enabled, you will get a new icon in your top menu for "Memories." Click it to get started.
#. You will see an image that says "Click Here To Start" - click it and select your media directory.
.. tip:: You can find the settings for Memories under the top-right menu -> Administrative Settings -> Memories
Desktop & Mobile Setups
-----------------------
This is currently a webUI only application, but you can use the same clients as those supported by :ref:`Nextcloud Photos<nc-photos>`.

34
site/source/service-guides/nextcloud/nextcloud-apps/nc-music.rst Normal file
View File

@@ -0,0 +1,34 @@
.. _nc-music:
===============
Nextcloud Music
===============
`Nextcloud Music <https://apps.nextcloud.com/apps/music>`_ is software for organizing and playing your music as well as managing and streaming podcasts and internet radio. First set up your :ref:`client devices<nextcloud-setup>`, so that Nextcloud will automatically keep your music synced.
Clients available for:
- Mobile
- Android
- iOS
- Garmin Watch
- Desktop:
- Linux
- Mac
- Windows
NC App Setup
------------
#. Begin by downloading Music from your Nextcloud service's App Store (Top-right menu -> Apps).
.. tip:: Use the "Search" function to quickly find the App you are looking for
#. Once installed/enabled, you will get a new icon in your top menu for "Music." Click it to get started.
#. You can now play existing music from your Nextcloud Files, or add an internet radio station or podcast feed!
.. tip:: You can set the media directory path in the 'Settings' menu on the bottom-left
Desktop & Mobile Setups
-----------------------
Nextcloud Music can be used by clients that support Ampache or Subsonic. See all the options in the 'Settings' menu on the bottom-left, or see the `Ampache client list <https://github.com/owncloud/music/wiki/Ampache>`_ or the `Subsonic client list <https://github.com/owncloud/music/wiki/Subsonic>`_.

33
site/source/service-guides/nextcloud/nextcloud-apps/nc-news.rst Normal file
View File

@@ -0,0 +1,33 @@
.. _nc-news:
==============
Nextcloud News
==============
`Nextcloud News <https://apps.nextcloud.com/apps/news>`_ is software for managing and viewing RSS feeds. First set up your :ref:`client devices<nextcloud-setup>`, so that Nextcloud will automatically keep your feeds synced.
Clients available for:
- Mobile
- Android
- iOS
- SailfishOS
- Desktop:
- Linux
- Mac
- Windows
- Unix Terminal
NC App Setup
------------
#. Begin by downloading News from your Nextcloud service's App Store (Top-right menu -> Apps).
.. tip:: Use the "Search" function to quickly find the App you are looking for
#. Once installed/enabled, you will get a new icon in your top menu for "News." Click it to get started.
- You can now add your favorite RSS feeds from the left-hand panel.
Desktop & Mobile Setups
-----------------------
Nextcloud News can be synced with a wide range of clients across almost any platform you can imagine. See all the options on the `official client list <https://nextcloud.github.io/news/clients/>`_.

49
site/source/service-guides/nextcloud/nextcloud-apps/nc-notes.rst Normal file
View File

@@ -0,0 +1,49 @@
.. _nc-notes:
===============
Nextcloud Notes
===============
`Nextcloud Notes <https://apps.nextcloud.com/apps/notes>`_ is software for managing and syncing your notes across devices. First set up your :ref:`client devices<nextcloud-setup>`, so that Nextcloud will automatically keep your notes synced.
Clients available for:
- Mobile
- Android
- iOS
- Desktop:
- Unix Terminal
NC App Setup
------------
#. Begin by downloading Notes from your Nextcloud service's App Store (Top-right menu -> Apps).
.. tip:: Use the "Search" function to quickly find the App you are looking for
#. Once installed/enabled, you will get a new icon in your top menu for "Notes." Click it to get started.
- You can now use the web UI to record your notes.
.. tip:: Markdown is supported
Desktop & Mobile Setups
-----------------------
The real beauty of Notes is being able to sync to your mobile devices for use on the go.
Nextcloud Notes (Android)
.........................
#. Download the Nextcloud Notes app from your favorite app store (Aurora, F-Droid, or Play Store).
#. On the opening screen, select your existing Nextcloud account. If one does not exist, make sure to start with your :ref:`client setup<nextcloud-setup>` or you can hit "Add Account," then create an app passcode QR under Nextcloud's main top-right menu -> Personal Settings -> Hamburger (3 lines) Menu > Security > Devices & Sessions > "Create new app password" and scan it to grant access.
#. You existing notes will now sync, or you can create your first note to test!
Nextcloud Notes (iOS)
.....................
#. Download the Nextcloud Notes app from the App Store.
#. Enter your Nextcloud server URL from your server: Nextcloud -> Interfaces (LAN recommended).
#. You will be redirected and asked for your username and password, both can be found on your server: Nextcloud -> Properties. Then Grant Access.
#. You'll be returned to the setup screen, just tap "Done," your existing notes will now sync, or you can create your first note to test!

30
site/source/service-guides/nextcloud/nextcloud-apps/nc-photos.rst Normal file
View File

@@ -0,0 +1,30 @@
.. _nc-photos:
================
Nextcloud Photos
================
Nextcloud Photos is a basic gallery for viewing and managing your photos. First set up your :ref:`client devices<nextcloud-setup>`, so that Nextcloud will automatically keep your photos synced.
Clients available for:
- Mobile
- Android
NC App Setup
------------
#. Photos is included by default and there will be an icon in your top menu for "Photos." Click it and you will be in the web UI viewing your gallery.
Desktop & Mobile Setups
-----------------------
Les Pas (Android)
.................
`Les Pas <https://github.com/scubajeff/lespas>`_ is a great mobile gallery for viewing and organizing your photos, gifs, and videos.
#. First, install Les Pas from your favorite app store (Aurora, F-Droid, or Play Store), or from `the github repository <https://github.com/scubajeff/lespas/releases>`_.
#. At the welcome screen, you will be asked to either enter your server URL or scan a QR code. In your Nextcloud instance, click the top-right menu -> Personal Settings -> Hamburger (3 lines) Menu > Security > Devices & Sessions > "Create new app password." Hit "Show QR Code" and then scan it with Les Pas.
#. You'll be sent to your Nextcloud instance to log in and grant access to the app.
- That's it! You're ready to view your photos with no third party involved!

84
site/source/service-guides/nextcloud/nextcloud-apps/thunderbird.rst Normal file
View File

@@ -0,0 +1,84 @@
.. _nc-thunderbird:
===========
Thunderbird
===========
.. contents::
:depth: 2
:local:
Calendar & Contacts Syncing
===========================
You can set up your devices using their :ref:`integrations<nextcloud-setup>`, but if you wish to use a standalone client for your Calendar and Contacts syncing, we recommend Mozilla's `Thunderbird <https://www.thunderbird.net>`_.
1. Install the :ref:`Calendar<nc-calendar>` and :ref:`Contacts<nc-contacts>` apps in Nextcloud if they are not currently installed.
2. Add your :ref:`RootCA<trust-ca>` to your system and then configure :ref:`Thunderbird<thunderbird>`.
3. Select Calendar or Contacts from below to complete each unique setup:
.. tabs::
.. group-tab:: Calendar
1. In Thunderbird, click on the calendar icon, then "New Address Book" in the bottom-left.
.. figure:: /_static/images/nextcloud/thunderbird-calendar-step1.png
:width: 60%
:alt: thunderbird add calendar
2. Choose "On the network," then click "Next".
.. figure:: /_static/images/nextcloud/thunderbird-calendar-step2.png
:width: 40%
:alt: thunderbird add calendar checkbox
3. Fill in the Username and Location fields with the credentials from Nextcloud > Properties on your Start9 server. Click "Find calendars".
.. figure:: /_static/images/nextcloud/thunderbird-calendar-step3.png
:width: 40%
:alt: thunderbird add calendar checkbox
4. Create a unique app password - In your Nextcloud WebUI, visit the top-right-hand menu and select "Personal Settings" -> "Security." At the bottom, under "Devices & Sessions," create a new app password with a name of your choice, such as "CalDAV." Copy the resulting password and paste it into Thunderbird.
.. figure:: /_static/images/nextcloud/native-nextcloud-integration-macos-step3.1.png
:width: 60%
:alt: nextcloud app password
.. figure:: /_static/images/nextcloud/thunderbird-contact-step3.png
:width: 40%
:alt: thunderbird add password
5. Check which calendars you want to integrate and click "Subscribe".
.. figure:: /_static/images/nextcloud/thunderbird-calendar-step5.png
:width: 40%
:alt: thunderbird add calendar subscribe
Your Nextcloud calendar will now sync with Thunderbird. Click on the "Contacts" tab above to add your contacts.
.. group-tab:: Contacts
1. Click on the Address Book icon, open the drop-down menu for "New Address Book" and click "Add CarDav Address Book".
.. figure:: /_static/images/nextcloud/thunderbird-contact-step1.png
:width: 60%
:alt: thunderbird add new contact book
2. Fill in the Username and Location fields with the credentials from Nextcloud > Properties on your Start9 server. Click "Continue".
.. figure:: /_static/images/nextcloud/thunderbird-contact-step2.png
:width: 60%
:alt: thunderbird add new contact book
3. Create a unique app password - In your Nextcloud WebUI, visit the top-right-hand menu and select "Personal Settings" -> "Security." At the bottom, under "Devices & Sessions," create a new app password with a name of your choice, such as "CalDAV." Copy the resulting password and paste it into Thunderbird.
.. figure:: /_static/images/nextcloud/native-nextcloud-integration-macos-step3.1.png
:width: 60%
:alt: nextcloud app password
.. figure:: /_static/images/nextcloud/thunderbird-contact-step3.png
:width: 40%
:alt: thunderbird add password
Your Nextcloud contacts will now sync with Thunderbird.

16
site/source/service-guides/nextcloud/nextcloud-setup/index.rst Normal file
View File

@@ -0,0 +1,16 @@
.. _nextcloud-setup:
======================
Nextcloud Device Setup
======================
Connection guides by Device. This will guide you through initial setup and syncing configurations.
.. toctree::
:maxdepth: 1
nextcloud-linux
nextcloud-mac
nextcloud-windows
nextcloud-android
nextcloud-ios

143
site/source/service-guides/nextcloud/nextcloud-setup/nextcloud-android.rst Normal file
View File

@@ -0,0 +1,143 @@
.. _nextcloud-android:
===================
Nextcloud - Android
===================
.. contents::
:depth: 2
:local:
Initial Config
--------------
It is advised to setup your Nextcloud devices on LAN (if available) for the best experience. Once set up, Tor can be used for remote syncing, but remember that large files will likely fail or take a very long time, so it is best to use remote sync only for low-bandwidth activity, such as Calendar, Contacts, Tasks, and Notes. Streaming your music is also possible. Later in 2023, new connection options will unlock Nextcloud's full feature-set.
Nextcloud App
-------------
The latest version of the official Nextcloud client is available on their `download page <https://nextcloud.com/install/#install-clients>`_. This is for file syncing and account management.
LAN Setup
=========
Make sure you have first set up :ref:`LAN access<ca-android>`.
1. Open Nextcloud via your server's Services -> Nextcloud -> Launch UI
2. Log in and select the top right icon -> Personal Settings:
.. figure:: /_static/images/services/nextcloud/web-step1-personal_settings.png
:width: 30%
:alt: Nextcloud: > Personal Settings
3. Select the hamburger (3 lines) menu:
.. figure:: /_static/images/services/nextcloud/web-step2-ps-profile.png
:width: 30%
:alt: Nextcloud: Personal Settings > Hamburger menu
4. Select Security:
.. figure:: /_static/images/services/nextcloud/web-step3-security.png
:width: 30%
:alt: Nextcloud: Personal Settings > Security
5. Under `Devices & sessions`, give this Nextcloud mobile app a session name, such as "Mobile" and tap `Create new app password`:
.. figure:: /_static/images/services/nextcloud/web-step4-new_session.png
:width: 30%
:alt: Nextcloud: Devices & sessions > Create new app password
6. Tap `Show QR code for mobile apps`:
.. figure:: /_static/images/services/nextcloud/web-step5-show_qr_code.png
:width: 30%
:alt: Nextcloud Show new session's QR code
7. The new session's QR code will be displayed:
.. figure:: /_static/images/services/nextcloud/web-step6-qr_code_shown.png
:width: 30%
:alt: Nextcloud: New session's QR code is shown
8. Download and install the appropriate desktop client for your Android device from https://nextcloud.com/install/#install-clients
9. Open the Nextcloud client on your Android device and tap "Log in"
.. figure:: /_static/images/services/nextcloud/step1-login.png
:width: 30%
:alt: Nextcloud mobile app Log in
10. Tap the QR code icon:
.. figure:: /_static/images/services/nextcloud/step2-read_qrcode.png
:width: 30%
:alt: Nextcloud mobile app QR Code button
11. Scan the QR code presented in Step 7.
.. note::
Here you may see an error about the Nextcloud app being unable to find the host that was decoded from the QR code:
.. figure:: /_static/images/services/nextcloud/pitfall1-could_not_connect_to_host-wifi-mdns-orbot.png
:width: 30%
:alt: Nextcloud mobile app error: Could not find host
If you see this message, you may be on an Android version that does not support mDNS .local name resolution (it is available on Android 13+ and some builds of Android 12, but not all. The other possibility is that your WiFi network is not properly "bridged" with the ethernet network that your Start9 server is on, or you lack WiFi connectivity to your network in general.
Alternatively, you may see a warning about an untrusted certificate:
.. figure:: /_static/images/services/nextcloud/pitfall2-untrusted_cert.png
:width: 30%
:alt: Nextcloud mobile app QR Code button
In this case, make sure you have :ref:`added your server's CA certificate to the Android trust store<ca-android>` as noted at the top of the `LAN Setup` section of this guide, close the Nextcloud mobile app and try again. Otherwise, proceed to the next step.
12. Android may ask you about Storage permissions. Grant "Full access":
.. figure:: /_static/images/services/nextcloud/step3-grant_file_access.png
:width: 30%
:alt: Nextcloud Storage permissions
13. Next, configure the local directory that you want to sync with Nextcloud. You may use the default or change it, and edit the sync settings to desired. When satisfied, tap "Connect"
14. Files will begin to sync immediately and you will see a green check when this is complete.
15. That's it! From this desktop client you will recieve notifications, control accounts and syncing, and quickly access your Apps' WebUI pages
Tor Setup
=========
You will first need to have :ref:`Orbot running<tor-android>`.
1. First, add Nextcloud to your Orbot apps list.
2. Tap the account in the top-right, then "Add Account."
3. On the following screen, tap "Log in," then enter your Nextcloud Tor server address, which you can copy from Nextcloud -> Interfaces - Tor. This must start with ``http://`` and end with ``.onion``. tap Next.
4. This will launch your browser and prompt you to log in to your account. Log in and then grant access as we did for LAN.
5. That's it! You may wish to set up some select folders for remote sync, but for large files, it is best to sync on LAN only, so you can "Skip folders configuration" on the resulting screen if you wish. Check your connection by tapping into the newly created account in the app.
Device Integration
------------------
In order to sync calendars and contacts with your Android device, follow the steps below, which are adapted from the `Official Nextcloud guide <https://docs.nextcloud.com/server/25/user_manual/en/groupware/sync_android.html>`_. First head into the top-righthand menu of your Nextcloud's WebUI and click "Apps," then search for and install the Calendar and/or Contacts Apps.
1. Download the WebDAV sync management client `DAVx5 <https://www.davx5.com/download/>`_ from your app store of choice, such as F-Droid or the Play Store.
2. Add account:
- If you are on Android 12+ and already have the Nextcloud file-syncing app (recommended - guide above), then open it and enter the "Settings" menu from the top-lefthand hamburger (3 lines) menu. Then under the section titled, "More," tap "Sync Calendar & Contacts."
- This will open Nextcloud's WebFlow login in a browser, where you will need to log in and "Grant Access" - you will then be returned to DAVx5
- Set an account name when asked, then set "Contact Group Method" to "Groups are per-contact categories" - DAVx5 will close and Nextcloud will reappear.
- Manually launch DAVx5 again and top on the account that was just created. Grant access to Calendars and Contacts when requested, and optionally tasks, if you added that feature in setup. Choose the address books and calendars you wish to sync and you're done!
- If you are NOT using the Nextcloud app already, then open DAVx5 and after going through the introduction (optionally selecting additional features), tap the "+" icon to add a new account, then select "Login with URL and user name," and fill in the following fields:
- Base URL - Enter your Nextcloud WebDAV Base LAN URL (found in "Properties" in the Nextcloud service page).
- User name - Your Nextcloud user (defaults are found in "Properties" on your Nextcloud service page)
- Password - Your Nextcloud user's password (defaults are found in "Properties" on your Nextcloud service page)
- If given the option, select "Groups are per-contact categories," then tap "Login." Select the data you want to sync, grant access for contacts, calendars, and optionally tasks if you added that feature in setup. That's it, you're done!
.. tip:: You may also wish to add the `ICSx5 <https://icsx5.bitfire.at/>`_ app, which allows subscription to remote WebCal or local iCal files (such as public event schedules, iCloud/Google calendars, etc). It can be found in your favorite app store.

118
site/source/service-guides/nextcloud/nextcloud-setup/nextcloud-ios.rst Normal file
View File

@@ -0,0 +1,118 @@
.. _nextcloud-ios:
===============
Nextcloud - iOS
===============
.. contents::
:depth: 2
:local:
Initial Config
--------------
It is advised to setup your Nextcloud devices on LAN (if available) for the best experience. Once set up, Tor can be used for remote syncing, but remember that large files will likely fail or take a very long time, so it is best to use remote sync only for low-bandwidth activity, such as Calendar, Contacts, Tasks, and Notes. Streaming your music is also possible. Later in 2023, new connection options will unlock Nextcloud's full feature-set.
Standalone Client
-----------------
The latest version of the official Nextcloud client is available on their `download page <https://nextcloud.com/install/#install-clients>`_.
LAN Setup
=========
Make sure you have first set up :ref:`LAN access<ca-ios>`.
1. Download the iOS Nextcloud client from `App Store <https://apps.apple.com/us/app/nextcloud/id1125420102>`_.
2. Open the client and tap "Log In".
.. figure:: /_static/images/nextcloud/nextcloud-iOS-step2.png
:width: 30%
:alt: nextcloud-ios-login
3. From your server's Nextcloud Service page, go to "Interfaces" and copy the LAN address.
.. figure:: /_static/images/nextcloud/nextcloud-mac-step3-lan.png
:width: 60%
:alt: nextcloud-ios-login
4. Enter your LAN address under "Server Address" and tap "Next".
.. figure:: /_static/images/nextcloud/nextcloud-iOS-step4.png
:width: 30%
:alt: nextcloud-ios-login
5. You will be shown the "Connect to your account" screen, and then click "Log In" and "Grant Access".
.. figure:: /_static/images/nextcloud/nextcloud-iOS-step5.png
:width: 30%
:alt: nextcloud-ios-login
.. figure:: /_static/images/nextcloud/nextcloud-mac-step3-lan.png
:width: 60%
:alt: nextcloud-ios-login
6. Next, you will be asked to enter the username and password, which can be found on the startOS Nextcloud Service page under the "Properties" tab.
.. figure:: /_static/images/nextcloud/nextcloud-iOS-step5.png
:width: 30%
:alt: nextcloud-ios-login
7. The account access page will be displayed, tap "Grant access".
.. figure:: /_static/images/nextcloud/nextcloud-iOS-step6.png
:width: 30%
:alt: nextcloud-ios-login
8. Files will begin syncing immediately, and you will see your username and account icon in the top left corner.
.. figure:: /_static/images/nextcloud/nextcloud-iOS-step7.png
:width: 30%
:alt: nextcloud-ios-login
9. That's it! From this mobile client you can receive notifications, control accounts and syncing, and quickly access your apps' WebUI pages.
Tor Setup
=========
You will first need to have the :ref:`Tor daemon running<tor-ios>`.
1. Click the account in the top left again, then "Add Account."
2. On the following screen, click "Log in," then enter your Nextcloud Tor server address, which you can copy from Nextcloud -> Interfaces - Tor. This must start with `http://` and end with .onion. Click Next.
3. This will launch your browser and prompt you to log in to your account. Log in and then grant access as we did for LAN.
4. That's it! You may wish to set up some select folders for remote sync, but for large files, it is best to sync on LAN only, so you can "Skip folders configuration" on the resulting screen if you wish. Check your connection by clicking the newly created account in the client app.
Device Integration
------------------
In order to sync calendars and contacts with your iOS device, follow the steps below, which are adapted from the `Official Nextcloud guide <https://docs.nextcloud.com/server/25/user_manual/en/groupware/sync_ios.html>`_.
First head into the top-righthand menu of your Nextcloud's WebUI and click "Apps," then search for and install the Calendar and/or Contacts Apps. Next folow guide for iOS.
.. figure:: /_static/images/nextcloud/nextcloud-iOS-native.png
:width: 60%
:alt: nextcloud account settings
1. Open the "Settings" app on iOS device.
.. note:: You will need to perform 2 individual setups, one for Calendar and one for Contacts.
2. Select "Calendar" (or "Contacts") -> "Accounts" -> "Add Account" -> "Other" -> "either CalDAV (for Calendar setup) or CardDAV (for Contacts setup)". Return to this step after completing one in order to add the other.
.. figure:: /_static/images/nextcloud/nextcloud-iOS-native-step1.png
:width: 60%
:alt: nextcloud account settings
3. Enter the following fields and tap "Next":
- Server - Enter your Nextcloud WebDAV Base LAN URL (found in "Properties" in the Nextcloud service page).
- User name - The default user is "embassy" but this is your user within Nextcloud, so be sure it is the correct user if you have more than one.
- Password - Your Nextcloud user's password (Default found in "Properties" in the Nextcloud service page).
- Description - Anything to describe this account, such as "Nextcloud CalDAV".
.. figure:: /_static/images/nextcloud/nextcloud-iOS-native-step2.png
:width: 30%
:alt: nextcloud account settings
4. If you get a warning about verifying the server identity, it is safe to "Continue." Add the apps you want to use, such as Calendars, Contacts, and/or Reminders, then tap "Save."
- That's it! Go back to step 2 above to set up your other account (CalDAV / CardDAV).

141
site/source/service-guides/nextcloud/nextcloud-setup/nextcloud-linux.rst Normal file
View File

@@ -0,0 +1,141 @@
.. _nextcloud-linux:
=================
Nextcloud - Linux
=================
.. contents::
:depth: 2
:local:
Initial Config
--------------
It is advised to setup your Nextcloud devices on LAN (if available) for the best experience. Once set up, Tor can be used for remote syncing, but remember that large files will likely fail or take a very long time, so it is best to use remote sync only for low-bandwidth activity, such as Calendar, Contacts, Tasks, and Notes. Streaming your music is also possible. Later in 2023, new connection options will unlock Nextcloud's full feature-set.
Desktop Integrations
--------------------
Many Linux distributions ship with a Desktop Environment (DE) that supports Nextcloud account integration directly for use with their built-in calendars and other applications. It is recommended to try these first for the best possible experience with your particular flavor of Linux.
You will first need to :ref:`trust your Root CA<ca-linux>`.
The following desktop environments support integrated account syncing, including Nextcloud:
- Gnome (Ubuntu default)
- Cinnamon (Linux Mint default)
- KDE
- Budgie
The following guide uses Ubuntu as an example.
1. Open settings app.
.. figure:: /_static/images/nextcloud/nextcloud-linux-1.png
:width: 60%
:alt: open settings app
2. Go to Online Accounts and click on **Nextcloud**.
.. figure:: /_static/images/nextcloud/nextcloud-linux-2.png
:width: 60%
:alt: online accounts settings
3. Paste in the server path from **StartOS > Nextcloud > Interfaces** and the username and password from **StartOS > Nextcloud > Properties**, and click **Connect**.
.. figure:: /_static/images/nextcloud/nextcloud-linux-3.png
:width: 60%
:alt: enter nextcloud credentials
4. Choose which services you want to integrate and close **Nextcloud Account** window.
.. figure:: /_static/images/nextcloud/nextcloud-linux-4.png
:width: 60%
:alt: nextcloud account services
5. Open the file manager, and you should see your NextCloud account in the side panel.
.. figure:: /_static/images/nextcloud/nextcloud-linux-5.png
:width: 60%
:alt: nextcloud in file manager
To setup other Linux distributions, check out this `Linuxhint guide <https://linuxhint.com/linux_file_managers_nextcloud/>`_ and our `Nextcloud Master Thread <https://community.start9.com/t/nextcloud-master-thread/>`_. Please share your feedback - it is very valuable to our community!
Standalone Clients
------------------
For those that prefer to use a desktop client or your desktop environment does not support account integrations.
.. note:: The desktop version of NextCloud doesn't have much of a user interface. Once installed, it solely lives in the your system tray or navigation bar. You can click on this icon to access the app.
File Syncing - Nextcloud Desktop
================================
This is Nextcloud's official client application for file syncing and account management. It is available in your favorite package manager (usually as `nextcloud`). You can also see this `full list of available packages <https://help.nextcloud.com/t/linux-packages-status/>`_. or you can get the latest version as an AppImage from the `Download for Desktop <https://nextcloud.com/install/#install-clients>`_ section of Nextcloud's website.
LAN Setup
.........
Make sure you have first set up :ref:`trusted your Root CA<ca-linux>`.
1. Open the client and click **Log In to your Nextcloud**.
.. figure:: /_static/images/nextcloud/nextcloud-linux-desktop-1.png
:width: 60%
:alt: nextcloud login
2. From your server's Nextcloud Service page, go to **Interfaces** and copy the LAN address.
.. figure:: /_static/images/nextcloud/nextcloud-mac-step3-lan.png
:width: 60%
:alt: nextcloud interfaces
3. Enter your LAN address under **Server Address** and click **Next**.
.. figure:: /_static/images/nextcloud/nextcloud-linux-desktop-2.png
:width: 60%
:alt: nextcloud server path
4. This will launch a page in your web browser, click **Log In** and then **Grant access** to link the desktop client. You can close this browser window afterwards.
.. figure:: /_static/images/nextcloud/nextcloud-mac-step5.png
:width: 60%
:alt: nextcloud login and grant access
5. Next, configure the local directory that you want to sync with Nextcloud. You may use the default or change it, and edit the sync settings to desired. When satisfied, click **Connect**.
.. figure:: /_static/images/nextcloud/nextcloud-linux-desktop-3.png
:width: 60%
:alt: nextcloud add account
6. Files will begin to sync immediately and you will see a green check when this is complete.
.. figure:: /_static/images/nextcloud/nextcloud-linux-desktop-5.png
:width: 60%
:alt: nextcloud sync
7. That's it! From this desktop client you will recieve notifications, control accounts and syncing, and quickly access your Apps' WebUI pages
Tor Setup
.........
You will first need to have the :ref:`Tor daemon running<tor-linux>`.
1. On your desktop application. Click the account avatar in the top left > Settings, then click Network. Choose **Specify proxy manually as** and **SOCKS5 proxy**. Enter **127.0.0.1** for the Host and **9050** for the port.
.. figure:: /_static/images/nextcloud/nextcloud-linux-tor-1.png
:width: 60%
:alt: nextcloud network settings
2. Close the Settings screen and click the account in the top left again, then **Add Account**.
.. figure:: /_static/images/nextcloud/nextcloud-linux-tor-2.png
:width: 60%
:alt: nextcloud add account
3. On the following screen, click **Log in your Nextcloud**, then enter your Nextcloud Tor server address, which you can copy from the Nextcloud page on your **StartOS > Interfaces > Tor**.
.. figure:: /_static/images/nextcloud/nextcloud-linux-desktop-1.png
:width: 60%
:alt: nextcloud server path
.. figure:: /_static/images/nextcloud/nextcloud-linux-tor-3.png
:width: 60%
:alt: nextcloud add account
4. This will launch your browser and prompt you to log in to your account. Log in and then grant access as we did for LAN.
5. That's it! You can set up some select folders for remote sync, but for large files, it is best to sync on LAN only. Check your connection by clicking the newly created account in the client app.

185
site/source/service-guides/nextcloud/nextcloud-setup/nextcloud-mac.rst Normal file
View File

@@ -0,0 +1,185 @@
.. _nextcloud-mac:
=================
Nextcloud - MacOS
=================
.. contents::
:depth: 3
:local:
Initial Config
--------------
It is advised to setup your Nextcloud devices on LAN (if available) for the best experience. Once set up, Tor can be used for remote syncing, but remember that large files will likely fail or take a very long time, so it is best to use remote sync only for low-bandwidth activity, such as Calendar, Contacts, Tasks, and Notes. Streaming your music is also possible. Later in 2023, new connection options will unlock Nextcloud's full feature-set.
Native Desktop Integration
--------------------------
The smoothest experience will be using direct account integration with your Mac. First head into the top-righthand menu of your Nextcloud's WebUI and click "Apps," then search for and install the Calendar and/or Contacts Apps if you don't have them already (these are installed by default on the latest Nextcloud for StartOS). The steps below are adapted from the `Official Nextcloud guide <https://docs.nextcloud.com/server/24/user_manual/en/groupware/sync_osx.html>`_ and updated for the latest MacOS (Ventura). Make sure you have first set up :ref:`LAN access<ca-mac>`.
.. tabs::
.. group-tab:: Ventura
1. Open the "System Settings" and select "Internet Accounts," click "Add Account." and then select "Add Other Account".
.. figure:: /_static/images/nextcloud/native-nextcloud-integration-macos-step1.png
:width: 60%
:alt: macOS add account
.. figure:: /_static/images/nextcloud/native-nextcloud-integration-macos-step1.2.png
:width: 60%
:alt: macOS add account
2. Select CalDAV for calendar setup or CardDAV for contacts setup. If you want to do both, you will need to return to this step after finishing the setup of the first.
.. note:: You will need to perform 2 individual setups, one for Calendar and one for Contacts.
.. figure:: /_static/images/nextcloud/native-nextcloud-integration-macos-step2.png
:width: 60%
:alt: macOS select account
3. Select "Advanced" from the "Account Type" dropdown menu and fill in the following fields.
.. figure:: /_static/images/nextcloud/native-nextcloud-integration-macos-step3.png
:width: 60%
:alt: macOS setup account
- Username - The default user is "admin," but this is your user within Nextcloud, so be sure it is the correct user if you have more than one
- Password - In your Nextcloud WebUI, visit the top-right-hand menu and select "Personal Settings" -> "Security." At the bottom, under Devices & Sessions, create a new app password with a name of your choice, such as "MacCalDAV." Then, copy the resulting password into your Mac's account configuration.
.. figure:: /_static/images/nextcloud/native-nextcloud-integration-macos-step3.1.png
:width: 60%
:alt: nextcloud app password
- Server Address - copy your LAN address from the "Interfaces" section of your Nextcloud service page then paste.
.. figure:: /_static/images/nextcloud/native-nextcloud-integration-macos-step3.2.png
:width: 60%
:alt: nextcloud app password
- Server Path - You can find complete path in Nextcloud -> Calendar settings -> Copy iOS/macOS CalDav address. For setting up contacts/CardDav use the same path.
.. figure:: /_static/images/nextcloud/native-nextcloud-integration-macos-step3.3.png
:width: 60%
:alt: nextcloud app password
- Port - Set port to `443`.
4. Click "Sign In."
- You can now select the apps you want to use on your Mac, such as Calendars, Reminders.
- Return to Step 3 to set up CalDAV/CardDAV, whichever you have not done yet.
.. group-tab:: Pre-Ventura
1. Open the "System Settings" and select "Internet Accounts," then click "Add Account."
2. Select "Add Other Account"
.. note:: You will need to perform 2 individual setups, one for Calendar and one for Contacts.
3. Select CalDAV for Calendar setup OR CardDAV for Contacts setup. If you want to do both, you will need to return to this step after finishing setup of the first.
4. Select "Manual" from the "Account Type" dropdown menu and fill in the following fields:
- Username - The default user is "admin," but this is your user within Nextcloud, so be sure it is the correct user if you have more than one
- Password - In your Nextcloud WebUI, visit the top-righthand menu and select "Personal Settings" -> "Security." At the bottom, under Devices & Sessions, create a new app password with a name of your choice, such as "MacCalDAV," and then copy the resulting password into your Mac's account config
- Server Address - copy your LAN address from the "Interfaces" section of your Nextcloud service page then add `/remote.php/dav` after `.local`
5. Click "Sign In."
- You can now select the apps you want to use on your Mac, such as Calendars, Reminders, or Contacts
- Return to Step 3 to continue setup
Standalone Clients
------------------
.. note:: The desktop version of NextCloud doesn't have much of a user interface. Once installed, it solely lives in the top right hand corner of the Mac desktop in the navbar, near the WiFi icon. When it's synced, the icon turns into a checkmark with a circle around it.
For those that prefer to use a desktop client.
File Syncing - Nextcloud Desktop
================================
This is Nextcloud's official client application for file syncing and account management. The latest version of the official Nextcloud client is available on their `download page <https://nextcloud.com/install/#install-clients>`_.
LAN Setup
.........
Make sure you have first set up :ref:`LAN access<ca-mac>`. Then do the following:
1. Download the appropriate desktop client from the `Nextcloud website <https://nextcloud.com/install/#install-clients>`_.
2. Open the client and click "Log In".
.. figure:: /_static/images/nextcloud/nextcloud-mac-step2.png
:width: 40%
:alt: nextcloud-login
3. From your server's Nextcloud Service page, go to "Interfaces" and copy the LAN address.
.. figure:: /_static/images/nextcloud/nextcloud-mac-step3-lan.png
:width: 60%
:alt: nextcloud-login
4. Enter your LAN address under "Server Address" and click "Next".
.. figure:: /_static/images/nextcloud/nextcloud-mac-step4.png
:width: 40%
:alt: nextcloud-login
5. This will launch a page in your web browser, click "Log In" and then "Grant access" to link the desktop client. You can close this browser window afterwards.
.. figure:: /_static/images/nextcloud/nextcloud-mac-step5.png
:width: 40%
:alt: nextcloud-login
6. Next, configure the local directory that you want to sync with Nextcloud. You may use the default or change it, and edit the sync settings to desired. When satisfied, click "Connect".
.. figure:: /_static/images/nextcloud/nextcloud-mac-step6.png
:width: 60%
:alt: nextcloud-login
7. Files will begin to sync immediately and you will see a green check when this is complete.
.. figure:: /_static/images/nextcloud/nextcloud-mac-step7.png
:width: 50%
:alt: nextcloud-login
8. That's it! From this desktop client you can receive notifications, control accounts and syncing, and quickly access your apps' WebUI pages.
Tor Setup
.........
You will first need to have the :ref:`Tor daemon running<tor-mac>`.
1. On your desktop application, click the account in the top left -> Settings.
.. figure:: /_static/images/nextcloud/nextcloud-mac-tor1.png
:width: 40%
:alt: nextcloud-login
2. On the following screen, click "Network" tab and then “Specify proxy manually as” and “SOCKS5 proxy.” Enter “127.0.0.1” for the Host and “9050” for the port.
.. figure:: /_static/images/nextcloud/nextcloud-mac-tor2.png
:width: 40%
:alt: nextcloud-login
3. Close the Settings screen and click the account in the top left again, then “Add Account.”
.. figure:: /_static/images/nextcloud/nextcloud-mac-tor3.png
:width: 40%
:alt: nextcloud-login
4. On the following screen, click “Log in,” then enter your Nextcloud Tor server address, which you can copy from Nextcloud -> Interfaces - Tor. This must start with http:// and end with .onion. Click Next.
.. figure:: /_static/images/nextcloud/nextcloud-mac-step2.png
:width: 40%
:alt: nextcloud-login
.. figure:: /_static/images/nextcloud/nextcloud-mac-step4.png
:width: 40%
:alt: nextcloud-login
5. This will launch your browser and prompt you to log in to your account. Log in and then grant access as we did for LAN.
6. That’s it! You may wish to set up some select folders for remote sync, but for large files, it is best to sync on LAN only, so you can “Skip folders configuration” on the resulting screen if you wish. Check your connection by clicking the newly created account in the client app.

66
site/source/service-guides/nextcloud/nextcloud-setup/nextcloud-windows.rst Normal file
View File

@@ -0,0 +1,66 @@
.. _nextcloud-windows:
===================
Nextcloud - Windows
===================
.. contents::
:depth: 2
:local:
Initial Config
--------------
It is advised to setup your Nextcloud devices on LAN (if available) for the best experience. Once set up, Tor can be used for remote syncing, but remember that large files will likely fail or take a very long time, so it is best to use remote sync only for low-bandwidth activity, such as Calendar, Contacts, Tasks, and Notes. Streaming your music is also possible. Later in 2023, new connection options will unlock Nextcloud's full feature-set.
Native Desktop Integration
--------------------------
If you prefer to use Microsoft's integrated Calendar and Contacts apps with your Windows machine, you can integrate directly. First head into the top-righthand menu of your Nextcloud's WebUI and click "Apps," then search for and install the Calendar and/or Contacts Apps. The steps below are adapted from the `Official Nextcloud guide <https://docs.nextcloud.com/server/24/user_manual/en/groupware/sync_windows10.html>`_. Make sure you have first set up :ref:`LAN access<ca-windows>`.
1. Launch the Windows Calendar app and click the gear icon (Settings), then select "Manage Accounts."
2. Select "Add Account" and choose "iCloud" (don't worry, it won't *really* be iCloud).
3. Enter an email, username and password. None of this information has to be valid and it will all be changed in the upcoming steps. Click "Sign In" (or "Done" in Win10).
4. In the "Manage Accounts" menu, click on the account just created and select "Change Settings," and then "Change mailbox sync settings" (at the bottom of the page).
5. Scroll to the bottom again and fill in the following fields (as desired):
- Calendar Server (CalDAV) - This link can be copy-pasted by clicking your Nextcloud Calendar app's "Calendar Settings" in the bottom-left, then "Copy primary CalDAV address" at the bottom of the expanded menu.
- Contacts Server (CardDAV) - This link can be copy-pasted by clicking your Nextcloud Contacts app's "Contacts Settings" in the bottom-left, then the kebab (3 dots) menu next to "Contacts," and finally "Copy Link" at the top of the resulting menu.
6. Click "Done."
- You should now be able to sync your native Windows Contacts and/or Calendar apps with the associated Nextcloud apps.
Standalone Clients
------------------
File Syncing - Nextcloud Desktop
================================
This is Nextcloud's official client application for file syncing and account management. The latest version of the official Nextcloud client is available on their `download page <https://nextcloud.com/install/#install-clients>`_.
LAN Setup
.........
Make sure you have first set up :ref:`LAN access<ca-windows>`. Then do the following:
1. Download the appropriate desktop client from https://nextcloud.com/install/#install-clients
2. Open the client and click "Log In"
3. From your server's Nextcloud Service page, go to "Interfaces" and copy the LAN address
4. Enter your LAN address under "Server Address" and click "Next"
5. You will be asked to Trust your server's certificate, which is safe to do as you generate and sign this during LAN Setup
6. Tick the box for "Trust this certificate anyway" and click "Next"
7. This will launch a page in your web browser, click "Log In" and then "Grant access" to link the desktop client. You can close this browser window afterwards
8. Next, configure the local directory that you want to sync with Nextcloud. You may use the default or change it, and edit the sync settings to desired. When satisfied, click "Connect"
9. Files will begin to sync immediately and you will see a green check when this is complete.
10. That's it! From this desktop client you will recieve notifications, control accounts and syncing, and quickly access your Apps' WebUI pages
Tor Setup
.........
You will first need to have the :ref:`Tor daemon running<tor-windows>`.
1. On your desktop application, click the account in the top left -> Settings, then in Settings, click Network, then "Specify proxy manually as" and "SOCKS5 proxy." Enter "127.0.0.1" for the Host and "9050" for the port.
2. Close the Settings screen and click the account in the top left again, then "Add Account."
3. On the following screen, click "Log in," then enter your Nextcloud Tor server address, which you can copy from Nextcloud -> Interfaces - Tor. This must start with `http://` and end with .onion. Click Next.
4. This will launch your browser and prompt you to log in to your account. Log in and then grant access as we did for LAN.
5. That's it! You may wish to set up some select folders for remote sync, but for large files, it is best to sync on LAN only, so you can "Skip folders configuration" on the resulting screen if you wish. Check your connection by clicking the newly created account in the client app.

16
site/source/service-guides/specter/index.rst Normal file
View File

@@ -0,0 +1,16 @@
.. _specter:
=======
Specter
=======
There are two ways to use Specter with your Start9 server.
You can :ref:`run it as a service<specter-service>` in which case it will automatically connect to Bitcoin Core and can be optionally configured to connect via Electrs.
Alternatively you can `connect Specter Desktop via Tor <https://github.com/Start9Labs/bitcoind-wrapper/tree/master/docs/integrations/specter>`_.
.. toctree::
:maxdepth: 1
specter-service

194
site/source/service-guides/specter/specter-service.rst Normal file
View File

@@ -0,0 +1,194 @@
.. _specter-service:
Specter Service
---------------
To run Specter as a service on your Start9 server, simply `install it from the marketplace <https://marketplace.start9.com/marketplace/specter>`_.
You can then configure it to connect to the bitcoin network via connecting to Bitcoin Core directly, or to Electrs.
Electrs will be more performant but will use more system resources.
Once up and running you can follow these instructions to setup a signing device with Specter.
There are two ways to create a wallet from a signing device using Specter.
Some signing devices permit you to "air gap" which means transferring the xpub (and subsequent unsigned/signed transactions) back and forth between Specter and the signing device via an SD card (Coldcard for example) - other devices require a direct USB connection (Trezor One for example).
.. note:: Using an airgapped signing device like a Coldcard is far easier to setup as unsigned transactions can be simply downloaded to your local machine where they can be saved to an SD card and transferred to a signing device for signing. Signing devices that connect via USB require a more complicated setup.
.. tabs::
.. group-tab:: USB Connected Signing Devices:
For devices like the Trezor One, air gapping is not possible. This means importing xpubs via USB - Specter permits this via the HWI which requires running a second instance of Specter on your *local* machine (i.e *not* your server).
#. Start by heading to Specter running on your server (you can use either Tor or LAN - if you are accessing your server over LAN the Launch UI button will open up the LAN interface for Specter - if you're accessing over Tor it will open up the Tor interface).
#. Click on the cog in the top right, or **Update your settings**:
.. figure:: /_static/images/services/specter/img-1.png
:width: 60%
:alt: img-1
#. Click **USB devices** and then **Remote Specter USB connection**:
.. figure:: /_static/images/services/specter/img-2.png
:width: 60%
:alt: img-2
#. Click **copy** under step 2:
.. figure:: /_static/images/services/specter/img-3.png
:width: 60%
:alt: img-3
#. Now start Specter on your *local* machine (**not** your server) by either installing the application [here](https://specter.solutions) or run it in the background by following the instructions `here <https://github.com/cryptoadvance/specter-desktop#installing-specter-from-pip>`_.
#. Once it's up and running, Head to the HWI settings here - http://127.0.0.1:25441/hwi/settings/
.. figure:: /_static/images/services/specter/img-4.png
:width: 60%
:alt: img-4
#. Paste in the domain that you copied from Specter running on your server and click Update
.. figure:: /_static/images/services/specter/img-5.png
:width: 60%
:alt: img-5
#. Now connect your Trezor One or other signing device to your local machine:
.. figure:: /_static/images/services/specter/img-6.png
:width: 60%
:alt: img-6
#. Head back to Specter on your server and click **Save Changes**
#. Click **Test connection**
#. You should see this along the top of the screen:
.. figure:: /_static/images/services/specter/img-7.png
:width: 60%
:alt: img-7
.. note:: At current time of writing, you must hit save **before** hitting test connection.
#. You can now click **Add new device** and select the type of signing device you're using (in this case, a Trezor).
.. figure:: /_static/images/services/specter/img-8.png
:width: 60%
:alt: img-8
#. Name the device and click **Get via USB**:
.. figure:: /_static/images/services/specter/img-9.png
:width: 60%
:alt: img-9
#. You may be asked for your PIN and passphrase here, and you may need to confirm extraction on the signing device.
#. Specter will then begin extracting the public key(s) from your device:
.. figure:: /_static/images/services/specter/img-10.png
:width: 60%
:alt: img-10
#. You may not want all the default types of extended public key. Remove/keep the ones you want by clicking "edit" and "remove".
#. Click "Continue"
#. You can now **Add new wallet** or **create single key wallet**:
.. figure:: /_static/images/services/specter/img-12.png
:width: 60%
:alt: img-12
.. tip:: If you want to create a multisig wallet, add another device first, and make sure you generated an xpub intented for multisig on the first device, then come back to this step.
#. Select the device (or devices if you are making a multisig wallet) that you want to use.
.. figure:: /_static/images/services/specter/img-13.png
:width: 60%
:alt: img-13
#. Name the wallet and select the key(s) you want to use.
.. tip:: (If you only have one key, it will automatically use that key)
#. Select **Scan for existing funds** if you have already used this wallet and wish to establish the transaction history, if this is a brand new wallet this is not necessary and should be deselected.
#. Click **Create wallet**:
.. figure:: /_static/images/services/specter/img-11.png
:width: 60%
:alt: img-11
#. If you selected "rescan" you can refresh the page and watch as your bitcoin node rescans the blockchain for your wallet's history.
.. note:: This will be very slow if Specter is configured to connect to Bitcoin Core directly, and extremely fast if connecting via Electrs.
Specter is now setup to use your signing device!
.. group-tab:: Air Gapped Signing Devices
This part of the guide will go over how to upload an xpub from a device that permits air gapping - in this case a Coldcard.
#. Power up the Coldcard, enter your pin and any passphrase necessary.
#. Go down to **Advanced**, **MicroSD card**, **Export Wallet**, **Generic JSON**:
.. figure:: /_static/images/services/specter/img-14.png
:width: 60%
:alt: img-14
#. Remove the SD card from your Coldcard and insert it into your *local* machine (not the server)
#. Go to Specter on your server, click "Add new device" and select Coldcard (or other air gap permitting device):
.. figure:: /_static/images/services/specter/img-15.png
:width: 60%
:alt: img-15
#. Name the device and click **Upload from SD card**:
.. figure:: /_static/images/services/specter/img-16.png
:width: 60%
:alt: img-16
#. Navitage to the SD card and select **coldcard-export.json** and click open:
.. figure:: /_static/images/services/specter/img-17.png
:width: 60%
:alt: img-17
#. You may not want all the default types of extended public key. Remove/keep the ones you want by clicking **edit**.
#. Click **Continue**:
.. figure:: /_static/images/services/specter/img-18.png
:width: 60%
:alt: img-18
#. You can now **Add new wallet** or **create single key wallet.**:
.. note:: If you want to create a multisig wallet, add another device first, and make sure you generated an xpub intented for multisig on the first device, then come back to this step.
#. Select the device (or devices if you are making a multisig wallet) that you want to use.
#. Name the wallet and select the key(s) you want to use.
(If you only have one key, it will automatically use that key)
#. Select "Scan for existing funds" if you have already used this wallet and wish to establish its transaction history, if this is a brand new wallet this is not necessary and should be deselected.
#. Click **Create wallet**:
.. figure:: /_static/images/services/specter/img-19.png
:width: 60%
:alt: img-19
#. If you selected "rescan" you can refresh the page and watch as your bitcoin node rescans the blockchain for your wallet's history.
Specter is now setup to use your signing device!

339
site/source/service-guides/vaultwarden/bitwarden-client-setup.rst Normal file
View File

@@ -0,0 +1,339 @@
.. _bitwarden-client-setup:
============
Client Setup
============
Here you can setup your various devices and browsers to be able to access your Vaultwarden server.
Browser Extension
-----------------
.. tabs::
.. group-tab:: Tor
If connecting via Tor (i.e using the .onion address) the Bitwarden browser extension will only work with a Tor enabled browser. You can use Firefox (recommended), Tor Browser or Brave Browser.
#. If you choose Firefox, you will need to :ref:`setup Tor on your device <connecting-tor>` and :ref:`configure Firefox to use Tor <configuring-ff>`. If using Brave you will just need to :ref:`setup Tor on your device <connecting-tor>`. With Tor Browser, everything will just work right out of the box.
.. tip:: We recommend using Firefox as it is the most compatible browser with Start9 Servers.
#. In this example we will use Firefox, though these instructions will work just the same for Brave. First, install the `Bitwarden browser extension <https://addons.mozilla.org/en-US/firefox/addon/bitwarden-password-manager/>`_.
#. Head to the "Interfaces" tab in the Vaultwarden service on your Start9 Server:
.. figure:: /_static/images/services/vaultwarden/vaultwarden-interfaces.png
:width: 50%
:alt: vaultwarden-interfaces
#. Copy the Tor address:
.. figure:: /_static/images/services/vaultwarden/vaultwarden-tor-address.png
:width: 50%
:alt: vaultwarden-tor-address
#. Now head to the Bitwarden extension and click the "Region" dropdown menu and choose self-hosted. Under **Self-hosted environment** you will see a field for **Server URL**.
.. figure:: /_static/images/services/vaultwarden/bitwarden-firefox-setup-step1.png
:width: 40%
:alt: vaultwarden-firefox-self-host
#. Now we need to grab the address of our Vaultwarden server.Paste the address into your extension and click "Save".
.. figure:: /_static/images/services/vaultwarden/bitwarden-firefox-setup-step2.png
:width: 40%
:alt: vaultwarden-firefox-url
#. Now enter your credentials and the Bitwarden extension will be logged into your self-hosted Vaultwarden server!
.. group-tab:: LAN
We suggest using Tor, however it is possible have a good experience with LAN. Once synced, your app and all your passwords will be cached and available when you are on the go and not connected to your Start9 Server, and you will only need to be on LAN to update any edits to your vault.
#. Start by installing the `Bitwarden browser extension <https://addons.mozilla.org/en-US/firefox/addon/bitwarden-password-manager/>`_.
#. Head to the "Interfaces" tab in the Vaultwarden service on your Start9 Server:
.. figure:: /_static/images/services/vaultwarden/vaultwarden-interfaces.png
:width: 50%
:alt: vaultwarden-interfaces
#. Copy the LAN address:
.. figure:: /_static/images/services/vaultwarden/vaultwarden-lan-address.png
:width: 50%
:alt: vaultwarden-lan-address
#. Now head to the Bitwarden extension and click the Region dropdown menu and choose self-hosted. Under **Self-hosted environment** you will see a field for **Server URL**.
.. figure:: /_static/images/services/vaultwarden/bitwarden-firefox-setup-step1.png
:width: 40%
:alt: vaultwarden-firefox-self-host
#. Now we need to grab the address of our Vaultwarden server.Paste the address into your extension and click "Save".
.. figure:: /_static/images/services/vaultwarden/bitwarden-firefox-setup-step2.png
:width: 40%
:alt: vaultwarden-firefox-url
#. Now enter your credentials and the Bitwarden extension will be logged into your self-hosted Vaultwarden server!
Android
-------
.. tabs::
.. group-tab:: Tor
You will need to :ref:`Setup Tor <tor-android>` on your device first.
#. Visit your app store of choice and download the Bitwarden app. Once downloaded and installed, let's go into Orbot, and add the app to the VPN apps list. You may need to hit the refresh button in the top left to get it to populate.
#. Next, enter the Bitwarden app. You'll be greeted with a log-in screen. Go to the top left gear icon to enter the settings.
#. Head to the "Interfaces" tab in the Vaultwarden service on your Start9 Server:
.. figure:: /_static/images/services/vaultwarden/vaultwarden-interfaces.png
:width: 50%
:alt: vaultwarden-interfaces
#. Copy the Tor address:
.. figure:: /_static/images/services/vaultwarden/vaultwarden-tor-address.png
:width: 50%
:alt: vaultwarden-tor-address
#. Now send that address to your phone and paste it into Bitwarden.
#. Hit save.
#. Go ahead and tap 'Log In,' enter your credentials, and you can access your Bitwarden app / Vaultwarden server.
.. group-tab:: LAN
We suggest using Tor, however it is possible have a good experience with LAN. Once synced, your app and all your passwords will be cached and available when you are on the go and not connected to your Start9 Server, and you will only need to be on LAN to update any edits to your vault.
Begin by :ref:`setting up LAN <ca-android>` on your device.
#. Visit your app store of choice and download the Bitwarden app. Once downloaded and installed, let's go into Orbot, and add the app to the VPN apps list. You may need to hit the refresh button in the top left to get it to populate.
#. Next, enter the Bitwarden app. You'll be greeted with a log-in screen. Go to the top left gear icon to enter the settings.
#. Head to the "Interfaces" tab in the Vaultwarden service on your Start9 Server:
.. figure:: /_static/images/services/vaultwarden/vaultwarden-interfaces.png
:width: 50%
:alt: vaultwarden-interfaces
#. Copy the LAN address:
.. figure:: /_static/images/services/vaultwarden/vaultwarden-lan-address.png
:width: 50%
:alt: vaultwarden-lan-address
#. Now send that address to your phone and paste it into Bitwarden.
#. Hit save.
#. Go ahead and tap 'Log In,' enter your credentials, and you can access your Bitwarden app / Vaultwarden server.
iOS
---
.. tabs::
.. group-tab:: Tor
Begin by :ref:`setting up Tor <tor-ios>` on your iPhone.
You will also need :ref:`LAN access <ca-ios>` setup on your iPhone.
#. Visit the App Store and download the `Bitwarden app <https://apps.apple.com/us/app/bitwarden-password-manager/id1137397744>`_
#. Open the Bitwarden app. You'll be greeted with a log-in screen. Click the "Region" drop-down menu.
.. figure:: /_static/images/services/vaultwarden/bitwarden-iOS-setup-step1.png
:width: 40%
:alt: vaultwarden-iOS-log-in-screen
#. Choose the "Self-hosted" option.
.. figure:: /_static/images/services/vaultwarden/bitwarden-iOS-setup-step2.png
:width: 40%
:alt: vaultwarden-iOS-self-hosted-screen
#. Head to the "Interfaces" tab in the Vaultwarden service on your Start9 Server:
.. figure:: /_static/images/services/vaultwarden/vaultwarden-interfaces.png
:width: 50%
:alt: vaultwarden-interfaces
#. Copy the Tor address:
.. figure:: /_static/images/services/vaultwarden/vaultwarden-tor-address.png
:width: 50%
:alt: vaultwarden-tor-address
#. Now send that address to your phone and paste it into Bitwarden.
.. caution:: **Before you hit save:** The Tor address you will have copied will begin with **http** - Please change this to **https** instead of **http**
.. figure:: /_static/images/services/vaultwarden/bitwarden-iOS-setup-step3.png
:width: 40%
:alt: vaultwarden-iOS-url-screen
#. Now you can hit save, and you'll be returned to the log-in screen.
#. Go ahead and tap 'Log In,' enter your credentials, and you'll be able to access your Bitwarden app / Vaultwarden server!
.. group-tab:: LAN
We suggest using Tor, however it is possible have a good experience with LAN. Once synced, your app and all your passwords will be cached and available when you are on the go and not connected to your Start9 Server, and you will only need to be on LAN to update any edits to your vault.
Begin by :ref:`setting up LAN <ca-ios>` on your device.
#. Visit the App Store and download the `Bitwarden app <https://apps.apple.com/us/app/bitwarden-password-manager/id1137397744>`_
#. Open the Bitwarden app. You'll be greeted with a log-in screen.
#. Open the Bitwarden app. You'll be greeted with a log-in screen. Click the "Region" drop-down menu.
.. figure:: /_static/images/services/vaultwarden/bitwarden-iOS-setup-step1.png
:width: 40%
:alt: vaultwarden-iOS-log-in-screen
#. Choose the "Self-hosted" option.
.. figure:: /_static/images/services/vaultwarden/bitwarden-iOS-setup-step2.png
:width: 40%
:alt: vaultwarden-iOS-self-hosted-screen
#. Head to the "Interfaces" tab in the Vaultwarden service on your Start9 Server:
.. figure:: /_static/images/services/vaultwarden/vaultwarden-interfaces.png
:width: 50%
:alt: vaultwarden-interfaces
#. Copy the LAN address:
.. figure:: /_static/images/services/vaultwarden/vaultwarden-lan-address.png
:width: 50%
:alt: vaultwarden-lan-address
#. Now send that address to your phone and paste it into Bitwarden.
.. figure:: /_static/images/services/vaultwarden/bitwarden-iOS-setup-step3.png
:width: 40%
:alt: vaultwarden-iOS-url-screen
#. Now you can hit save, and you'll be returned to the log-in screen.
#. Go ahead and tap 'Log In,' enter your credentials, and you'll be able to access your Bitwarden app / Vaultwarden server!
Desktop Clients
---------------
.. collapse:: Linux
First, be sure to get Tor :ref:`running on your system <tor-linux>`.
#. Install Bitwarden either by using a package manager like **apt** (we recommend against using **snap**) or download it from `here <https://bitwarden.com/download/>`_.
#. Run the program with the flag ``--proxy-server=socks5://127.0.0.1:9050`` behind it. You can run this from a terminal, and if you'd like to use a shortcut, edit that shortcut file to include the flag.
#. As with the other solutions above, click the 'Settings' icon, and enter your Vaultwarden Tor address. You can then log in to your vault.
Alternatively, you may be able to run using your LAN address, but this has proven finicky, especially on Debian/Ubuntu systems. You will have better luck if you have the Root CA installed at the OS level. First, be sure to :ref:`Setup LAN <ca-linux>` natively.
.. collapse:: Mac
.. tabs::
.. group-tab:: Tor
#. Begin by making sure that Tor is :ref:`running on your Mac<tor-mac>`.
#. Download the `Bitwarden Desktop app <https://bitwarden.com/download/>`_.
#. Open the Bitwarden app and click on the "Region" drop-down menu:
.. figure:: /_static/images/services/vaultwarden/bitwarden-macOS-setup-step1.png
:width: 50%
:alt: bitwarden-mac
#. Head to the "Interfaces" tab in the Vaultwarden service on your Start9 Server:
.. figure:: /_static/images/services/vaultwarden/vaultwarden-interfaces.png
:width: 50%
:alt: vaultwarden-interfaces
#. Copy the Tor address:
.. figure:: /_static/images/services/vaultwarden/vaultwarden-tor-address.png
:width: 50%
:alt: vaultwarden-tor-address
#. Paste the address into Bitwarden and click the save button:
.. figure:: /_static/images/services/vaultwarden/bitwarden-macOS-setup-step2.png
:width: 50%
:alt: bitwarden-tor-mac-url
#. Enter the email used to create the account, followed by the password, then click "Log in with master password".
.. group-tab:: LAN
We suggest using Tor, however it is possible have a good experience with LAN. Once synced, your app and all your passwords will be cached and available when you are on the go and not connected to your Start9 Server, and you will only need to be on LAN to update any edits to your vault.
#. Begin by making sure that LAN is :ref:`steup on your Mac<ca-mac>`.
#. Download the `Bitwarden Desktop app <https://bitwarden.com/download/>`_.
#. Open the Bitwarden app and click on the "Region" drop-down menu:
.. figure:: /_static/images/services/vaultwarden/bitwarden-macOS-setup-step1.png
:width: 50%
:alt: bitwarden-mac
#. Head to the "Interfaces" tab in the Vaultwarden service on your Start9 Server:
.. figure:: /_static/images/services/vaultwarden/vaultwarden-interfaces.png
:width: 50%
:alt: vaultwarden-interfaces
#. Copy the LAN address:
.. figure:: /_static/images/services/vaultwarden/vaultwarden-lan-address.png
:width: 50%
:alt: vaultwarden-lan-address
#. Paste the address into Bitwarden and click the save button:
.. figure:: /_static/images/services/vaultwarden/bitwarden-macOS-setup-step2.png
:width: 50%
:alt: bitwarden-tor-mac-url
#. Enter the email used to create the account, followed by the password, then click "Log in with master password".
.. collapse:: Windows
.. tabs::
.. group-tab:: Tor
#. Download the `Bitwarden Desktop app <https://bitwarden.com/download/>`_.
#. Follow the Tor setup in the instructions below. Make sure the Bitwarden directory is located in your user's directory, ``C:\Users\YOURUSER\AppData\Local\Bitwarden``. This is because you need permission to run over a proxy. You can make a shortcut wherever you'd like.
#. Right-click the shortcut and click 'Properties.' Add the flag ``--proxy-server=socks5://127.0.0.1:9050`` to the end of the 'Target' field. Click 'Apply,' then 'OK.' Close Properties and launch the shortcut.
#. As with the other solutions above, click the 'Settings' icon, and enter your Vaultwarden Tor address. You can then log in to your vault.
.. group-tab:: LAN
This is not known to work at this time - LAN is tricky with Windows due to the often unreliable Bonjour and Bonjour Print Services required for handling mDNS. We suggest using Tor anyway if you are able as you will then be able to maintain connectivity to your server from anywhere in the world.

175
site/source/service-guides/vaultwarden/bitwarden-walkthrough.rst Normal file
View File

@@ -0,0 +1,175 @@
.. _bitwarden-walkthrough:
=========================
Vaultwarden Initial Setup
=========================
.. contents::
:depth: 2
:local:
.. _vaultwarden-webvault:
Web Vault
---------
#. Ensure Vaultwarden is running - click **START** on your Start9 Server if not:
.. figure:: /_static/images/services/vaultwarden/vaultwarden-start-service.png
:width: 30%
:alt: vaultwarden-start-service
#. Once the health check turns green, click **Launch UI**:
.. figure:: /_static/images/services/vaultwarden/vaultwarden-launch-ui.png
:width: 30%
:alt: vaultwarden-launch-ui
#. Time to create an account! Click **Create account**:
.. figure:: /_static/images/services/vaultwarden/vaultwarden-create-account.png
:width: 40%
:alt: vaultwarden-create-account
.. note:: You are creating an account with yourself on your own Vaultwarden website served from your own Vaultwarden server - there are no third parties involved here.
#. Enter an email address for login:
.. figure:: /_static/images/services/vaultwarden/vaultwarden-create-account-email.png
:width: 30%
:alt: vaultwarden-create-account-email
.. tip:: This email address can be anything you like. It doesn't have to be real. It is simply a way for you to log into Vaultwarden from Bitwarden apps on your devices. Your Vaultwarden server won't ever email you.
.. tip:: You cannot use this email address to reset your master password - it is simply used to create an account on your server.
.. warning:: Do not lose it - you will not be able to log in without it!
#. Enter a name for the account, a strong password and (optionally) a password hint - then click **Create account**:
.. figure:: /_static/images/services/vaultwarden/vaultwarden-account-creation.png
:width: 30%
:alt: vaultwarden-account-creation
.. warning:: It is important to realize that this is the 'Master password' for all your other passwords. Make it very strong, memorize it, write it down, and back it up to a safe place. If you lose it, you may lose access to all your passwords and your entire digital life.
#. Now you can log in to your new password manager! Enter your email to login:
.. figure:: /_static/images/services/vaultwarden/vaultwarden-login-email.png
:width: 30%
:alt: vaultwarden-login-email
#. Then your master password:
.. figure:: /_static/images/services/vaultwarden/vaultwarden-login-password.png
:width: 30%
:alt: vaultwarden-login-password
#. We are greeted with our newly setup Vaultwarden password vault!
.. figure:: /_static/images/services/vaultwarden/vaultwarden-fresh-vault.png
:width: 30%
:alt: vaultwarden-fresh-vault
#. At the top you can visit **Tools** for reports and to use the password generator. You can also import data from another program, such as Lastpass, Onepass, or KeePass!
.. figure:: /_static/images/services/vaultwarden/vaultwarden-tools.png
:width: 40%
:alt: vaultwarden-tools
#. **Account settings** gives you all your options, including the ability to set up 2 factor authorization.
.. figure:: /_static/images/services/vaultwarden/vaultwarden-account-settings.png
:width: 40%
:alt: vaultwarden-account-settings
#. Now you're ready to start storing some passwords!
Storing your first password
---------------------------
#. Back at the main page for your vault, let's do a quick example login. We'll start by creating a folder for it:
.. figure:: /_static/images/services/vaultwarden/vaultwarden-click-add-folder.png
:width: 50%
:alt: vaultwarden-click-add-folder
#. Name the folder and click **Save**:
.. figure:: /_static/images/services/vaultwarden/vaultwarden-add-folder.png
:width: 30%
:alt: vaultwarden-add-folder
#. Click **Add item**:
.. figure:: /_static/images/services/vaultwarden/vaultwarden-add-item.png
:width: 30%
:alt: vaultwarden-add-item
#. Now add the credentials and click **Save**:
.. figure:: /_static/images/services/vaultwarden/vaultwarden-add-new-login.png
:width: 40%
:alt: vaultwarden-add-new-login
.. tip:: An entry can have multiple URLs - for example you may wish to enter both an onion address and a .local address for one of the services you have running on your server. We are increasing the numbers of ways in which you can connect to your services, soon they may even have simple .com addresses!
#. And there we have it - our first set of login credentials.
.. figure:: /_static/images/services/vaultwarden/vaultwarden-new-login.png
:width: 45%
:alt: vaultwarden-new-login
Congratulations! You have setup your own self-hosted password manager and have added a set of login credentials to it!
.. _vaultwarden-admin:
Accessing the Admin Console
---------------------------
#. You will find the Admin console by heading to "Interfaces" on the Vaultwarden Service page.
.. figure:: /_static/images/services/vaultwarden/vaultwarden-interfaces.png
:width: 40%
:alt: vaultwarden-interfaces
#. Copy either of the addresses here and append **/admin**:
.. figure:: /_static/images/services/vaultwarden/vaultwarden-interfaces-both.png
:width: 40%
:alt: vaultwarden-interfaces-both
.. tip:: A typical address would look like https://abcdefghijklmnopqrstuvwxz.local/admin or http://abcdefghijklmnopqrstuvwxz.onion/admin
#. You will be prompted for your "Admin Token," which can be found on your Vaultwarden Service page under "Properties."
.. figure:: /_static/images/services/vaultwarden/vaultwarden-properties.png
:width: 40%
:alt: vaultwarden-admin-properties
#. Copy the token here:
.. figure:: /_static/images/services/vaultwarden/vaultwarden-properties-admin.png
:width: 40%
:alt: vaultwarden-admin-properties-admin
#. And paste it here:
.. figure:: /_static/images/services/vaultwarden/vaultwarden-admin-console-auth.png
:width: 40%
:alt: vaultwarden-admin-console-auth
#. You're now logged in to the admin panel.
.. figure:: /_static/images/services/vaultwarden/vaultwarden-admin-console.png
:width: 40%
:alt: vaultwarden-admin-console
.. note:: This cannot be used to reset passwords for accounts created on your Vaultwarden server.
Now you'll want to setup some client devices! :ref:`Head here for instructions on how to do so<bitwarden-client-setup>`.

18
site/source/service-guides/vaultwarden/index.rst Normal file
View File

@@ -0,0 +1,18 @@
.. _vaultwarden-service:
===========
Vaultwarden
===========
Vaultwarden is a self-hosted password manager, which means your passwords physically live on your Start9 Server. Be sure to create backups and keep them safe! If you lose your Server or uninstall Vaultwarden, and you have not made a backup, all your passwords will be lost forever.
If you currently have a **hosted** account with Bitwarden, you can export your data from that account and import it to your Vaultwarden service on your Start9 Server using the built-in import/export features in any Bitwarden application!
Follow the guides below to get the most out of your Vaultwarden server:
.. toctree::
:maxdepth: 1
bitwarden-walkthrough
bitwarden-client-setup
vaultwarden-organizations

50
site/source/service-guides/vaultwarden/vaultwarden-organizations.rst Normal file
View File

@@ -0,0 +1,50 @@
.. _vaultwarden-organizations:
========================
Setting Up Organizations
========================
Creating an Organization
------------------------
If you want to share passwords amongst friends or family, you can do so using the "Organizations" feature of Vaultwarden.
#. Inside your :ref:`Web Vault<vaultwarden-webvault>`, click `New Organization`
.. figure:: /_static/images/services/vaultwarden/create-org.png
:width: 60%
#. Give your organization a name and enter your email. ``Note``: You can enter whatever you want for email, even `fake@email.com`. Because you are self-hosting, the email is not used for anything at all.
.. figure:: /_static/images/services/vaultwarden/org-details.png
:width: 60%
Adding Others to Your Organization
----------------------------------
.. warning::
After you have completed signed up new members to your Vaultwarden server, it is highly recommended that you disable new user signups inside your :ref:`Admin Dashboard<vaultwarden-admin>` --> General Settings --> Allow new signups --> uncheck the box.
#. Tell the user to create an account on your Vaultwarden server. This must be done *before* you invite them.
#. Inside the Organization page, click Manage --> `Invite User`
.. figure:: /_static/images/services/vaultwarden/invite-user.png
:width: 60%
#. Decide what permissions you want the member to have and click "Save". In the below example, the member will be a manager and have access to all collections.
.. figure:: /_static/images/services/vaultwarden/user-permissions.png
:width: 60%
#. The new member should automatically show as `Accepted`. If the user shows as `Invited`, Remove their account by clicking the settings icon to the right of their email address, and make sure they sign up *before* you invite them, as mentioned in Step 1. Once they show as `Accepted`, click the settings icon on the right and click "Confirm":
.. figure:: /_static/images/services/vaultwarden/confirm-user.png
:width: 60%
#. You will be presented with a fingerprint phrase. The new member can verify this phrase inside their own dashboard, but because you are self-hosting and adding users manually, you can just click "Confirm".
.. figure:: /_static/images/services/vaultwarden/verify-user.png
:width: 60%
The new member should now be able to see the organization in their own dashboard or client apps.