bromal/bromal
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
No description
290 commits 8 branches 0 tags 3.5 MiB
Find a file
Exact
Igorj Gorjaĉev 7f0ff7fa7c
 interfaces rename
2025-11-06 21:10:28 +02:00
config interfaces rename 2025-11-06 21:10:28 +02:00
lib interfaces rename 2025-11-06 21:10:28 +02:00
priv interfaces rename 2025-11-06 21:10:28 +02:00
test interfaces rename 2025-11-06 21:10:28 +02:00
.formatter.exs add sources 2023-09-28 12:48:06 +03:00
.gitignore fix media upload 2024-04-24 17:52:46 +03:00
AUTHORS big project rework 2024-03-14 13:37:14 +02:00
LICENSE add sources 2023-09-28 12:48:06 +03:00
mix.exs refactor routers, implement all-in-one endpoint 2025-10-31 23:03:19 +02:00
mix.lock config: add support for env vars 2025-10-31 15:08:37 +02:00
README.org various housekeeping tasks 2025-10-31 23:16:49 +02:00

README.org

Bromal

Overview

Bromal is a lightweight Matrix homeserver.

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 compile

Run 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 test

Under 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
;; TODO

License

This software is licensed under the AGPLv3 or later. Please consult the LICENSE file for more details.