Getting started

• Run byro for an organization: The installation guide covers byroctl (recommended), Docker Compose and bare-metal installations.

• Use an existing installation: The user guide covers members, fees, finances, documents and communication.

• Extend or improve byro: Start with the API and plugin documentation or contributing.

Features

• Manage members, memberships and recurring fees.

• Record and match payments; the official bank-file importer supports CAMT.053 and MT940.

• Create documents, review and send mail, and keep member balances transparent.

• Let members manage selected data and interact through the member area.

• Protect Office accounts with multi-factor authentication.

• Adapt byro through plugins and use its REST API for integrations.

Plugins

Plugins are Python packages that extend byro with importers, member data, documents or whole features. Administrators can install the compatible official plugins listed in the plugin catalog; see plugin management for their installation and maintenance. The plugin development documentation explains how to build one.

The GitHub byro-plugin topic is a place to discover community plugins, not an endorsement; byroctl never installs entries from it automatically.

Contributing

Contributions to byro, its documentation and its plugins are welcome. See the contributor documentation for the development setup and contribution workflow.

License

byro is licensed under the GNU Affero General Public License, version 3.0 only (AGPL-3.0-only). Older versions of byro were released under the Apache License 2.0. The documentation in docs/ is licensed under the Creative Commons Attribution-ShareAlike 4.0 International License (CC-BY-SA-4.0). See the LICENSE file for details, including the licensing history and the licenses of bundled third-party components.