Saveroom documentation¶
Saveroom is an open-source no-code platform: spreadsheet-like databases, an application builder, automations and dashboards on top of PostgreSQL. It is a fully MIT-licensed fork of Baserow.
Start with Architecture for how the pieces fit together, then pick the section that matches what you want to do.
Run Saveroom¶
Pick one install path, then configure and operate it.
| I want to… | Read |
|---|---|
| Try it on one machine | Docker (all-in-one image) |
| Run one container per service with Compose | Docker Compose |
| Run on Kubernetes or OpenShift | Helm, Amazon EKS |
| Use a managed container platform | Standalone images |
| Check versions of PostgreSQL, Redis and others | Supported dependencies |
| Set environment variables | Configuration reference |
| Sign in through an identity provider | OpenID Connect, RHBK/Keycloak |
| Change name, colours and logos | Branding |
| Control who sees what | Workspace access, Turning application types off |
| Back up and restore | Data destinations and backups, Back up and restore |
| Monitor it | Monitoring |
| Fix a broken install or upgrade | Debugging connection issues, Upgrade embedded PostgreSQL, Migrate from a user tables database |
Use Saveroom¶
Integrate through the API¶
- REST API: resources, authentication and the generated API docs.
- WebSocket API: realtime events.
- API clients: scoped credentials for scripts and integrations.
Develop Saveroom¶
- Set up the development environment, either locally or in Docker.
- Learn the
justcommands, the code quality gates and how to run tests, including end-to-end tests. - Read the internals for the area you are changing: database plugin, table persistence, permissions, undo/redo, WebSockets, formulas.
- Follow the patterns for jobs, forms, emails and dates.
Architectural decisions are recorded as ADRs.
Extend with plugins¶
Add field types, view types, filters or whole application types without forking: start with Plugin basics.