Go to file
Samuel Meenzen 623478fa2d chore: add EditorConfig
Signed-off-by: strawberry <strawberry@puppygock.gay>
2024-03-16 00:09:48 -04:00
.gitea bit of repo cleanup 2024-01-31 21:12:09 -05:00
.github/workflows bump CI deps (CVE-2024-27297 / GHSA-2ffj-w4mj-pg37) 2024-03-08 12:51:21 -05:00
.gitlab/merge_request_templates add cargo clippy 2024-01-25 19:28:33 -05:00
.vscode remove deprecated recommended vscode extension 2023-12-20 23:03:18 -05:00
bin add back more verbose nix build logging (`-L`) 2024-03-08 12:51:21 -05:00
complement add support for dual HTTP/HTTPS, rm caddy from complement 2024-02-26 00:40:15 -05:00
debian attempt to use example config for debian package 2024-03-16 00:09:48 -04:00
docker partially make other docker compose files consistent 2024-03-08 12:51:21 -05:00
nix adjust the nix README a bit 2024-02-28 13:56:19 -05:00
src treat non-appservice registrations as None auth 2024-03-16 00:09:48 -04:00
tests Complement improvements 2022-10-17 18:41:45 +02:00
.dockerignore fix(ci): Only build in (remote host) docker and switch to glibc 2022-11-02 12:12:48 +01:00
.editorconfig chore: add EditorConfig 2024-03-16 00:09:48 -04:00
.envrc ci: cross compile static binaries for x86_64 and aarch64 2024-01-26 19:47:54 -05:00
.git-blame-ignore-revs add .git-blame-ignore-revs 2024-03-08 12:51:21 -05:00
.gitignore add .DS_Store to gitignore (lol) 2024-02-24 13:04:13 -05:00
.gitlab-ci.yml fix(ci): avoid duplicate pipelines 2024-03-16 00:09:48 -04:00
APPSERVICES.md Pre-0.3 doc adjustments 2022-02-04 18:05:24 +01:00
CODE_OF_CONDUCT.md remove nightly only feature, small housekeeping stuff 2023-11-29 21:59:18 -05:00
Cargo.lock bump rust-rocksdb, and transitive deps 2024-03-16 00:09:48 -04:00
Cargo.toml bump rust-rocksdb, and transitive deps 2024-03-16 00:09:48 -04:00
DEPLOY.md link to CI page for artifacts 2024-03-10 13:03:28 -04:00
DIFFERENCES.md update DIFFERENCES.md 2024-03-16 00:09:48 -04:00
LICENSE remove nightly only feature, small housekeeping stuff 2023-11-29 21:59:18 -05:00
README.md update README.md 2024-03-16 00:09:48 -04:00
TURN.md Move appservice howto into whats-next; again, rename placeholder TURN url 2022-02-04 21:11:50 +01:00
conduwuit-example.toml rocksdb_max_log_files must not be 0 2024-03-16 00:09:48 -04:00
default.nix feat: support non-flake users 2024-02-11 21:56:55 -05:00
engage.toml ci: run cargo deb version 2024-03-10 13:03:28 -04:00
flake.lock make CI more efficient (github and gitlab) 2024-03-08 12:51:21 -05:00
flake.nix fix rocksdb hash 2024-03-10 13:03:28 -04:00
renovate.json ignore basically all the http dependencies we cant upgrade to 2024-02-14 09:51:11 -05:00
rust-toolchain.toml document github ci in rust-toolchain.toml 2024-03-10 13:03:28 -04:00
rustfmt.toml add rustfmt.toml, format entire codebase 2024-03-08 12:51:21 -05:00

README.md

conduwuit

a well maintained fork of Conduit

CI and Artifacts

What is Matrix?

Matrix is an open network for secure and decentralized communication. Users from every Matrix homeserver can chat with users from all other Matrix servers. You can even use bridges (also called Matrix Appservices) to communicate with users outside of Matrix, like a community on Discord.

What is the goal?

An efficient Matrix homeserver that's easy to set up and just works. You can install it on a mini-computer like the Raspberry Pi to host Matrix for your family, friends or company.

Can I try it out?

An official conduwuit server ran by me is available at transfem.dev (element.transfem.dev / cinny.transfem.dev)

What is the current status?

conduwuit is a fork of Conduit which is in beta, meaning you can join and participate in most Matrix rooms, but not all features are supported and you might run into bugs from time to time.

There are still a few nice to have features missing that some users may notice:

  • Outgoing read receipts and typing indicators (receiving works)

What's different about your fork than upstream Conduit?

See DIFFERENCES.md

Why does this fork exist? Why don't you contribute back upstream?

I now intend on contributing back as time and mental energy sees fit, but my fork still exists as a way to:

  • avoid unnecessary Matrix and general developer politics
  • avoid bikeshedding unnecessary or irrelevant things in upstream MRs
  • Fast tracked bug fixes, performance improvements, security improvements, and new features
  • Have early access to MRs that may not be suitable/acceptable for Conduit (e.g. too niche, too advanced for general users, only being blocked due to pending on contributor actions that we can fix ourselves downstream, pending Matrix spec stuff, etc)
  • Support unspecced or WIP features
  • Have official support for other OS's like Windows, macOS, and BSD.
  • Have a stable testing ground for some MRs or new features and bug fixes

And various other reasons that may not be listed here.

How can I deploy my own?

conduwuit officially supports Linux, macOS, BSD, and Windows.

If you want to connect an Appservice to Conduit, take a look at APPSERVICES.md.

How can I contribute?

  1. Look for an issue you would like to work on and make sure it's not assigned to other users
  2. Ask someone to assign the issue to you (comment on the issue or chat in #conduwuit:puppygock.gay)
  3. Fork the repo and work on the issue.
  4. Submit a PR (please keep contributions to the GitHub repo, main development is done here, not the GitLab repo which exists just as a mirror. If you are avoiding GitHub, feel free to join our Matrix chat to get your patch in.)

Contact

If you run into any question, feel free to

Donate

Liberapay: https://liberapay.com/girlbossceo
Ko-fi: https://ko-fi.com/puppygock
GitHub Sponsors: https://github.com/sponsors/girlbossceo

No official conduwuit logo exists. Repo and Matrix room picture is from bran (<3).

Is it conduwuit or Conduwuit?

Both.

Mirrors of conduwuit

GitHub: https://github.com/girlbossceo/conduwuit
GitLab: https://gitlab.com/girlbossceo/conduwuit
git.gay: https://git.gay/june/conduwuit
Codeberg: https://codeberg.org/girlbossceo/conduwuit
sourcehut: https://git.sr.ht/~girlbossceo/conduwuit