diff --git a/docs/index.mdx b/docs/index.mdx index b50ccd97d..a4ba613ea 100644 --- a/docs/index.mdx +++ b/docs/index.mdx @@ -34,17 +34,3 @@ doc: false --- - -## What is Continuwuity? - -Continuwuity is a Matrix homeserver. - -Matrix is an open chat network that lets anyone talk to anyone, no matter what server or address they use - sort of like email. - -Continuwuity receives and keeps track of all your messages, and delivers what you send to the right people. - -## Why is Continuwuity different? - -Continuwuity is light and fast, using a fraction of the memory of other major homeservers. It's also simple to set up, and secure by default. - -We are a community run project, filled with diverse and friendly people. Everything is built by people who care about the project volunteering their free time. diff --git a/docs/introduction.mdx b/docs/introduction.mdx index b413e7e8b..d28d7b29f 100644 --- a/docs/introduction.mdx +++ b/docs/introduction.mdx @@ -1,98 +1,21 @@ # Continuwuity -## A community-driven [Matrix](https://matrix.org/) homeserver in Rust +## What is Continuwuity? -[![Chat on Matrix](https://img.shields.io/matrix/continuwuity%3Acontinuwuity.org?server_fqdn=matrix.continuwuity.org&fetchMode=summary&logo=matrix)](https://matrix.to/#/#continuwuity:continuwuity.org?via=continuwuity.org&via=ellis.link&via=explodie.org&via=matrix.org) [![Join the space](https://img.shields.io/matrix/space%3Acontinuwuity.org?server_fqdn=matrix.continuwuity.org&fetchMode=summary&logo=matrix&label=space)](https://matrix.to/#/#space:continuwuity.org?via=continuwuity.org&via=ellis.link&via=explodie.org&via=matrix.org) +Continuwuity is a Matrix homeserver. -[continuwuity] is a Matrix homeserver written in Rust. -It's the official community continuation of the [conduwuit](https://github.com/girlbossceo/conduwuit) homeserver. +[Matrix] is an open chat network that lets anyone talk to anyone, no matter what server or address they use - sort of like email. -[![forgejo.ellis.link](https://img.shields.io/badge/Ellis%20Git-main+packages-green?style=flat&logo=forgejo&labelColor=fff)](https://forgejo.ellis.link/continuwuation/continuwuity) [![Stars](https://forgejo.ellis.link/continuwuation/continuwuity/badges/stars.svg?style=flat)](https://forgejo.ellis.link/continuwuation/continuwuity/stars) [![Issues](https://forgejo.ellis.link/continuwuation/continuwuity/badges/issues/open.svg?style=flat)](https://forgejo.ellis.link/continuwuation/continuwuity/issues?state=open) [![Pull Requests](https://forgejo.ellis.link/continuwuation/continuwuity/badges/pulls/open.svg?style=flat)](https://forgejo.ellis.link/continuwuation/continuwuity/pulls?state=open) +Continuwuity receives and keeps track of all your messages, and delivers what you send to the right people. -[![GitHub](https://img.shields.io/badge/GitHub-mirror-blue?style=flat&logo=github&labelColor=fff&logoColor=24292f)](https://github.com/continuwuity/continuwuity) [![Stars](https://img.shields.io/github/stars/continuwuity/continuwuity?style=flat)](https://github.com/continuwuity/continuwuity/stargazers) +[Matrix]: https://matrix.org -[![GitLab](https://img.shields.io/badge/GitLab-mirror-blue?style=flat&logo=gitlab&labelColor=fff)](https://gitlab.com/continuwuity/continuwuity) [![Stars](https://img.shields.io/gitlab/stars/continuwuity/continuwuity?style=flat)](https://gitlab.com/continuwuity/continuwuity/-/starrers) +## Why is Continuwuity different? -[![Codeberg](https://img.shields.io/badge/Codeberg-mirror-2185D0?style=flat&logo=codeberg&labelColor=fff)](https://codeberg.org/continuwuity/continuwuity) [![Stars](https://codeberg.org/continuwuity/continuwuity/badges/stars.svg?style=flat)](https://codeberg.org/continuwuity/continuwuity/stars) +Continuwuity is light and fast, using a fraction of the memory of other major homeservers. It's also simple to set up, and secure by default. -## Why does this exist? +We are a community run project, filled with diverse and friendly people. Everything is built by people who care about the project volunteering their free time. -The original conduwuit project has been archived and is no longer maintained. Rather than letting this Rust-based Matrix homeserver disappear, a group of community contributors have forked the project to continue its development, fix outstanding issues, and add new features. +## Deploying Continuwuity -We aim to provide a stable, well-maintained alternative for current conduwuit users and welcome newcomers seeking a lightweight, efficient Matrix homeserver. - -## Who are we? - -We are a group of Matrix enthusiasts, developers and system administrators who have used conduwuit and believe in its potential. Our team includes both previous -contributors to the original project and new developers who want to help maintain and improve this important piece of Matrix infrastructure. - -We operate as an open community project, welcoming contributions from anyone interested in improving continuwuity. - -## What is Matrix? - -[Matrix](https://matrix.org) is an open, federated, and extensible network for -decentralized communication. Users from any Matrix homeserver can chat with users from all -other homeservers over federation. Matrix is designed to be extensible and built on top of. -You can even use bridges such as Matrix Appservices to communicate with users outside of Matrix, like a community on Discord. - -## What are the project's goals? - -continuwuity aims to: - -- Maintain a stable, reliable Matrix homeserver implementation in Rust -- Improve compatibility and specification compliance with the Matrix protocol -- Fix bugs and performance issues from the original conduwuit -- Add missing features needed by homeserver administrators -- Provide comprehensive documentation and easy deployment options -- Create a sustainable development model for long-term maintenance -- Keep a lightweight, efficient codebase that can run on modest hardware - -## Can I try it out? - -Check out the [documentation](https://continuwuity.org) for installation instructions. - -If you want to try it out as a user, we have some partnered homeservers you can use: -* You can head over to [https://federated.nexus](https://federated.nexus/) in your browser. - * Hit the `Apply to Join` button. Once your request has been accepted, you will receive an email with your username and password. - * Head over to [https://app.federated.nexus](https://app.federated.nexus/) and you can sign in there, or use any other matrix chat client you wish elsewhere. - * Your username for matrix will be in the form of `@username:federated.nexus`, however you can simply use the `username` part to log in. Your password is your password. - -* There's also [https://continuwuity.rocks/](https://continuwuity.rocks/). You can register a new account using Cinny via [this convenient link](https://app.cinny.in/register/continuwuity.rocks), or you can use Element or another matrix client *that supports registration*. - -## What are we working on? - -We're working our way through all of the issues in the [Forgejo project](https://forgejo.ellis.link/continuwuation/continuwuity/issues). - -- [Packaging & availability in more places](https://forgejo.ellis.link/continuwuation/continuwuity/issues/747) -- [Appservices bugs & features](https://forgejo.ellis.link/continuwuation/continuwuity/issues?q=&type=all&state=open&labels=178&milestone=0&assignee=0&poster=0) -- [Improving compatibility and spec compliance](https://forgejo.ellis.link/continuwuation/continuwuity/issues?labels=119) -- Automated testing -- [Admin API](https://forgejo.ellis.link/continuwuation/continuwuity/issues/748) -- [Policy-list controlled moderation](https://forgejo.ellis.link/continuwuation/continuwuity/issues/750) - -## Can I migrate my data from x? - -- **Conduwuit**: Yes -- **Conduit**: No, database is now incompatible -- **Grapevine**: No, database is now incompatible -- **Dendrite**: No -- **Synapse**: No - -We haven't written up a guide on migrating from incompatible homeservers yet. Reach out to us if you need to do this! - -## How can I deploy my own? - -- [Deployment options](deploying) - -If you want to connect an appservice to continuwuity, take a look at the -[appservices documentation](appservices). - -## How can I contribute? - -See the [contributor's guide](development/contributing) - -## Contact - -Join our [Matrix room](https://matrix.to/#/#continuwuity:continuwuity.org?via=continuwuity.org&via=ellis.link&via=explodie.org&via=matrix.org) and [space](https://matrix.to/#/#space:continuwuity.org?via=continuwuity.org&via=ellis.link&via=explodie.org&via=matrix.org) to chat with us about the project! - -[continuwuity]: https://forgejo.ellis.link/continuwuation/continuwuity +Head over to the [Deploying chapter](./deploying.mdx) to get started.