jmug/stoatchat
1
0
Fork 1
mirror of https://github.com/stoatchat/stoatchat.git synced 2026-07-06 03:06:04 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix: replace some links and Revolt mentions to current Stoat (#515)

Browse Source
This commit is contained in:
Damocles
2026-03-08 02:28:50 +01:00
committed by GitHub
parent 24d0d2b726
commit d629e89304
12 changed files with 34 additions and 43 deletions
Download Patch File Download Diff File Expand all files Collapse all files

35
README.md
View File

@@ -2,14 +2,14 @@
<h1> <h1>
Stoat Backend Stoat Backend
[![Stars](https://img.shields.io/github/stars/revoltchat/backend?style=flat-square&logoColor=white)](https://github.com/revoltchat/backend/stargazers) [![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/revoltchat/backend?style=flat-square&logoColor=white)](https://github.com/revoltchat/backend/network/members) [![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/revoltchat/backend?style=flat-square&logoColor=white)](https://github.com/revoltchat/backend/pulls) [![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/revoltchat/backend?style=flat-square&logoColor=white)](https://github.com/revoltchat/backend/issues) [![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/revoltchat/backend?style=flat-square&logoColor=white)](https://github.com/revoltchat/backend/graphs/contributors) [![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/revoltchat/backend?style=flat-square&logoColor=white)](https://github.com/revoltchat/backend/blob/main/LICENSE) [![License](https://img.shields.io/github/license/stoatchat/stoatchat?style=flat-square&logoColor=white)](https://github.com/stoatchat/stoatchat/blob/main/LICENSE)
</h1> </h1>
The services and libraries that power the Revolt service.<br/> The services and libraries that power the Stoat service.<br/>
<br/> <br/>
| Crate | Path | Description | | | Crate | Path | Description | |
@@ -39,7 +39,7 @@ Rust 1.86.0 or higher.
## Development Guide ## 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: 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: Now you can clone and build the project:
```bash ```bash
git clone https://github.com/revoltchat/backend revolt-backend git clone https://github.com/stoatchat/stoatchat stoat-backend
cd revolt-backend cd stoat-backend
mise build mise build
``` ```
@@ -158,16 +158,11 @@ You can start a web client by doing the following:
corepack enable corepack enable
# clone the web client and run it: # clone the web client and run it:
git clone --recursive https://github.com/revoltchat/revite git clone --recursive https://github.com/stoatchat/for-web stoat-web
cd revite cd stoat-web
yarn # refer to stoat-web/README.md for startup, creating an account and loging in
yarn build:deps
echo "VITE_API_URL=http://local.revolt.chat:14702" > .env.local
yarn dev --port 14701
``` ```
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. When signing up, go to http://localhost:14080 to find confirmation/password reset emails.
## Deployment Guide ## Deployment Guide
@@ -198,7 +193,7 @@ Tag and push a new release by running:
just release 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 ## Testing
@@ -217,6 +212,6 @@ TEST_DB=MONGODB cargo nextest run
## License ## 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!** **Individual crates may supply their own licenses!**

2
Revolt.toml
View File

@@ -15,7 +15,7 @@ host = "127.0.0.1"
[hosts] [hosts]
# Web locations of various services # Web locations of various services
# Defaults assume all services are reverse-proxied # 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! # Remember to change these to https/wss where appropriate in production!
app = "http://local.revolt.chat:14701" app = "http://local.revolt.chat:14701"

4
crates/core/config/Revolt.toml
View File

@@ -11,7 +11,7 @@ redis = "redis://redis/"
[hosts] [hosts]
# Web locations of various services # Web locations of various services
# Defaults assume all services are reverse-proxied # 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! # Remember to change these to https/wss where appropriate in production!
app = "http://local.revolt.chat" app = "http://local.revolt.chat"
@@ -34,7 +34,7 @@ password = "rabbitpass"
[api.registration] [api.registration]
# Whether an invite should be required for 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 invite_only = false
[api.smtp] [api.smtp]

2
crates/core/database/templates/deletion.whitelabel.txt
View File

@@ -6,4 +6,4 @@ This email is intended for {{email}}
This email has no association with Stoat or Revolt Platforms Ltd. This email has no association with Stoat or Revolt Platforms Ltd.
Learn more about third party instances here: Learn more about third party instances here:
https://developers.stoat.chat/faq.html https://developers.stoat.chat/faq/

2
crates/core/database/templates/reset.whitelabel.txt
View File

@@ -6,4 +6,4 @@ This email is intended for {{email}}
This email has no association with Stoat or Revolt Platforms Ltd. This email has no association with Stoat or Revolt Platforms Ltd.
Learn more about third party instances here: Learn more about third party instances here:
https://developers.revolt.chat/faq.html https://developers.stoat.chat/faq/

2
crates/core/database/templates/suspension.html
View File

@@ -107,7 +107,7 @@
<p class="" style="line-height: 24px; font-size: 16px; width: 100%; margin: 0;" align="left"> <p class="" style="line-height: 24px; font-size: 16px; width: 100%; margin: 0;" align="left">
Further violations may result in a permanent ban depending on Further violations may result in a permanent ban depending on
severity, please abide by the severity, please abide by the
<a href="https://revolt.chat/aup" style="color: #0d6efd;">Acceptable Usage Policy</a>. <a href="https://stoat.chat/legal/community-guidelines" style="color: #0d6efd;">Community Guidelines</a>.
</p> </p>
<table class="s-4 w-full" role="presentation" border="0" cellpadding="0" cellspacing="0" style="width: 100%;" width="100%"> <table class="s-4 w-full" role="presentation" border="0" cellpadding="0" cellspacing="0" style="width: 100%;" width="100%">
<tbody> <tbody>

2
crates/core/database/templates/suspension.txt
View File

@@ -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. 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. Ban evasion is prohibited and will be dealt with accordingly.

4
crates/core/database/templates/suspension.whitelabel.txt
View File

@@ -3,6 +3,6 @@ Your account has been suspended, for one or more reasons:
This email is intended for {{email}} 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: Learn more about third party instances here:
https://developers.revolt.chat/faq.html https://developers.stoat.chat/faq/

2
crates/core/database/templates/verify.whitelabel.txt
View File

@@ -7,4 +7,4 @@ This email is intended for {{email}}
This email has no association with Stoat or Revolt Platforms Ltd. This email has no association with Stoat or Revolt Platforms Ltd.
Learn more about third party instances here: Learn more about third party instances here:
https://developers.revolt.chat/faq.html https://developers.stoat.chat/faq/

16
docs/docs/developers/endpoints.md
View File

@@ -8,16 +8,12 @@ sidebar_position: 1
You can connect to the API on the following URLs: You can connect to the API on the following URLs:
| URL | Release | Description | | URL | Release | Description |
| ----------------------------- | :--------: | --------------------------- | | ----------------------------- | :--------: | ---------------------------------- |
| `https://api.revolt.chat` | Production | Primary API endpoint | | `https://api.stoat.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 |
You can connect to the events server on the following URLs: You can connect to the events server on the following URLs:
| URL | Release | Description | | URL | Release | Description |
| ------------------------------ | :--------: | ------------------------------ | | ------------------------------ | :--------: | ------------------------------------- |
| `wss://ws.revolt.chat` | Production | Primary events endpoint | | `wss://events.stoat.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 |

2
docs/docs/developers/legacy-plugin-api.md
View File

@@ -10,7 +10,7 @@ The Plugin API is very powerful. **Tread carefully.**
**Zero guarantees or sandboxes are provided.** Your code is run as-is. **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. This is more or less a proof of concept but can be used to achieve some simple client modifications.

4
docs/docs/developing/backend/new_features.md
View File

@@ -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: 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) - 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: When your feature is ready to release, ensure to:
- Update backend documentation (what you're reading now!) if applicable - 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) - Update the Feature Matrix (or ask someone that can to do so)
- Ensure it is properly listed in the backend release changelog - Ensure it is properly listed in the backend release changelog