mirror/matrix-docker-ansible-deploy
1
0
Fork 0
mirror of https://github.com/spantaleev/matrix-docker-ansible-deploy.git synced 2025-03-20 11:29:54 +01:00
Code Issues Packages Projects Releases Wiki Activity

Minor rewording in maintenance-migrating.md

Browse Source
This commit is contained in:
Slavi Pantaleev 2024-11-25 10:03:04 +02:00 committed by GitHub
parent 57b046df12
commit 4b3b3a6462
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/maintenance-migrating.md
View File

@ -1,6 +1,6 @@
# Migrating to new server # 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**: **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`). - 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`).
@ -8,6 +8,8 @@ This documentation explains how to migrate your Matrix services (server, client,
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'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). 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. - 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 ## 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. Prepare by lowering DNS TTL for your domains (`matrix.example.com`, etc.), so that DNS record changes would happen faster, leading to less downtime.
@ -16,7 +18,7 @@ Prepare by lowering DNS TTL for your domains (`matrix.example.com`, etc.), so th
Before migrating, you need to stop all services on the old server and make sure they won't be starting again. Before migrating, you need to stop all services on the old server and make sure they won't be starting again.
To do so, it is recommended to run the `systemctl` command on the server. Running the playbook with `stop` tag does also stop the services, but just once; they will start again if you reboot the server. 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`): Log in to the old server and run the command as `root` (or a user that can run it with `sudo`):
@ -26,7 +28,7 @@ cd /etc/systemd/system/ && systemctl disable --now matrix*
## Copy data directory to the new server ## Copy data directory to the new server
After you confirmed that all services were stopped, 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 ## Adjust DNS records
@ -36,8 +38,6 @@ 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. 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 ## Create `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: Then, run the command below on your local computer to create the `matrix` user and group on the new server: