dbacb4fc9f
All checks were successful
Release to Gitea Container Registry / build_and_push (push) Successful in 6s
63 lines
1.5 KiB
Markdown
63 lines
1.5 KiB
Markdown
# 🌸 Blossom-server
|
|
|
|
[Blossom Server](https://git.nostrdev.com/stuff/blossom-cloudron) packaged to run as a [cloudron](https://www.cloudron.io/)app. Supports policies through the `/app/data/config.yaml` file.
|
|
|
|
The app is [not yet in the Cloudron App Store](https://forum.cloudron.io/topic/12741/blossom-server-package), 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
|
|
|
|
```
|
|
# Login with your cloudron credentials
|
|
cloudron login your.instance.com
|
|
|
|
# Clone the project and change into it
|
|
git clone https://git.nostrdev.com/stuff/blossom-cloudron
|
|
cd blossom-cloudron
|
|
|
|
# Install latest version
|
|
cloudron install --image git.nostrdev.com/stuff/blossom-cloudron:latest -l blossom.YOURDOMAIN.com
|
|
```
|
|
|
|
To update, the command would be:
|
|
|
|
```
|
|
cloudron update --app blossom.YOURDOMAIN.com --image git.nostrdev.com/stuff/blossom-cloudron:latest
|
|
```
|
|
|
|
|
|
## Configuration
|
|
|
|
The config file is under `/app/data/config.yml`
|
|
|
|
If you are using Blossom for a small subset of npubs, and don't need the discoverability feature, you could make the following changes:
|
|
|
|
```
|
|
discovery:
|
|
# find files by querying nostr relays
|
|
nostr:
|
|
enabled: false
|
|
```
|
|
|
|
and
|
|
|
|
```
|
|
rules:
|
|
# mime type of blob
|
|
- type: "*"
|
|
expiration: 2 years
|
|
pubkeys:
|
|
- "xxxnostrHEXkeyxxx" # comment
|
|
```
|
|
|
|
and
|
|
|
|
```
|
|
upload:
|
|
# only check rules that include "pubkeys"
|
|
requirePubkeyInRule: true
|
|
```
|