From c33aefd0f5fbfa6b271f1757bc298aabcce133dc Mon Sep 17 00:00:00 2001 From: b <> Date: Thu, 6 Mar 2025 13:53:33 +0000 Subject: [PATCH] fix: readme --- README.md | 31 +++++++++---------------------- 1 file changed, 9 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index 6592cea..8f96d2c 100644 --- a/README.md +++ b/README.md @@ -1,36 +1,23 @@ # strfry-cloudron -[strfry - a nostr relay](https://github.com/hoytech/strfry) packaged to run as a [cloudron](https://www.cloudron.io/)app. Supports event policies through the [chief plugin](https://github.com/0xtrr/chief/tree/master). +[strfry - a nostr relay](https://github.com/hoytech/strfry) packaged to run as a [cloudron](https://www.cloudron.io/) app. Supports event policies through the [chief plugin](https://github.com/0xtrr/chief/tree/master). The app is [not yet in the Cloudron App Store](https://forum.cloudron.io/topic/12056/strfry-a-nostr-relay) so for now you have to use the Cloudron CLI to install. ### Prerequisites Install the [Cloudron CLI](https://docs.cloudron.io/packaging/cli/) - `npm install -g cloudron` -### Installing +### Installation -**Authenticate the CLI with your Cloudron instance** -``` +```bash +# Authenticate the CLI with your Cloudron instance cloudron login your.instance.com -``` -**Clone the project and change into it** -``` -git clone https://github.com/sebdeveloper6952/strfry-cloudron.git +# Clone the project and change into it +git clone https://git.nostrdev.com/stuff/strfry-cloudron cd strfry-cloudron + +# Install latest version +cloudron install --image git.nostrdev.com/stuff/strfry-cloudron:latest -l strfry.YOURDOMAIN.com ``` -**Install the app** - -Requires the latest package version hash from [this page](https://github.com/sebdeveloper6952/strfry-cloudron/pkgs/container/strfry-cloudron) -``` -cloudron install --image ghcr.io/sebdeveloper6952/strfry-cloudron: -cloudron install --image ghcr.io/sebdeveloper6952/strfry-cloudron:sha256-1440e0d1c812504ab707515fb174b8d8dfc403bfd1398107c20df50311031f2b -l artclock-relay.nostrdev.com -``` - -For example: -``` -cloudron install --image ghcr.io/sebdeveloper6952/strfry-cloudron:d7593aea5ac40baa84ef27cd78cca218c0fdf195 -``` - -You will then be prompted for a location - so put the domain, eg `strfry.yourdomain.com`