diff --git a/src/README.md b/src/README.md index 0dbfa1b..832cfd1 100644 --- a/src/README.md +++ b/src/README.md @@ -112,6 +112,10 @@ Welcome to the Start9 Docs! Here you will find everything you need to set up and - [Nextcloud Photos](service-guides/nextcloud/nextcloud-apps/nextcloud-photos.md) - [Joplin](service-guides/nextcloud/nextcloud-apps/joplin.md) - [Thunderbird](service-guides/nextcloud/nextcloud-apps/thunderbird.md) +- [Nostr](service-guides/nostr/) + - [Nostr RS Relay](service-guides/nostr/nostr-rs-relay.md) + - [noStrudel](service-guides/nostr/nostrudel.md) +- [Vaultwarden](service-guides/vaultwarden/) ### Misc Guides diff --git a/src/SUMMARY.md b/src/SUMMARY.md index 8598a3b..2eb1489 100644 --- a/src/SUMMARY.md +++ b/src/SUMMARY.md @@ -128,6 +128,10 @@ - [Nextcloud Photos](service-guides/nextcloud/nextcloud-apps/nextcloud-photos.md) - [Joplin](service-guides/nextcloud/nextcloud-apps/joplin.md) - [Thunderbird](service-guides/nextcloud/nextcloud-apps/thunderbird.md) +- [Nostr](service-guides/nostr/README.md) + - [Nostr RS Relay](service-guides/nostr/nostr-rs-relay.md) + - [noStrudel](service-guides/nostr/nostrudel.md) +- [Vaultwarden](service-guides/vaultwarden/README.md) # Misc Guides diff --git a/src/service-guides/nostr/README.md b/src/service-guides/nostr/README.md new file mode 100644 index 0000000..420c2e1 --- /dev/null +++ b/src/service-guides/nostr/README.md @@ -0,0 +1,6 @@ +# Nostr + +These guides will help you to setup tools to run a nostr relay and a nostr client. + + - [Nostr RS Relay](./nostr-rs-relay.md) + - [noStrudel](./nostrudel.md) \ No newline at end of file diff --git a/src/service-guides/nostr/assets/nostr-1.png b/src/service-guides/nostr/assets/nostr-1.png new file mode 100644 index 0000000..2018a46 Binary files /dev/null and b/src/service-guides/nostr/assets/nostr-1.png differ diff --git a/src/service-guides/nostr/assets/nostr-2.png b/src/service-guides/nostr/assets/nostr-2.png new file mode 100644 index 0000000..a4f96ba Binary files /dev/null and b/src/service-guides/nostr/assets/nostr-2.png differ diff --git a/src/service-guides/nostr/assets/nostrudel-1.png b/src/service-guides/nostr/assets/nostrudel-1.png new file mode 100644 index 0000000..6d97559 Binary files /dev/null and b/src/service-guides/nostr/assets/nostrudel-1.png differ diff --git a/src/service-guides/nostr/assets/nostrudel-2.png b/src/service-guides/nostr/assets/nostrudel-2.png new file mode 100644 index 0000000..092f187 Binary files /dev/null and b/src/service-guides/nostr/assets/nostrudel-2.png differ diff --git a/src/service-guides/nostr/assets/nostrudel-3.png b/src/service-guides/nostr/assets/nostrudel-3.png new file mode 100644 index 0000000..704304f Binary files /dev/null and b/src/service-guides/nostr/assets/nostrudel-3.png differ diff --git a/src/service-guides/nostr/assets/nostrudel-4.png b/src/service-guides/nostr/assets/nostrudel-4.png new file mode 100644 index 0000000..e724260 Binary files /dev/null and b/src/service-guides/nostr/assets/nostrudel-4.png differ diff --git a/src/service-guides/nostr/assets/nostrudel-5.png b/src/service-guides/nostr/assets/nostrudel-5.png new file mode 100644 index 0000000..1697c8b Binary files /dev/null and b/src/service-guides/nostr/assets/nostrudel-5.png differ diff --git a/src/service-guides/nostr/assets/nostrudel-6.png b/src/service-guides/nostr/assets/nostrudel-6.png new file mode 100644 index 0000000..83e4abf Binary files /dev/null and b/src/service-guides/nostr/assets/nostrudel-6.png differ diff --git a/src/service-guides/nostr/assets/nostrudel-7.png b/src/service-guides/nostr/assets/nostrudel-7.png new file mode 100644 index 0000000..adee47a Binary files /dev/null and b/src/service-guides/nostr/assets/nostrudel-7.png differ diff --git a/src/service-guides/nostr/nostr-rs-relay.md b/src/service-guides/nostr/nostr-rs-relay.md new file mode 100644 index 0000000..c87c453 --- /dev/null +++ b/src/service-guides/nostr/nostr-rs-relay.md @@ -0,0 +1,43 @@ +# Nostr RS Relay + + +Nostr is a simple, open protocol that enables global, decentralized, and censorship-resistant social media. + +```admonish 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 + +1. Install **Nostr RS relay** service from Start9 Registry on your server. + + ![nostr install](./assets/nostr-1.png) + + +1. In the service, page click **CONFIGURE** and add the pubkey in hex format to whitelist your client. Click save. + + ![nostr whitelist pubkey](./assets/nostr-2.png) + + +1. 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](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. + +``` +sudo podman exec nostr.embassy sqlite3 /data/nostr.db "SELECT content FROM event;" | grep -o 'content":"[^"]*' | awk -F: '{print $1":"$2}' +``` diff --git a/src/service-guides/nostr/nostrudel.md b/src/service-guides/nostr/nostrudel.md new file mode 100644 index 0000000..538d8ea --- /dev/null +++ b/src/service-guides/nostr/nostrudel.md @@ -0,0 +1,42 @@ +# noStrudel + +noStrudel is a web app for exploring the nostr protocol. + +## Using noStrudel on StartOS + +1. Install the noStrudel service from the Start9 registry on your server. + + ![install](./assets/nostrudel-1.png) + + +1. Click "Start". + + ![start](./assets/nostrudel-2.png) + + +1. When the service is ready click "Launch UI" to access noStrudel. + + ![launch](./assets/nostrudel-3.png) + + +1. Choose how to setup your relays and create a new account or access an existing account by using a nip-07 browser extension. If creating a new account, be sure to securely back up the private key, preferably using Vaultwarden on StartOS. + + ![sign in](./assets/nostrudel-4.png) + +1. To connect to your own private relay, go to Relays -> App Relays, paste in your Nostr Relay Websocket URL (e.g. ws://address.onion) and click add. You can find this value in the Properties section of your Nostr RS Relay service. + + ```admonish note + + If you plan to connect to your own private relay, you must use [Tor browser](https://www.torproject.org/) or [run Tor](/user-manual/connecting-remotely.md) on your system. We recommend using Firefox which must be [configured to use Tor](/misc-guides/firefox-guides/tor.md). + 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. + + ``` + + ![add relay](./assets/nostrudel-5.png) + + +1. To connect to your LND instance using [NWC](https://marketplace.start9.com/marketplace/nostr-wallet-connect) (Nostr Wallet Connect) for LN payments, go to Settings -> Lightning -> Connect wallet. Choose NWC and paste your pairing secret. + + ![connect wallet](./assets/nostrudel-6.png) + + diff --git a/src/service-guides/vaultwarden/README.md b/src/service-guides/vaultwarden/README.md new file mode 100644 index 0000000..f0d24ce --- /dev/null +++ b/src/service-guides/vaultwarden/README.md @@ -0,0 +1 @@ +# Vaultwarden