mirror of
https://github.com/girlbossceo/conduwuit.git
synced 2024-11-26 07:34:25 +00:00
94 lines
3.9 KiB
Markdown
94 lines
3.9 KiB
Markdown
# conduwuit
|
|
### a well maintained fork of [Conduit](https://conduit.rs/)
|
|
|
|
[](https://github.com/girlbossceo/conduwuit/actions/workflows/ci.yml)
|
|
|
|
#### What is Matrix?
|
|
[Matrix](https://matrix.org) 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](https://element.transfem.dev) / [cinny.transfem.dev](https://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](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.
|
|
|
|
- Simple install (this was tested the most): [DEPLOY.md](DEPLOY.md)
|
|
- Nix/NixOS (and binary cache): [nix/README.md](nix/README.md)
|
|
|
|
If you want to connect an Appservice to Conduit, take a look at [APPSERVICES.md](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](https://matrix.to/#/#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
|
|
- Ask us in `#conduwuit:puppygock.gay` on Matrix
|
|
- [Open an issue on GitHub](https://github.com/girlbossceo/conduwuit/issues/new)
|
|
|
|
#### Donate
|
|
|
|
Liberapay: <https://liberapay.com/girlbossceo>\
|
|
Ko-fi: <https://ko-fi.com/puppygock>\
|
|
GitHub Sponsors: <https://github.com/sponsors/girlbossceo>
|
|
|
|
#### Logo
|
|
|
|
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>
|