Songstead · Documentation
Look after
your place.
Install, run, and recover your Songstead instance. These guides live with the app’s source, so instructions and code can change together.
Install and get started.
- Downloads, checksums, and installation
Choose a release and follow the setup instructions for your system.
- Gentoo overlay
Install through Portage with the supplied native services.
- Build from source or try the local demo
The README is the starting point for the development setup.
Configure and look after it.
- Administration and invitations
Joining, recovery, house rules, and connecting Witmoot.
- Configuration and services
Private storage, owner provisioning, and service operation.
- Optional process isolation
Run Songstead with Bubblewrap.
- HTTPS and deployment
Put a reverse proxy in front of the service before sharing it online.
Back up and recover.
Automatic daily backups are a starting point. Keep a protected copy on another machine and test a restore before you need one.
- Automatic backups
What is included, verification, compression, retention, and checking failures.
- Restore and retention instructions
- Accounts and data
Upgrade with a way back.
Read the release notes and upgrade instructions first. Make a verified backup before installing an update; database migrations can require restoring that backup to go back.
When something needs attention.
Start with the deployment guide for configuration and service setup. If you are stuck, search or open an issue with your app version, installation method, and the relevant error. Remove passwords, tokens, and private community data before sharing logs.