diff --git a/README.md b/README.md index 7b98dfd..ca162cf 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,10 @@ Copy the `sample.env` into a file named `.env` and make sure to adapt all values In order to run invoke an update or complete the first setup, the data folder must be created (`mkdir data`) and `make update` is used to pull the latest images and apply all database migrations. +`make update` involves the command `docker compose run --rm inventree-server invoke update` which is performs the initial database setup. + +To create an admin account, the command `docker compose run inventree-server invoke superuser` can be run. + The command `make up` can be used to run the setup as a foreground service, `make "up -d"` can be used to run the setup in detached mode. > Warning: @@ -30,7 +34,7 @@ This can be required because Docker does not like ZFS and might have issues to s ### SSO -The following is an example on configuring SSO using OIDC and Keycloak as IdP. See the [InvenTree SSO docs](https://docs.inventree.org/en/latest/settings/SSO) as well as the [AllAuth social providers](https://django-allauth.readthedocs.io/en/latest/socialaccount/providers/index.html) for more details. Note that Keycloak is not a valid provider anymore any OIDC [should be used](https://django-allauth.readthedocs.io/en/latest/socialaccount/providers/keycloak.html). +The following is an example on configuring SSO using OIDC and Keycloak as IdP. See the [InvenTree SSO docs](https://docs.inventree.org/en/latest/settings/SSO) as well as the [AllAuth social providers](https://django-allauth.readthedocs.io/en/latest/socialaccount/providers/index.html) for more details. Note that Keycloak is not a valid provider anymore and OIDC [should be used](https://django-allauth.readthedocs.io/en/latest/socialaccount/providers/keycloak.html). #### Keycloak