Import upstream v0.16.22, stripped

Upstream commit: 474dd0229cb20cf513036619781ed97bd8073c3f Enterprise-only files removed or emptied: 63 Enterprise-only snippets removed: 117 in 50 files Dangling module declarations removed: 5 Cargo edits turning enterprise off: 14 Verification: clean Enterprise feature gates left for rebuilt features: 19 in 18 files Produced by tools/fork/strip.py. The full report is in docs/fork/strip-reports/ on main.
2026-09-18 10:21:56 -07:00
commit 7dae9b29fd
1650 changed files with 485521 additions and 0 deletions
@@ -0,0 +1,68 @@
+
+# Upgrading from `v0.11.x` to `v0.12.x`
+
+## Important Notes
+
+Version `0.12.x` introduces significant improvements such as zero-copy deserialization which make the new database layout incompatible with the previous version. As a result, the database must be migrated to the new layout. The migration is done automatically on startup and should not require any manual intervention. However, it is highly recommended to **back up your data** before upgrading since it is not possible to downgrade the database once it has been migrated. You may also want to run a mock migration before upgrading to ensure that everything works as expected.
+
+In addition to the database layout changes, multiple settings were renamed:
+
+- `server.http.*` to `http.*`.
+- `jmap.folders.*` to `email.folders.*`.
+- `jmap.account.purge.frequency` to `account.purge.frequency`.
+- `jmap.email.auto-expunge` to `email.auto-expunge`.
+- `jmap.protocol.changes.max-history` to `changes.max-history`.
+- `storage.encryption.*` to `email.encryption.*`.
+
+## Step-by-Step Upgrade Process
+
+- Stop Stalwart in **every single node of your cluster**. If you are using the systemd service, you can do this with the following command:
+
+  ```bash
+  $ sudo systemctl stop stalwart-mail
+  ```
+
+- Backup your data following your database system's instructions. For example, if you are using RocksDB or SQLite, you can simply copy the `data` directory to a backup location. If you are using PostgreSQL or MySQL, you can use the `pg_dump` or `mysqldump` commands to create a backup of your database. If your database does not support backups, you can use the [built-in migration utility](https://stalw.art/docs/management/migration) to export your data to a file. For example:
+
+  ```bash
+  $ sudo /opt/stalwart-mail/bin/stalwart-mail --config /opt/stalwart-mail/etc/config.toml --export /opt/stalwart-mail/export
+  $ sudo chown -R stalwart-mail:stalwart-mail /opt/stalwart-mail/export
+  ```
+
+- Download the `v0.12.x` binary for your platform (which is now called `stalwart` rather than `mail-server`) from the [releases page](https://github.com/stalwartlabs/stalwart/releases/latest/) and replace the binary in `/opt/stalwart-mail/bin`. If you rename the binary from `stalwart` to `stalwart-mail`, you can keep the same systemd service file, otherwise you will need to update the service file to point to the new binary name. 
+
+- Start the service. In a cluster, you can speed up the migration process by starting all nodes at once. 
+  ```bash
+  $ sudo systemctl start stalwart-mail
+  ```
+
+- Upgrade the webadmin by clicking on `Manage` > `Maintenance` > `Update Webadmin`.
+
+## Step-by-Step Upgrade Process (Docker)
+
+- Stop the Stalwart container in **every single node of your cluster**. If you are using Docker, you can do this with the following command:
+
+  ```bash
+  $ docker stop stalwart-mail
+  ```
+
+- Backup your data following your database system's instructions. For example, if you are using RocksDB or SQLite, you can simply copy the `data` directory to a backup location. If you are using PostgreSQL or MySQL, you can use the `pg_dump` or `mysqldump` commands to create a backup of your database. If your database does not support backups, you can use the `--export` command to export your data to a file. For example:
+
+  ```bash
+  $ docker run --rm -v <STALWART_DIR>:/opt/stalwart-mail -it stalwart-mail /usr/local/bin/stalwart-mail --config /opt/stalwart-mail/etc/config.toml --export /opt/stalwart-mail/export
+  ```
+
+- The Docker image location has now changed to `stalwartlabs/stalwart` instead of `stalwartlabs/mail-server`. Pull the latest image and configure it to use your existing data directory:
+
+  ```bash
+  $ docker run -d -ti -p 443:443 -p 8080:8080 \
+             -p 25:25 -p 587:587 -p 465:465 \
+             -p 143:143 -p 993:993 -p 4190:4190 \
+             -p 110:110 -p 995:995 \
+             -v <STALWART_DIR>:/opt/stalwart \
+             --name stalwart stalwartlabs/stalwart:latest
+  ```
+  
+- Since the mount point has changed from `/opt/stalwart-mail` to `/opt/stalwart`, you will need to update your Stalwart's configuration file to reflect this change. Open the file `/opt/stalwart/etc/config.toml` and update the paths accordingly.
+
+- Upgrade the webadmin by clicking on `Manage` > `Maintenance` > `Update Webadmin`.