Compare commits

...

3 Commits

Author SHA1 Message Date
Slavi Pantaleev
4b3b3a6462
Minor rewording in maintenance-migrating.md 2024-11-25 10:03:04 +02:00
Suguru Hirahara
57b046df12
Update docs/maintenance-migrating.md: reflect the review and edit a note for creating a temporary account on another server
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-25 16:49:03 +09:00
Suguru Hirahara
aa75503796
Update docs/maintenance-migrating.md
Co-authored-by: Slavi Pantaleev <slavi@devture.com>
2024-11-25 13:22:36 +09:00

View File

@ -1,36 +1,34 @@
# Migrating to new server
This documentation explains how to migrate your Matrix services (server, client, bridges, etc.) and data from an old server to a new server.
This documentation explains how to migrate your Matrix services (server, client, bridges, etc.) and data **from an old server to a new server**.
**Notes**:
- This migration guide is applicable if you migrate from one server to another server having the same CPU architecture (e.g. both servers being `amd64`).
If you're trying to migrate between different architectures (e.g. `amd64` --> `arm64`), simply copying the complete `/matrix` directory is **not** possible as it would move the raw PostgreSQL data (`/matrix/postgres/data`) between different architectures. In this specific case, you can use the guide below as a reference, but you would also need to avoid syncing `/matrix/postgres/data` to the new host, and also dump the database on your current server and import it properly on the new server. See our [Backing up PostgreSQL](maintenance-postgres.md#backing-up-postgresql) docs for help with PostgreSQL backup/restore.
- If you have any questions about migration or encountered an issue during migration, do not hesitate to ask for help on [our Matrix room](https://matrix.to/#/%23matrix-docker-ansible-deploy:devture.com).
- If you have any questions about migration or encountered an issue during migration, do not hesitate to ask for help on [our Matrix room](https://matrix.to/#/%23matrix-docker-ansible-deploy:devture.com). You probably might want to prepare a temporary/sub account on another Matrix server in case it becomes impossible to use your server due to migration failure by any chance.
- You can't change the domain (specified in the `matrix_domain` variable) after the initial deployment.
## Lower DNS TTL
Prepare by lowering DNS TTL for your domains (`matrix.example.com`, etc.), so that DNS record changes would happen faster, leading to less downtime.
## Stop services on the old server
## Stop services on the old server completely
Before migrating, you need to stop all services on the old server and make sure they won't be starting again.
To stop the services, go to the `matrix-docker-ansible-deploy` directory on your local computer, and run the command:
To do so, it is recommended to run the `systemctl` command on the server. Running the playbook's `stop` tag also stops the services, but just once; they will start again if you reboot the server.
Log in to the old server and run the command as `root` (or a user that can run it with `sudo`):
```sh
ansible-playbook -i inventory/hosts setup.yml --tags=stop
```
Alternatively, you can log in to the old server and run the command (you might have to `cd` to `/etc/systemd/system/` first):
```sh
systemctl disable --now matrix*
cd /etc/systemd/system/ && systemctl disable --now matrix*
```
## Copy data directory to the new server
Then, copy directory `/matrix` from the old server to the new server. When copying, make sure to preserve ownership and permissions (use `cp -p` or `rsync -ar`)!
After you've confirmed that all services were stopped, copy the `/matrix` directory from the old server to the new server. When copying, make sure to preserve ownership and permissions (use `cp -p` or `rsync -ar`)!
## Adjust DNS records
@ -40,11 +38,9 @@ Make sure your DNS records are adjusted to point to the new server's IP address.
Having adjusted DNS records, replace the old server's external IP address on the `inventory/hosts` file with that of the new server.
**Note**: you can't change the domain after the initial deployment.
## Create `matrix` user and group on the new server
After updating `inventory/hosts` file, run the command below on your local computer to create the `matrix` user and group on the new server:
Then, run the command below on your local computer to create the `matrix` user and group on the new server:
```sh
ansible-playbook -i inventory/hosts setup.yml --tags=setup-system-user
@ -56,7 +52,7 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-system-user
chown -R matrix:matrix /matrix
```
## Start all services on the new server
## Install and start all services on the new server
Finally, run the command below on your local computer to finish the installation and start all services: