strfry-cloudron/README.md
b c33aefd0f5
All checks were successful
Release to Gitea Container Registry / build_and_push (push) Successful in 4m26s
fix: readme
2025-03-06 13:53:33 +00:00

24 lines
871 B
Markdown

# 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).
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`
### Installation
```bash
# Authenticate the CLI with your Cloudron instance
cloudron login your.instance.com
# 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
```