Skip to content

Commit efa1621

Browse files
committed
...
1 parent 6c25d62 commit efa1621

1 file changed

Lines changed: 9 additions & 1 deletion

File tree

docs/admin-guide/cli/migrations.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,14 +55,22 @@ semaphore migrate --undo-to 2.13
5555

5656
BoltDB was deprecated starting from version 2.16, and many new features introduced in 2.17 are no longer supported by BoltDB. BoltDB support will be fully removed in version 2.19.
5757

58-
To migrate your data from BoltDB to another database backend, use:
58+
To migrate, first update Semaphore to version 2.17 or later, then configure the target database (SQLite, MySQL, or PostgreSQL) in your `config.json`. After that, run the following command to import all data from the old BoltDB file into the new database:
5959

6060
```
6161
semaphore migrate --from-boltdb /path/to/boltdb/file
6262
```
6363

6464
- `/path/to/boltdb/file` — Path to the existing BoltDB database file.
6565

66+
The command reads all projects, templates, inventories, repositories, keys, users, and task history from BoltDB and writes them into the database specified in the current Semaphore configuration. The original BoltDB file is not modified.
67+
68+
By default, the database schema is migrated to the latest version supported by the current Semaphore binary. You can combine `--from-boltdb` with `--apply-to` or `--undo-to` to target a specific schema version:
69+
70+
```
71+
semaphore migrate --from-boltdb /path/to/boltdb/file --apply-to 2.17.0
72+
```
73+
6674
Additional arguments:
6775
- `--err-log-size=N` — Maximum number of error lines displayed in the output.
6876
- `--skip-task-output` — Do not import task outputs.

0 commit comments

Comments
 (0)