diff --git a/README.md b/README.md index f20caad..bf78786 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,7 @@ ma1sd - Federated Matrix Identity Server - [Contribute](#contribute) - [Powered by ma1sd](#powered-by-ma1sd) - [FAQ](#faq) +- [Migration from mxisd](#migration-from-mxisd) - [Contact](#contact) --- @@ -108,6 +109,10 @@ The following projects can use ma1sd under the hood for some or all their featur # FAQ See the [dedicated document](docs/faq.md) +# Migration from mxisd + +See the [migration guide](docs/migration-from-mxisd.md) + # Contact Get in touch via: - Matrix: [#ma1sd:ru-matrix.org](https://matrix.to/#/#ma1sd:ru-matrix.org) diff --git a/docs/getting-started.md b/docs/getting-started.md index b27bc8f..317300c 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -131,7 +131,7 @@ trusted_third_party_id_servers: It is **highly recommended** to remove `matrix.org` and `vector.im` (or any other default entry) from your configuration so only your own Identity server is authoritative for your HS. -## Validate +## Validate (Under reconstruction) **NOTE:** In case your homeserver has no working federation, step 5 will not happen. If step 4 took place, consider your installation validated. diff --git a/docs/migration-from-mxisd.md b/docs/migration-from-mxisd.md new file mode 100644 index 0000000..b98e467 --- /dev/null +++ b/docs/migration-from-mxisd.md @@ -0,0 +1,16 @@ +# Migration from mxisd + +Version 2.0.0 of the ma1sd uses the same format of the database schema and main configuration file as mxisd. + +Migration from mxisd: +- install ma1sd via deb package, docker image or zip/tar archive +- stop mxisd +- copy configuration file (by default /etc/mxisd/mxisd.yaml to /etc/ma1sd/ma1sd.yaml) +- copy key store (by default /var/lib/mxisd/keys folder to /var/lib/ma1sd/keys) +- copy storage (by default /var/lib/mxisd/store.db to /var/lib/ma1sd/store.db) +- change paths in the new config file (ma1sd.yaml). There are options: `key.path` and `storage.provider.sqlite` +- start ma1sd + +Due to ma1sd uses the same ports by default as mxisd it isn't necessary to change nginx/apache configuration. + +If you have any troubles with migration don't hesitate to ask questions in [#ma1sd:ru-matrix.org](https://matrix.to/#/#ma1sd:ru-matrix.org) room.