Sblurp

Configuration

Every flag can also come from an environment variable. A flag on the command line wins over the variable.

Server flags

Flag and variable Default What
-addr SBLURP_ADDR :8082 Listen address. HTTP/1.1 and cleartext HTTP/2 (h2c). The container image sets :8080.
-data SBLURP_DATA data Data folder: sblurp.db, files/, file-key, plugins/. The container image sets /data.
-name SBLURP_NAME Sblurp Community Community name.
-description SBLURP_DESCRIPTION the seed's text One line for the join screen. Admins can replace it with Markdown in Community settings.
-icon-url SBLURP_ICON_URL Rail icon, unless an admin uploads one.
-accent SBLURP_ACCENT the seed's color #rrggbb for the rail icon.
-base-url SBLURP_BASE_URL required Public URL, such as https://chat.example.com. Also the audience of sign-in tokens.
-web-url SBLURP_WEB_URL https://app.sblurp.chat The web client. Invite links send browsers there.
-trusted-issuer SBLURP_TRUSTED_ISSUERS https://sblurp.chat Login issuers to accept. Repeat the flag for more, or separate them with commas in the variable.
-seed SBLURP_SEED community or owls. Fills an empty database with demo data. Ignored once the database has members.
-bot-rate SBLURP_BOT_RATE 0 (no limit) Messages per second a bot may send.
-bot-burst SBLURP_BOT_BURST 20 Burst size for bots.

Update check

Env Default What
SBLURP_TRACK set at build: stable, beta or nightly The release track the update check follows.
SBLURP_UPDATE_URL set at build The release manifest, releases.json. Empty in local builds, which turns the check off.
SBLURP_UPDATE_CHECK on off stops the daily check.

See Updates and tracks.

Container backups

The container image reads these. Without AWS_ACCESS_KEY_ID it runs the server alone, with no backups.

Env What
AWS_ACCESS_KEY_ID R2 access key ID.
AWS_SECRET_ACCESS_KEY R2 secret access key.
R2_ENDPOINT https://ACCOUNT_ID.r2.cloudflarestorage.com
R2_BUCKET Bucket name, such as sblurp-backups.
BACKUP_PASSWORD Encrypts the file backups. Keep it in a password manager.
BACKUP_NAME Folder in the bucket for this community. Default community.

Compose only

Env What
SBLURP_DOMAIN The name Caddy gets a certificate for.
SBLURP_TAG Image tag: stable, beta, nightly or a version such as 1.2.3.

Built-in limits

These are not settings. They are listed here so you know what to expect.

Limit Value
Messages from a person 5 per second, burst 10
Message length 8,000 characters
Attachments per message 10
Upload size 25 MB
Banner, icon and header images 8 MB; PNG, JPEG, GIF, WebP or AVIF
Custom emoji 256 KB and 512x512 each; 64 MB per upload request
Community description 2,000 characters of Markdown
Channel topic 500 characters
Different reactions per message 50
People in a DM you and up to 8 others
Unsent uploads deleted after a day
Event history kept newest 10,000 events, or 7 days, whichever is more
Plugin memory and time 32 MB, 1 second per call