- Elixir 99.8%
- Dockerfile 0.2%
Igorj Gorjaĉev
103e121039
All checks were successful
run bromal ci pipeline / build and run tests (push) Successful in 4m57s
complement integration tests / run-complement (push) Successful in 13m2s
build and push oci image / build (push) Successful in 3m15s
run bromal ci pipeline / run linters (push) Successful in 5m52s
run bromal ci pipeline / generate sbom (push) Successful in 4m9s
|
||
|---|---|---|
| .forgejo/workflows | ||
| ci | ||
| complement | ||
| config | ||
| docker | ||
| lib | ||
| priv | ||
| test | ||
| .formatter.exs | ||
| .gitignore | ||
| AUTHORS | ||
| LICENSE | ||
| manifest.scm | ||
| mix.exs | ||
| mix.lock | ||
| README.org | ||
Bromal
Overview
Bromal is a lightweight opensource messaging server, that uses the Matrix protocol. It is being developed for the efficient deployment of federated messaging systems with modest resource requirements, as a result, it could be deployed even on small servers, including VPS, without sacrificing essential functionality. The project aims to support server-to-server federation, state resolution for different room versions, end-to-end encryption, a full-featured messaging module, built-in VoIP, automatic TLS certificate acquisition via Let's Encrypt using the ACME protocol, as well as the ability to create a cluster for larger installations.
Fun fact
Bromal is being developed on RISC-V OrangePi RV2 SBC running Guix System.
Current status
This software is under active development. It is half-baked and currently not suitable for any production usage:
- Not suitable for any kind of usage except for hacking.
- Internal architecture is subject to change.
- Lacks most important features.
- Federation is supported, but no PDUs (there is a primary support for it).
- No database migrations; schema changes frequently and suddenly.
- Test coverage is not 100% and may sometimes be outdated.
- Code in various components is not optimal and will be refactored sooner or later.
- etc.
Requirements
Bromal currently depends on the following packages:
- Elixir 1.15+
- Erlang 26+
- PostgreSQL 15+
- ImageMagick (for image manipulation)
Build instructions
mix deps.get
mix compileRun tests
Bromal tests require access to a PostgreSQL database, so it must be properly installed and configured beforehand. Tests can then be executed as usual:
mix testUnder Guix System
Guix System packaging (vendoring support as in Rust packages) currently is baking here: https://codeberg.org/guix/guix/pulls/3524
guix install bromal;; TODOContributions
Contributions are always welcome, however they are always welcome without ANY use of generative AI/LLMs.
Sponsors
Bromal is funded through the NGI0 Commons Fund, a fund established by NLnet with financial support from the European Commission's Next Generation Internet program. Learn more at the NLnet Bromal page.
Many thanks to them! ❤️
License
Bromal is licensed under the AGPLv3 or later. Please consult the LICENSE
file for more details.