refactor: Rename all remaining conduwuit references to Continuwuity

Also adds an alias for the old binary name to the dockerfile

Supersedes !1485
Closes #1536
Closes #2277
This commit is contained in:
Jade Ellis committed 2026-10-05 00:58:24 +01:00
1 parent 1e34bd2ed9
commit 67e5e11a97
430 files changed
+1347 -1437

No files matched your search

+5 -5
View File
@@ -9,7 +9,7 @@ Continuwuity uses a TOML config file for all of its settings. This is the recomm
You can specify the config file to be used by Continuwuity with the command-line flag `-c` or `--config`:
```bash
./conduwuit -c /path/to/continuwuity.toml
./continuwuity -c /path/to/continuwuity.toml
```
Alternatively, you can use the environment variable `CONTINUWUITY_CONFIG` to specify the config file to be used; see [the section on environment variables](#environment-variables) for more information.
@@ -80,10 +80,10 @@ Therefore, you can use environment variables or the options flags to override va
Continuwuity supports running admin commands on startup using the command-line flag `--execute`. This is treated as a standard admin command, without the need for the `!admin` prefix. For example, to create a new user:
```bash
# Equivalent to `!admin users create_user june`
./conduwuit --execute "users create_user june"
INFO conduwuit_service::admin::startup: Startup command #0 completed:
Created user with user_id: @june:girlboss.ceo and password: `<redacted>`
# Equivalent to `!admin users create_user jade`
./continuwuity --execute "users create_user jade"
INFO continuwuity_service::admin::startup: Startup command #0 completed:
Created user with user_id: @jade:continuwuity.org and password: `<redacted>`
```
Alternatively, you can configure `CONTINUWUITY_ADMIN_EXECUTE` or the config file value `admin_execute` with a list of commands.
+1 -1
View File
@@ -8,4 +8,4 @@ The development version is available on the AUR as [`continuwuity-git`][aur-cont
[aur-continuwuity]: https://aur.archlinux.org/packages/continuwuity
[aur-continuwuity-git]: https://aur.archlinux.org/packages/continuwuity-git
Simply install the `continuwuity` package. Configure the service in `/etc/conduwuit/conduwuit.toml`, then enable and start the `continuwuity.service`.
Simply install the `continuwuity` package. Configure the service in `/etc/continuwuity/continuwuity.toml`, then enable and start the `continuwuity.service`.
+1 -1
View File
@@ -247,7 +247,7 @@ Get a working Continuwuity server with an admin user in four steps:
-e CONTINUWUITY_ALLOW_FEDERATION="false" \
--name continuwuity \
forgejo.ellis.link/continuwuation/continuwuity:latest \
/sbin/conduwuit
/sbin/continuwuity
```
3. Fetch the one-time initial registration token
+17 -17
View File
@@ -70,16 +70,16 @@ sudo useradd -r --shell /usr/bin/nologin --no-create-home continuwuity
You can find an example unit for continuwuity below.
You may need to change the `ExecStart=` path to match where you placed the Continuwuity
binary if it is not in `/usr/bin/conduwuit`.
binary if it is not in `/usr/bin/continuwuity`.
On systems where rsyslog is used alongside journald (i.e. Red Hat-based distros
and OpenSUSE), put `$EscapeControlCharactersOnReceive off` inside
`/etc/rsyslog.conf` to allow color in logs.
If you are using a different `database_path` than the systemd unit's
configured default (`/var/lib/conduwuit`), you need to add your path to the
configured default (`/var/lib/continuwuity`), you need to add your path to the
systemd unit's `ReadWritePaths=`. You can do this by either directly editing
`conduwuit.service` and reloading systemd, or by running `systemctl edit conduwuit.service`
`continuwuity.service` and reloading systemd, or by running `systemctl edit continuwuity.service`
and entering the following:
```
@@ -90,9 +90,9 @@ ReadWritePaths=/path/to/custom/database/path
### Example systemd Unit File
<details>
<summary>Click to expand systemd unit file (conduwuit.service)</summary>
<summary>Click to expand systemd unit file (continuwuity.service)</summary>
```ini file="../../pkg/conduwuit.service"
```ini file="../../pkg/continuwuity.service"
```
@@ -100,13 +100,13 @@ ReadWritePaths=/path/to/custom/database/path
You can also [view the file on Foregejo][systemd-file].
[systemd-file]: https://forgejo.ellis.link/continuwuation/continuwuity/src/branch/main/pkg/conduwuit.service
[systemd-file]: https://forgejo.ellis.link/continuwuation/continuwuity/src/branch/main/pkg/continuwuity.service
## Creating the Continuwuity configuration file
Now you need to create the Continuwuity configuration file in
`/etc/conduwuit/conduwuit.toml`. You can find an example configuration at
[conduwuit-example.toml](../reference/config.mdx).
`/etc/continuwuity/continuwuity.toml`. You can find an example configuration at
[continuwuity-example.toml](../reference/config.mdx).
**Please take a moment to read the config. You need to change at least the
server name.**
@@ -117,16 +117,16 @@ If you are using a dedicated user for Continuwuity, you need to allow it to
read the configuration. To do this, run:
```bash
sudo chown -R root:root /etc/conduwuit
sudo chmod -R 755 /etc/conduwuit
sudo chown -R root:root /etc/continuwuity
sudo chmod -R 755 /etc/continuwuity
```
If you use the default database path you also need to run this:
```bash
sudo mkdir -p /var/lib/conduwuit/
sudo chown -R continuwuity:continuwuity /var/lib/conduwuit/
sudo chmod 700 /var/lib/conduwuit/
sudo mkdir -p /var/lib/continuwuity/
sudo chown -R continuwuity:continuwuity /var/lib/continuwuity/
sudo chmod 700 /var/lib/continuwuity/
```
## Exposing ports in the firewall or the router
@@ -197,26 +197,26 @@ header, making federation non-functional. If you find a workaround, please share
- `proxy_pass http://127.0.0.1:6167$request_uri;`
- `proxy_pass http://127.0.0.1:6167;`
Furthermore, Nginx users need to increase the `client_max_body_size` setting (default is 1M) to match the `max_request_size` defined in conduwuit.toml.
Furthermore, Nginx users need to increase the `client_max_body_size` setting (default is 1M) to match the `max_request_size` defined in continuwuity.toml.
## Starting Your Server
Now you can start Continuwuity with:
```bash
sudo systemctl start conduwuit
sudo systemctl start continuwuity
```
Set it to start automatically when your system boots with:
```bash
sudo systemctl enable conduwuit
sudo systemctl enable continuwuity
```
Check Continuwuity logs with the following command:
```bash
sudo journalctl -u conduwuit.service
sudo journalctl -u continuwuity.service
```
If Continuwuity has successfully initialized, you'll see output as below.
+1 -1
View File
@@ -39,7 +39,7 @@ spec:
- name: continuwuity
# use a sha hash <3
image: forgejo.ellis.link/continuwuation/continuwuity:latest
command: ["/sbin/conduwuit"]
command: ["/sbin/continuwuity"]
imagePullPolicy: IfNotPresent
ports:
- name: http
+1 -1
View File
@@ -57,7 +57,7 @@ The NixOS module provides these configuration options:
- `max-perf`: Takes longer to build, but has more runtime optimizations
- `max-perf-haswell`: Optimized for modern CPUs, don't use if your CPU is not Haswell or later.
- `admin.enable`: Whether to add the `conduwuit` binary to `PATH` for administration (enabled by default)
- `admin.enable`: Whether to add the `continuwuity` binary to `PATH` for administration (enabled by default)
- `settings`: The Continuwuity configuration
Use the `settings` option to configure Continuwuity itself. See the [example configuration file](../reference/config.mdx) for all available options.
+1 -1
View File
@@ -112,7 +112,7 @@ EOF
data = <<EOF
{{key "config/continuwuity"}}
EOF
destination = "local/conduwuit.toml"
destination = "local/continuwuity.toml"
}
...
```
+8 -8
View File
@@ -71,7 +71,7 @@ In the meantime, you may follow the [generic deployment instructions](generic).
## Configuration
Consult the [generic deployment instructions](./generic.mdx) for detailed steps. You will at least need to adjust the config file located at `/etc/conduwuit/conduwuit.toml` to suit your needs, and configure a [reverse proxy](./generic.mdx#setting-up-the-reverse-proxy).
Consult the [generic deployment instructions](./generic.mdx) for detailed steps. You will at least need to adjust the config file located at `/etc/continuwuity/continuwuity.toml` to suit your needs, and configure a [reverse proxy](./generic.mdx#setting-up-the-reverse-proxy).
## Service management
@@ -79,23 +79,23 @@ Now, you can start your Continuwuity service with:
```bash
# Start the service
sudo systemctl start conduwuit
sudo systemctl start continuwuity
```
Other useful commands include:
```bash
# Enable on boot
sudo systemctl enable conduwuit
sudo systemctl enable continuwuity
# Check status
sudo systemctl status conduwuit
sudo systemctl status continuwuity
# View logs
sudo journalctl -u conduwuit -f
sudo journalctl -u continuwuity -f
# Stopping the service
sudo systemctl stop conduwuit
sudo systemctl stop continuwuity
```
## Troubleshooting
@@ -131,8 +131,8 @@ To uninstall Continuwuity:
```bash
# Stop and disable the service
sudo systemctl stop conduwuit
sudo systemctl disable conduwuit
sudo systemctl stop continuwuity
sudo systemctl disable continuwuity
# Remove the package
sudo dnf remove continuwuity # replace `dnf` with `zypper` on openSUSE
+2 -2
View File
@@ -184,7 +184,7 @@ debug!(
Use the `WithLock` trait from `core::utils::with_lock`:
```rs
use conduwuit::utils::with_lock::WithLock;
use continuwuity::utils::with_lock::WithLock;
// Good - explicit closure guard
shared_data.with_lock(|data| {
@@ -205,7 +205,7 @@ shared_data.with_lock(|data| {
For async contexts, use the async variant:
```rs
use conduwuit::utils::with_lock::WithLockAsync;
use continuwuity::utils::with_lock::WithLockAsync;
// Good - async closure guard
async_shared_data.with_lock(|data| {
+1 -1
View File
@@ -56,7 +56,7 @@ workspace crate(s) must define the feature there in its `Cargo.toml`.
So, if this is adding a feature to the API such as `woof`, you define the
feature in the `api` crate's `Cargo.toml` as `woof = []`. The feature definition
in `main`'s `Cargo.toml` will be `woof = ["conduwuit-api/woof"]`.
in `main`'s `Cargo.toml` will be `woof = ["continuwuity-api/woof"]`.
The rationale for this is due to Rust / Cargo not supporting ["workspace level
features"][9], we must make a choice of; either scattering features all over the
+1 -1
View File
@@ -12,7 +12,7 @@ Install Git, Rust, Docker, Go, and `jq`. From this repository's root, build the
server image and run the suite:
```bash
cargo build -p conduwuit
cargo build -p continuwuity
docker build -t continuwuity:complement -f docker/complement.Dockerfile .
./bin/complement
```
@@ -4,7 +4,7 @@ services:
homeserver:
image: "forgejo.ellis.link/continuwuation/continuwuity:latest"
restart: unless-stopped
command: /sbin/conduwuit
command: /sbin/continuwuity
volumes:
- db:/var/lib/continuwuity
- ./continuwuity-resolv.conf:/etc/resolv.conf # use custom resolvers rather than Docker's
@@ -21,7 +21,7 @@ services:
homeserver:
image: "forgejo.ellis.link/continuwuation/continuwuity:latest"
restart: unless-stopped
command: /sbin/conduwuit
command: /sbin/continuwuity
volumes:
- db:/var/lib/continuwuity
- ./continuwuity-resolv.conf:/etc/resolv.conf # use custom resolvers rather than Docker's
@@ -17,7 +17,7 @@ services:
homeserver:
image: "forgejo.ellis.link/continuwuation/continuwuity:latest"
restart: unless-stopped
command: /sbin/conduwuit
command: /sbin/continuwuity
volumes:
- db:/var/lib/continuwuity
- ./continuwuity-resolv.conf:/etc/resolv.conf # use custom resolvers rather than Docker's
@@ -4,7 +4,7 @@ services:
homeserver:
image: "forgejo.ellis.link/continuwuation/continuwuity:latest"
restart: unless-stopped
command: /sbin/conduwuit
command: /sbin/continuwuity
volumes:
- db:/var/lib/continuwuity
- ./continuwuity-resolv.conf:/etc/resolv.conf # use custom resolvers rather than Docker's
@@ -4,7 +4,7 @@ services:
homeserver:
image: "forgejo.ellis.link/continuwuation/continuwuity:latest"
restart: unless-stopped
command: /sbin/conduwuit
command: /sbin/continuwuity
volumes:
- db:/var/lib/continuwuity
- ./continuwuity-resolv.conf:/etc/resolv.conf # use custom resolvers rather than Docker's
@@ -18,7 +18,7 @@ services:
homeserver:
image: "forgejo.ellis.link/continuwuation/continuwuity:latest"
restart: unless-stopped
command: /sbin/conduwuit
command: /sbin/continuwuity
volumes:
- db:/var/lib/continuwuity
- ./continuwuity-resolv.conf:/etc/resolv.conf # use custom resolvers rather than Docker's
@@ -18,7 +18,7 @@ services:
homeserver:
image: "forgejo.ellis.link/continuwuation/continuwuity:latest"
restart: unless-stopped
command: /sbin/conduwuit
command: /sbin/continuwuity
volumes:
- db:/var/lib/continuwuity
- ./continuwuity-resolv.conf:/etc/resolv.conf # use custom resolvers rather than Docker's
@@ -4,7 +4,7 @@ services:
homeserver:
image: "forgejo.ellis.link/continuwuation/continuwuity:latest"
restart: unless-stopped
command: /sbin/conduwuit
command: /sbin/continuwuity
volumes:
- db:/var/lib/continuwuity
- ./continuwuity-resolv.conf:/etc/resolv.conf # use custom resolvers rather than Docker's
+1 -1
View File
@@ -4,7 +4,7 @@ services:
homeserver:
image: "forgejo.ellis.link/continuwuation/continuwuity:latest"
restart: unless-stopped
command: /sbin/conduwuit
command: /sbin/continuwuity
ports:
# If your reverse proxy is on the host, use this
+2 -2
View File
@@ -1,9 +1,9 @@
## Configuration file reference
This configuration file reflect the latest developments on the `main` branch. To check the configuration from a specific Continuwuity version, browse the [tags](https://forgejo.ellis.link/continuwuation/continuwuity/tags) and navigate to the `conduwuit-example.toml` file for that version.
This configuration file reflect the latest developments on the `main` branch. To check the configuration from a specific Continuwuity version, browse the [tags](https://forgejo.ellis.link/continuwuation/continuwuity/tags) and navigate to the `continuwuity-example.toml` file for that version.
---
```toml file="../../conduwuit-example.toml"
```toml file="../../continuwuity-example.toml"
```
+1 -1
View File
@@ -170,7 +170,7 @@ To enable backtraces, set the `RUST_BACKTRACE` environment variable before start
```bash
# For both panics and errors
RUST_BACKTRACE=1 ./conduwuit
RUST_BACKTRACE=1 ./continuwuity
```