diff --git a/README.md b/README.md index d21bb2c4..c80f4595 100644 --- a/README.md +++ b/README.md @@ -2,14 +2,14 @@

Stoat Backend - [![Stars](https://img.shields.io/github/stars/revoltchat/backend?style=flat-square&logoColor=white)](https://github.com/revoltchat/backend/stargazers) - [![Forks](https://img.shields.io/github/forks/revoltchat/backend?style=flat-square&logoColor=white)](https://github.com/revoltchat/backend/network/members) - [![Pull Requests](https://img.shields.io/github/issues-pr/revoltchat/backend?style=flat-square&logoColor=white)](https://github.com/revoltchat/backend/pulls) - [![Issues](https://img.shields.io/github/issues/revoltchat/backend?style=flat-square&logoColor=white)](https://github.com/revoltchat/backend/issues) - [![Contributors](https://img.shields.io/github/contributors/revoltchat/backend?style=flat-square&logoColor=white)](https://github.com/revoltchat/backend/graphs/contributors) - [![License](https://img.shields.io/github/license/revoltchat/backend?style=flat-square&logoColor=white)](https://github.com/revoltchat/backend/blob/main/LICENSE) + [![Stars](https://img.shields.io/github/stars/stoatchat/stoatchat?style=flat-square&logoColor=white)](https://github.com/stoatchat/stoatchat/stargazers) + [![Forks](https://img.shields.io/github/forks/stoatchat/stoatchat?style=flat-square&logoColor=white)](https://github.com/stoatchat/stoatchat/network/members) + [![Pull Requests](https://img.shields.io/github/issues-pr/stoatchat/stoatchat?style=flat-square&logoColor=white)](https://github.com/stoatchat/stoatchat/pulls) + [![Issues](https://img.shields.io/github/issues/stoatchat/stoatchat?style=flat-square&logoColor=white)](https://github.com/stoatchat/stoatchat/issues) + [![Contributors](https://img.shields.io/github/contributors/stoatchat/stoatchat?style=flat-square&logoColor=white)](https://github.com/stoatchat/stoatchat/graphs/contributors) + [![License](https://img.shields.io/github/license/stoatchat/stoatchat?style=flat-square&logoColor=white)](https://github.com/stoatchat/stoatchat/blob/main/LICENSE)

-The services and libraries that power the Revolt service.
+The services and libraries that power the Stoat service.

| Crate | Path | Description | | @@ -39,7 +39,7 @@ Rust 1.86.0 or higher. ## Development Guide -Before contributing, make yourself familiar with [our contribution guidelines](https://developers.revolt.chat/contrib.html) and the [technical documentation for this project](https://revoltchat.github.io/backend/). +Before contributing, make yourself familiar with [our contribution guidelines](https://developers.stoat.chat/developing/contrib/) and the [technical documentation for this project](https://stoatchat.github.io/stoatchat/). Before getting started, you'll want to install: @@ -70,8 +70,8 @@ As a heads-up, the development environment uses the following ports: Now you can clone and build the project: ```bash -git clone https://github.com/revoltchat/backend revolt-backend -cd revolt-backend +git clone https://github.com/stoatchat/stoatchat stoat-backend +cd stoat-backend mise build ``` @@ -158,16 +158,11 @@ You can start a web client by doing the following: corepack enable # clone the web client and run it: -git clone --recursive https://github.com/revoltchat/revite -cd revite -yarn -yarn build:deps -echo "VITE_API_URL=http://local.revolt.chat:14702" > .env.local -yarn dev --port 14701 +git clone --recursive https://github.com/stoatchat/for-web stoat-web +cd stoat-web +# refer to stoat-web/README.md for startup, creating an account and loging in ``` -Then go to http://local.revolt.chat:14701 to create an account/login. - When signing up, go to http://localhost:14080 to find confirmation/password reset emails. ## Deployment Guide @@ -198,7 +193,7 @@ Tag and push a new release by running: just release ``` -If you have bumped the crate versions, proceed to [GitHub releases](https://github.com/revoltchat/backend/releases/new) to create a changelog. +If you have bumped the crate versions, proceed to [GitHub releases](https://github.com/stoatchat/stoatchat/releases/new) to create a changelog. ## Testing @@ -217,6 +212,6 @@ TEST_DB=MONGODB cargo nextest run ## License -The Revolt backend is generally licensed under the [GNU Affero General Public License v3.0](https://github.com/revoltchat/backend/blob/master/LICENSE). +The Stoat backend is generally licensed under the [GNU Affero General Public License v3.0](https://github.com/stoatchat/stoatchat/blob/master/LICENSE). **Individual crates may supply their own licenses!** diff --git a/Revolt.toml b/Revolt.toml index 0a824e2d..7398ed53 100644 --- a/Revolt.toml +++ b/Revolt.toml @@ -15,7 +15,7 @@ host = "127.0.0.1" [hosts] # Web locations of various services # Defaults assume all services are reverse-proxied -# See https://github.com/revoltchat/self-hosted/blob/master/Caddyfile +# See https://github.com/stoatchat/self-hosted/blob/main/Caddyfile # # Remember to change these to https/wss where appropriate in production! app = "http://local.revolt.chat:14701" diff --git a/crates/core/config/Revolt.toml b/crates/core/config/Revolt.toml index 13028ccc..a64778c4 100644 --- a/crates/core/config/Revolt.toml +++ b/crates/core/config/Revolt.toml @@ -11,7 +11,7 @@ redis = "redis://redis/" [hosts] # Web locations of various services # Defaults assume all services are reverse-proxied -# See https://github.com/revoltchat/self-hosted/blob/master/Caddyfile +# See https://github.com/stoatchat/self-hosted/blob/main/Caddyfile # # Remember to change these to https/wss where appropriate in production! app = "http://local.revolt.chat" @@ -34,7 +34,7 @@ password = "rabbitpass" [api.registration] # Whether an invite should be required for registration -# See https://github.com/revoltchat/self-hosted#making-your-instance-invite-only +# See https://github.com/stoatchat/self-hosted#making-your-instance-invite-only invite_only = false [api.smtp] diff --git a/crates/core/database/templates/deletion.whitelabel.txt b/crates/core/database/templates/deletion.whitelabel.txt index 3447b351..b040a51e 100644 --- a/crates/core/database/templates/deletion.whitelabel.txt +++ b/crates/core/database/templates/deletion.whitelabel.txt @@ -6,4 +6,4 @@ This email is intended for {{email}} This email has no association with Stoat or Revolt Platforms Ltd. Learn more about third party instances here: -https://developers.stoat.chat/faq.html +https://developers.stoat.chat/faq/ diff --git a/crates/core/database/templates/reset.whitelabel.txt b/crates/core/database/templates/reset.whitelabel.txt index b8c4adc9..10e8ca2d 100644 --- a/crates/core/database/templates/reset.whitelabel.txt +++ b/crates/core/database/templates/reset.whitelabel.txt @@ -6,4 +6,4 @@ This email is intended for {{email}} This email has no association with Stoat or Revolt Platforms Ltd. Learn more about third party instances here: -https://developers.revolt.chat/faq.html +https://developers.stoat.chat/faq/ diff --git a/crates/core/database/templates/suspension.html b/crates/core/database/templates/suspension.html index 2e4c2298..27b7331e 100644 --- a/crates/core/database/templates/suspension.html +++ b/crates/core/database/templates/suspension.html @@ -107,7 +107,7 @@

Further violations may result in a permanent ban depending on severity, please abide by the - Acceptable Usage Policy. + Community Guidelines.

diff --git a/crates/core/database/templates/suspension.txt b/crates/core/database/templates/suspension.txt index d247eae3..293f8a0c 100644 --- a/crates/core/database/templates/suspension.txt +++ b/crates/core/database/templates/suspension.txt @@ -3,7 +3,7 @@ Your account has been suspended, for one or more reasons: You will be able to use your account again in {{duration}} days. -Further violations may result in a permanent ban depending on severity, please abide by the Acceptable Usage Policy (https://revolt.chat/aup). +Further violations may result in a permanent ban depending on severity, please abide by the Community Guidelines (https://stoat.chat/legal/community-guidelines). Ban evasion is prohibited and will be dealt with accordingly. diff --git a/crates/core/database/templates/suspension.whitelabel.txt b/crates/core/database/templates/suspension.whitelabel.txt index 45d9aa56..bd82145d 100644 --- a/crates/core/database/templates/suspension.whitelabel.txt +++ b/crates/core/database/templates/suspension.whitelabel.txt @@ -3,6 +3,6 @@ Your account has been suspended, for one or more reasons: This email is intended for {{email}} -This email has no association with Revolt or Revolt Platforms Ltd. +This email has no association with Stoat or Revolt Platforms Ltd. Learn more about third party instances here: -https://developers.revolt.chat/faq.html +https://developers.stoat.chat/faq/ diff --git a/crates/core/database/templates/verify.whitelabel.txt b/crates/core/database/templates/verify.whitelabel.txt index 547128b9..16f1c4b1 100644 --- a/crates/core/database/templates/verify.whitelabel.txt +++ b/crates/core/database/templates/verify.whitelabel.txt @@ -7,4 +7,4 @@ This email is intended for {{email}} This email has no association with Stoat or Revolt Platforms Ltd. Learn more about third party instances here: -https://developers.revolt.chat/faq.html +https://developers.stoat.chat/faq/ diff --git a/docs/docs/developers/endpoints.md b/docs/docs/developers/endpoints.md index b22c64e2..a89b4d3e 100644 --- a/docs/docs/developers/endpoints.md +++ b/docs/docs/developers/endpoints.md @@ -8,16 +8,12 @@ sidebar_position: 1 You can connect to the API on the following URLs: -| URL | Release | Description | -| ----------------------------- | :--------: | --------------------------- | -| `https://api.revolt.chat` | Production | Primary API endpoint | -| `https://app.revolt.chat/api` | Production | API endpoint for old client | -| `https://revolt.chat/api` | Staging | API endpoint for new client | +| URL | Release | Description | +| ----------------------------- | :--------: | ---------------------------------- | +| `https://api.stoat.chat` | Production | Primary API endpoint | You can connect to the events server on the following URLs: -| URL | Release | Description | -| ------------------------------ | :--------: | ------------------------------ | -| `wss://ws.revolt.chat` | Production | Primary events endpoint | -| `wss://app.revolt.chat/events` | Production | Events endpoint for old client | -| `wss://revolt.chat/events` | Staging | Events endpoint for new client | +| URL | Release | Description | +| ------------------------------ | :--------: | ------------------------------------- | +| `wss://events.stoat.chat` | Production | Primary events endpoint | diff --git a/docs/docs/developers/legacy-plugin-api.md b/docs/docs/developers/legacy-plugin-api.md index ac5c58fc..d2c452c8 100644 --- a/docs/docs/developers/legacy-plugin-api.md +++ b/docs/docs/developers/legacy-plugin-api.md @@ -10,7 +10,7 @@ The Plugin API is very powerful. **Tread carefully.** **Zero guarantees or sandboxes are provided.** Your code is run as-is. ::: -This document details the very experimental plugin API available in [Revite](https://github.com/revoltchat/revite). +This document details the very experimental plugin API available in [Revite](https://github.com/stoatchat/for-legacy-web). This is more or less a proof of concept but can be used to achieve some simple client modifications. diff --git a/docs/docs/developing/backend/new_features.md b/docs/docs/developing/backend/new_features.md index c9517180..029e1325 100644 --- a/docs/docs/developing/backend/new_features.md +++ b/docs/docs/developing/backend/new_features.md @@ -4,12 +4,12 @@ New API features must be documented where appropriate, this document aims to cov Before writing new API features, generally a good idea to: -- Consult with other developers in the [Revolt Developers space](https://rvlt.gg/API) +- Consult with other developers in the [Stoat Developers space](https://stt.gg/API) - If it's a relatively big feature, also [write an RFC](https://github.com/revoltchat/rfcs) When your feature is ready to release, ensure to: - Update backend documentation (what you're reading now!) if applicable -- Update the [developers documentation](https://github.com/revoltchat/wiki) if applicable +- Update the [developers documentation](https://github.com/stoatchat/developer-wiki) if applicable - Update the Feature Matrix (or ask someone that can to do so) - Ensure it is properly listed in the backend release changelog