Document usage of keycloak users export in upgrade guide
This commit is contained in:
parent
e20b291823
commit
fbc0e26912
18
UPGRADING.md
18
UPGRADING.md
|
@ -20,12 +20,20 @@ explicitly. Once we implement them, their usage will be described in the
|
||||||
it will need to be mounted to `api/config.py` in the container. Ignore the
|
it will need to be mounted to `api/config.py` in the container. Ignore the
|
||||||
Keycloak options for now.
|
Keycloak options for now.
|
||||||
* Run the database reset script: `docker-compose run --rm api python tools/reset_database.py`
|
* Run the database reset script: `docker-compose run --rm api python tools/reset_database.py`
|
||||||
* Run the database migration script: `docker-compose run --rm api python
|
* Run the database migration script:
|
||||||
tools/import_from_mongodb.py mongodb://mongo/obs`. You might need to adjust
|
|
||||||
the URL.
|
```bash
|
||||||
|
docker-compose run --rm \
|
||||||
|
-v $PWD/export:/export \
|
||||||
|
api \
|
||||||
|
python tools/import_from_mongodb.py mongodb://mongo/obs \
|
||||||
|
--keycloak-users-file /export/users.json
|
||||||
|
```
|
||||||
* Shut down the `mongo` service, you can now remove it from docker-compose.yaml
|
* Shut down the `mongo` service, you can now remove it from docker-compose.yaml
|
||||||
* Start `keycloak` and configure it, similarly to how it was configured in the
|
* Start `keycloak` and configure it, similarly to how it was configured in the
|
||||||
development setup (but choose more secure options). Update the API config
|
development setup (but choose more secure options). Update the API config
|
||||||
file to match your keycloak configuration.
|
file to match your keycloak configuration. Import the file
|
||||||
* Start `api`, `worker` and `frontend`
|
`export/users.json` into your realm, it will re-add all the users from the
|
||||||
|
old installation. You should delete the file and `export/` folder afterwards.
|
||||||
|
* Start `api`, `worker` and `frontend`.
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue