ansol
/
matrix-docker-ansible-deploy
mirror of https://github.com/spantaleev/matrix-docker-ansible-deploy.git
7
0
Fork 0
Code Issues Projects Releases Wiki Activity
matrix-docker-ansible-deploy/docs/importing-synapse-sqlite.md

31 lines
2.1 KiB
Markdown
Raw Permalink Normal View History

Rename some doc files and commands related to importing Since we'll likely have generic SQLite database importing via [pgloader](https://pgloader.io/) for migrating bridge databases from SQLite to Postgres, we'd rather avoid calling the "import Synapse SQLite database" command as just `--tags=import-sqlite-db`. Similarly, for the media store, we'd like to mention that it's related to Synapse as well. We'd like to be more explicit, so as to be less confusing, especially in light of other homeserver implementations coming in the future.
2020-12-13 23:48:36 +00:00
# Importing an existing SQLite database from another Synapse installation (optional)
Split README into a bunch of files in docs/
2018-08-08 07:07:02 +00:00
Do not refer to Synapse as "Matrix Synapse"
2019-04-23 07:20:56 +00:00
Run this if you'd like to import your database from a previous default installation of Synapse.
Rename some doc files and commands related to importing Since we'll likely have generic SQLite database importing via [pgloader](https://pgloader.io/) for migrating bridge databases from SQLite to Postgres, we'd rather avoid calling the "import Synapse SQLite database" command as just `--tags=import-sqlite-db`. Similarly, for the media store, we'd like to mention that it's related to Synapse as well. We'd like to be more explicit, so as to be less confusing, especially in light of other homeserver implementations coming in the future.
2020-12-13 23:48:36 +00:00
(don't forget to import your `media_store` files as well - see [the importing-synapse-media-store guide](importing-synapse-media-store.md)).
Split README into a bunch of files in docs/
2018-08-08 07:07:02 +00:00
Restore --tags=import-synapse-sqlite-db support Fixes https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/2669 Removed in 04b9483f0d9e562398e (2022-11-28) when switching from matrix-postgres to the devture-postgres external Ansible role. More details: https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/master/CHANGELOG.md#matrix-postgres-has-been-replaced-by-the-comdevtureansiblerolepostgres-external-role The `import_synapse_sqlite_db.yml` file and documentation has been adapted somewhat compared to before, so that: - it doesn't try to start Postgres automatically. You need to handle this part manually - it doesn't rely on the integrated Postgres and may potentially work with external Postgres instances just the same - it doesn't wipe out the whole database anymore. By default, we assume it's empty anyway and there's no need for such things. If it's not, then it's also probably dangerous to be so destructive. This is all completely untested, but will hopefully work.
2023-05-02 10:32:35 +00:00
While this playbook only supports running Synapse in combination with PostgreSQL, a Synapse instance installed manually usually defaults to using an SQLite database.
Split README into a bunch of files in docs/
2018-08-08 07:07:02 +00:00
Restore --tags=import-synapse-sqlite-db support Fixes https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/2669 Removed in 04b9483f0d9e562398e (2022-11-28) when switching from matrix-postgres to the devture-postgres external Ansible role. More details: https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/master/CHANGELOG.md#matrix-postgres-has-been-replaced-by-the-comdevtureansiblerolepostgres-external-role The `import_synapse_sqlite_db.yml` file and documentation has been adapted somewhat compared to before, so that: - it doesn't try to start Postgres automatically. You need to handle this part manually - it doesn't rely on the integrated Postgres and may potentially work with external Postgres instances just the same - it doesn't wipe out the whole database anymore. By default, we assume it's empty anyway and there's no need for such things. If it's not, then it's also probably dangerous to be so destructive. This is all completely untested, but will hopefully work.
2023-05-02 10:32:35 +00:00
If you have such a Synapse setup and wish to migrate it to one managed by the playbook (and over to PostgreSQL), this documentation page is for you.
Split README into a bunch of files in docs/
2018-08-08 07:07:02 +00:00
Make SQLite database import work with server files, not local This is a simplification and a way to make it consistent with how we do Postgres imports (see 6d89319822f4b2ecb), using files coming from the server, not from the local machine.
2019-01-01 13:16:13 +00:00
## Prerequisites
Split README into a bunch of files in docs/
2018-08-08 07:07:02 +00:00
Restore --tags=import-synapse-sqlite-db support Fixes https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/2669 Removed in 04b9483f0d9e562398e (2022-11-28) when switching from matrix-postgres to the devture-postgres external Ansible role. More details: https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/master/CHANGELOG.md#matrix-postgres-has-been-replaced-by-the-comdevtureansiblerolepostgres-external-role The `import_synapse_sqlite_db.yml` file and documentation has been adapted somewhat compared to before, so that: - it doesn't try to start Postgres automatically. You need to handle this part manually - it doesn't rely on the integrated Postgres and may potentially work with external Postgres instances just the same - it doesn't wipe out the whole database anymore. By default, we assume it's empty anyway and there's no need for such things. If it's not, then it's also probably dangerous to be so destructive. This is all completely untested, but will hopefully work.
2023-05-02 10:32:35 +00:00
Before doing the actual import:
Make SQLite database import work with server files, not local This is a simplification and a way to make it consistent with how we do Postgres imports (see 6d89319822f4b2ecb), using files coming from the server, not from the local machine.
2019-01-01 13:16:13 +00:00
Restore --tags=import-synapse-sqlite-db support Fixes https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/2669 Removed in 04b9483f0d9e562398e (2022-11-28) when switching from matrix-postgres to the devture-postgres external Ansible role. More details: https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/master/CHANGELOG.md#matrix-postgres-has-been-replaced-by-the-comdevtureansiblerolepostgres-external-role The `import_synapse_sqlite_db.yml` file and documentation has been adapted somewhat compared to before, so that: - it doesn't try to start Postgres automatically. You need to handle this part manually - it doesn't rely on the integrated Postgres and may potentially work with external Postgres instances just the same - it doesn't wipe out the whole database anymore. By default, we assume it's empty anyway and there's no need for such things. If it's not, then it's also probably dangerous to be so destructive. This is all completely untested, but will hopefully work.
2023-05-02 10:32:35 +00:00
- **ensure you have NOT started Synapse yet**. That is, make sure you have followed the [Installing step](installing.md), but haven't run the playbook's `start` tag yet. If you had started your new Synapse instance, it may have already initialized your Postgres database and importing onto it may not work. In such cases, you may need to clean up the `synapse` database first.
- **ensure you have uploaded your SQLite database file to the server** (any path is okay)
- if you're using the integrated Postgres server (**by default, you are** using it, unless you've explicitly switched to [Using an external PostgreSQL server](configuring-playbook-external-postgres.md)), **make sure Postgres is started** by running `just start-group postgres`
Make SQLite database import work with server files, not local This is a simplification and a way to make it consistent with how we do Postgres imports (see 6d89319822f4b2ecb), using files coming from the server, not from the local machine.
2019-01-01 13:16:13 +00:00
## Importing
Run this command (make sure to replace `<server-path-to-homeserver.db>` with a file path on your server):
Restore --tags=import-synapse-sqlite-db support Fixes https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/2669 Removed in 04b9483f0d9e562398e (2022-11-28) when switching from matrix-postgres to the devture-postgres external Ansible role. More details: https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/master/CHANGELOG.md#matrix-postgres-has-been-replaced-by-the-comdevtureansiblerolepostgres-external-role The `import_synapse_sqlite_db.yml` file and documentation has been adapted somewhat compared to before, so that: - it doesn't try to start Postgres automatically. You need to handle this part manually - it doesn't rely on the integrated Postgres and may potentially work with external Postgres instances just the same - it doesn't wipe out the whole database anymore. By default, we assume it's empty anyway and there's no need for such things. If it's not, then it's also probably dangerous to be so destructive. This is all completely untested, but will hopefully work.
2023-05-02 10:32:35 +00:00
```sh
just run-tags import-synapse-sqlite-db --extra-vars=server_path_homeserver_db=<server-path-to-homeserver.db>
```
Make SQLite database import work with server files, not local This is a simplification and a way to make it consistent with how we do Postgres imports (see 6d89319822f4b2ecb), using files coming from the server, not from the local machine.
2019-01-01 13:16:13 +00:00
Add additional notice to SQLite importing docs
2020-10-07 06:06:59 +00:00
**Notes**:
Restore --tags=import-synapse-sqlite-db support Fixes https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/2669 Removed in 04b9483f0d9e562398e (2022-11-28) when switching from matrix-postgres to the devture-postgres external Ansible role. More details: https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/master/CHANGELOG.md#matrix-postgres-has-been-replaced-by-the-comdevtureansiblerolepostgres-external-role The `import_synapse_sqlite_db.yml` file and documentation has been adapted somewhat compared to before, so that: - it doesn't try to start Postgres automatically. You need to handle this part manually - it doesn't rely on the integrated Postgres and may potentially work with external Postgres instances just the same - it doesn't wipe out the whole database anymore. By default, we assume it's empty anyway and there's no need for such things. If it's not, then it's also probably dangerous to be so destructive. This is all completely untested, but will hopefully work.
2023-05-02 10:32:35 +00:00
- `<server-path-to-homeserver.db>` must be replaced with a file path to a `homeserver.db` **file on the server** (not on your local machine!).
Add additional notice to SQLite importing docs
2020-10-07 06:06:59 +00:00
- if the SQLite database is from an older version of Synapse, the **importing procedure may run migrations on it to bring it up to date**. That is, your SQLite database file may get modified and become unusable with your older Synapse version. Keeping a copy of the original is probably wise.