diff --git a/site/source/_static/images/services/nostr/iris-1.png b/site/source/_static/images/services/nostr/iris-1.png new file mode 100644 index 0000000..12c79c1 Binary files /dev/null and b/site/source/_static/images/services/nostr/iris-1.png differ diff --git a/site/source/_static/images/services/nostr/iris-2.png b/site/source/_static/images/services/nostr/iris-2.png new file mode 100644 index 0000000..1c7b11d Binary files /dev/null and b/site/source/_static/images/services/nostr/iris-2.png differ diff --git a/site/source/_static/images/services/nostr/iris-3.png b/site/source/_static/images/services/nostr/iris-3.png new file mode 100644 index 0000000..69c9515 Binary files /dev/null and b/site/source/_static/images/services/nostr/iris-3.png differ diff --git a/site/source/_static/images/services/nostr/iris-4.png b/site/source/_static/images/services/nostr/iris-4.png new file mode 100644 index 0000000..8ff684f Binary files /dev/null and b/site/source/_static/images/services/nostr/iris-4.png differ diff --git a/site/source/_static/images/services/nostr/iris-5.png b/site/source/_static/images/services/nostr/iris-5.png new file mode 100644 index 0000000..e1e2ea5 Binary files /dev/null and b/site/source/_static/images/services/nostr/iris-5.png differ diff --git a/site/source/_static/images/services/nostr/nostr-1.png b/site/source/_static/images/services/nostr/nostr-1.png new file mode 100644 index 0000000..2018a46 Binary files /dev/null and b/site/source/_static/images/services/nostr/nostr-1.png differ diff --git a/site/source/_static/images/services/nostr/nostr-2.png b/site/source/_static/images/services/nostr/nostr-2.png new file mode 100644 index 0000000..a4f96ba Binary files /dev/null and b/site/source/_static/images/services/nostr/nostr-2.png differ diff --git a/site/source/service-guides/index.rst b/site/source/service-guides/index.rst index 10843a0..4075c89 100644 --- a/site/source/service-guides/index.rst +++ b/site/source/service-guides/index.rst @@ -13,5 +13,6 @@ These guides will help you to setup external tools to connect or interact with s lightning/index matrix nextcloud/index + nostr/index specter/index vaultwarden/index diff --git a/site/source/service-guides/nostr/index.rst b/site/source/service-guides/nostr/index.rst new file mode 100644 index 0000000..b361789 --- /dev/null +++ b/site/source/service-guides/nostr/index.rst @@ -0,0 +1,50 @@ +.. _nostr-service: + +===== +Nostr +===== + +Nostr is a simple, open protocol that enables global, decentralized, and censorship-resistant social media. + +.. note:: + + It is highly recommended that you run a private relay, not a public one. Private will be the default option when you open the config for the first time. You will not be able to save the config until you follow the instructions below. + +**Initial Config** + +#. Install **Nostr RS relay** service from Start9 Registry on your server. + + .. figure:: /_static/images/services/nostr/nostr-1.png + :width: 50% + :alt: nostr install + +#. In the service, page click **CONFIGURE** and add the pubkey in hex format to whitelist your client. Click save. + .. figure:: /_static/images/services/nostr/nostr-2.png + :width: 50% + :alt: nostr whitelist pubkey + +#. Now you will have a Nostr relay websocket URL available in Nostr Properties. + + +**Running a private relay** + +Private relays serve as a personal backup for your posts, follows, messages, settings, and more. Without a private relay, there is no assurance that this data will be preserved, and there is a risk of it disappearing unexpectedly. By utilizing a private relay, only the pubkeys on the whitelist are authorized to post and save content to your relay. To ensure functionality, it is essential to whitelist your own pubkey in hex format. The configuration settings will not permit saving until at least one pubkey is added to the whitelist. Some Nostr clients may offer the option to copy your hex pubkey, but if not, you can visit https://damus.io/key to convert your npub to hex. + +**Running a public relay** + +In contrast to a private relay, a public relay lacks a whitelist, permitting any pubkey to post. Running a public relay is not recommended unless you comprehend the associated risks and configure it with appropriate safeguards. The primary risk to be mindful of is the potential for malicious clients to spam your relay, leading to the saturation of your storage drive. While we have implemented fairly restrictive defaults in your configuration to mitigate this risk, it is crucial to acknowledge that you assume responsibility for managing this aspect on your own. + +**Testing your relay** + +If you want to test your private relay and verify whether it's storing all your notes, you can SSH into your server and execute the following command. + + .. code-block:: bash + + sudo podman exec nostr.embassy sqlite3 /data/nostr.db "SELECT content FROM event;" | grep -o 'content":"[^"]*' | awk -F: '{print $1":"$2}' + +**Client setup** + +.. toctree:: + :maxdepth: 1 + + iris \ No newline at end of file diff --git a/site/source/service-guides/nostr/iris.rst b/site/source/service-guides/nostr/iris.rst new file mode 100644 index 0000000..3c420e4 --- /dev/null +++ b/site/source/service-guides/nostr/iris.rst @@ -0,0 +1,51 @@ +.. _iris: + +==== +Iris +==== + +The Iris client is both a social networking app and library designed to securely store all user data directly on their devices and facilitate direct communication with peers. The application is compatible with various platforms, including web browsers, iOS, Android, Docker, and desktop platforms such as MacOS, Windows, and Linux. + +**Available clients** + +- `Start9 Marketplace `_ +- `iris.to web client `_ +- `Desktop `_ +- `iOS `_ +- `Android `_ + +Using Iris on StartOS +--------------------- + +#. Install Iris service from Start9 registry on your server. + + .. figure:: /_static/images/services/nostr/iris-1.png + :width: 50% + :alt: iris install + +#. Click "Start". + + .. figure:: /_static/images/services/nostr/iris-2.png + :width: 50% + :alt: iris start + +#. When service is ready click launch UI to access your personal Iris web UI. + + .. figure:: /_static/images/services/nostr/iris-3.png + :width: 50% + :alt: iris launch + +#. Create a new account, or access an existing account by pasting in your private key. If creating a new account, be sure to securely back up the private key, preferably using Vaultwarden on your Start9 server. + + .. figure:: /_static/images/services/nostr/iris-4.png + :width: 50% + :alt: iris sign in + +#. To connect to your own private relay, go to Settings -> Network and paste in your Nostr Relay Websocket URL (e.g. ws://address.onion). You can find this value in the Properties section of your Nostr RS Relay service. +.. note:: + If you plan to connect to your own private relay, you must first make sure you are already :ref:`running Tor` on your system and we suggest using Firefox which must be :ref:`configured to use Tor`. + It is recommended to use your Relay's Tor websocket URL (ws://address.onion), since the LAN websocket URL (wss://address.local) will only work when you are home. +.. figure:: /_static/images/services/nostr/iris-5.png + :width: 50% + :alt: iris add url +