diff --git a/README.md b/README.md index 5ee39910..e7bb0ead 100644 --- a/README.md +++ b/README.md @@ -117,9 +117,30 @@ docker compose up -d pm2 restart pingvin-share-frontend ``` -### Custom branding +### Configuration -You can change the name and the logo of the app by visiting the admin configuration page. +You can customize Pingvin Share by going to the configuration page in your admin dashboard. + +#### Environment variables + +For installation specific configuration, you can use environment variables. The following variables are available: + +##### Backend + +| Variable | Default Value | Description | +| ---------------- | -------------------------------------------------- | -------------------------------------- | +| `PORT` | `8080` | The port on which the backend listens. | +| `DATABASE_URL` | `file:../data/pingvin-share.db?connection_limit=1` | The URL of the SQLite database. | +| `DATA_DIRECTORY` | `./data` | The directory where data is stored. | +| `CLAMAV_HOST` | `127.0.0.1` | The IP address of the ClamAV server. | +| `CLAMAV_PORT` | `3310` | The port number of the ClamAV server. | + +##### Frontend + +| Variable | Default Value | Description | +| --------- | ----------------------- | ---------------------------------------- | +| `PORT` | `3000` | The port on which the frontend listens. | +| `API_URL` | `http://localhost:8080` | The URL of the backend for the frontend. | ## 🖤 Contribute