update documentation, rename compose file

This commit is contained in:
Philipp 2025-09-17 15:26:17 +02:00
parent 79d0dcf47f
commit e21a96dcb5
Signed by: philipp
SSH key fingerprint: SHA256:ZWe7taUXeJb8xtjCZE7rZ3baSkVpBPjE4hdoKyJpfQE
2 changed files with 24 additions and 2 deletions

View file

@ -8,15 +8,37 @@ These are the deployment files required to get InvenTree up and running. InvenTr
## Configuration
Copy the `sample.env` into a file named `.env` and make sure to adapt all values to your needs, especially secrets.
Copy the `sample.env` into a file named `.env` and make sure to adapt all values to your needs, especially secrets. Note that the redis cache is disabled by default.
## Installation
In order to run invoke an update or complete the first setup, `make update` is used to pull the latest images and apply all database migrations.
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.
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:
When running inside LXC (e.g. Proxmox) with ZFS you might need to run add the following to your `/etc/docker/daemon.json` (and restart afterwards):
```json
{
"storage-driver": "vfs"
}
```
This can be required because Docker does not like ZFS and might have issues to store some layers. Note that using VFS has significant impact on the storage usage (might explode).
### 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) for more details.
#### Keycloak
1. Create a new client (Type: OpenID Connect)
2. Enable Client authentication, Authorization, Standard flow. Disable everything else (explicitly Direct access grant)
3. Set home URL to `https://<inventree-hostname>` and Redirect URL to `https://<inventree-hostname>/accounts/keycloak/login/callback/`.
#### Inventree
Login as InvenTree admin user. Under `Settings > Login Settings` make sure to `Enable SSO`.