diff options
| author | David Mehren | 2021-03-03 12:36:04 +0100 |
|---|---|---|
| committer | David Mehren | 2021-03-03 12:38:44 +0100 |
| commit | b47f1e80b43839de20591544dacd016822bacb63 (patch) | |
| tree | 4bf5d1771c172d052246530f76316b5b997dd9c0 /docs | |
| parent | 0db862f3c9318f3e214d6b09604760a9844dcfd5 (diff) | |
Add docs about troubleshooting migrations
Signed-off-by: David Mehren <git@herrmehren.de>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/content/guides/migration-troubleshooting.md | 25 | ||||
| -rw-r--r-- | docs/mkdocs.yml | 1 |
2 files changed, 26 insertions, 0 deletions
diff --git a/docs/content/guides/migration-troubleshooting.md b/docs/content/guides/migration-troubleshooting.md new file mode 100644 index 00000000..20532111 --- /dev/null +++ b/docs/content/guides/migration-troubleshooting.md @@ -0,0 +1,25 @@ +# Troubleshooting Migrations + +In some cases, HedgeDoc might apply migrations without correctly saving the progress. +In these cases, HedgeDoc will refuse to start with “already exists”-errors like +`ERROR: type "enum_Notes_permission" already exists`. + +To fix these issues, manual intervention in the database is required: + +1. Make sure you have a way to edit the database directly. For SQLite, PostgreSQL and MariaDB/MySQL, you can use the + respective command-line tools `sqlite3`, `psql` and `mysql`. +2. Get the name of the failing migration and append `.js` to it. + For example, if you encounter this error + ``` + == 20180306150303-fix-enum: migrating ======= + + ERROR: type "enum_Notes_permission" already exists + ``` + the name of the failed migration would be `20180306150303-fix-enum.js`. +3. Make sure HedgeDoc does not run and insert the name into the `SequelizeMeta` table. + Ensure your database shell is connected to the HedgeDoc database. The SQL-statement may look like this: + ```sql + INSERT INTO "SequelizeMeta" (name) VALUES ('20180306150303-fix-enum.js'); + ``` +4. Start HedgeDoc again and observe if it starts correctly. It may be necessary to repeat this process + and insert multiple migrations into the `SequelizeMeta` table. diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index f0dfb723..41e80659 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -37,6 +37,7 @@ nav: - S3: guides/s3-image-upload.md - Migrate from Etherpad: guides/migrate-etherpad.md - Breaking Changes: guides/migrations-and-breaking-changes.md + - Migration Troubleshooting: guides/migration-troubleshooting.md - Terms of Use Setup: guides/providing-terms.md - Configuration: configuration.md - Developer: |