Configuration

General configuration

There are plenty of settings you can adjust to your needs. Pingvin Share can be configured in two ways:

You can change the settings in the UI (/admin/config)

You can set the configuration via a YAML file. If you choose this way, you won't be able to change the settings in the UI.

If you use Docker you can create a config.yml file based on the config.example.yaml and mount it to /opt/app/config.yaml in the container.

If you run Pingvin Share without Docker, you can create a config.yml file based on the config.example.yaml in the root directory of the project.

For installation specific configuration, you can use environment variables. The following variables are available:

Variable	Default Value	Description
`BACKEND_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` or `clamav` when running with Docker	The IP address of the ClamAV server. See the ClamAV docs for more information.
`CLAMAV_PORT`	`3310`	The port number of the ClamAV server.

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.

Environment variables that are only available when running Pingvin Share with Docker.

Variable	Default Value	Description
`TRUST_PROXY`	`false`	Whether Pingvin Share is behind a reverse proxy. If set to `true`, the `X-Forwarded-For` header is trusted.
`PUID` and `PGID`	`1000`	The user and group ID of the user who should run Pingvin Share inside the Docker container and owns the files that are mounted with the volume. You can get the `PUID` and `GUID` of your user on your host machine by using the command `id`. For more information see this article.