Skip to content

Installation

byro is free software, which means you can run it yourself on your own server (or your own Raspberry Pi, …). But while this offers you great freedom, it also comes with great responsibility:

Warning

Hosting byro means taking responsibility for your members' personal and financial data. Please make sure that your installation and servers are secure and will be maintained in the future.

There are three ways to install byro:

  1. byroctl (recommended): a small command line tool that sets up byro with Docker Compose, keeps the configuration in one file and installs updates for you. Start here unless you have a reason not to: Installation with byroctl.
  2. Docker Compose by hand: the same container image and Compose files as byroctl, managed with plain docker compose commands. For administrators who run their own Docker environment: Installation with Docker Compose.
  3. Bare metal: byro from PyPI in a Python environment with a PostgreSQL server, gunicorn, systemd and your own reverse proxy. For classic or individual deployments: Bare metal installation.

All three share the same configuration options (Configuration), the same way to add plugins (Plugins), the same maintenance tasks (see Administration) and the same advice: run byro behind HTTPS only, and back up your data.

The following pages document a straightforward setup without going into details on administrative basics like securing your server, or performing backups. Updating, backup and restore, monitoring and the security baseline are covered under Administration once byro is running.

The deprecated production/ setup is described on its own page: Legacy setup with the production/ files.