funkwhale/docs/administrator_documentation/configuration_docs/env_file.md

# Customize your environment file

Your `.env` (environment) file contains variables you can change to customize your pod. You can change these variables at any time to alter how your pod runs.

You need to restart your Funkwhale services after changing your `.env` file.

````{tabbed} Debian

   ```{code} bash
   sudo systemctl restart funkwhale.target
   ```

````

````{tabbed} Docker

   ```{code} bash
   docker-compose restart
   ```

````

## Variables

````{important}

Some environment variables accept a URL as a value. To encode URLs and avoid problems with special characters, use `urllib.parse` on your URL value.

   ```py
   python3 -c 'import urllib.parse; print(urllib.parse.quote_plus("p@ssword"))
   ```

   ```{seealso}
      The [django-environ documentation](https://github.com/joke2k/django-environ/blob/main/docs/tips.rst#using-unsafe-characters-in-urls).
   ```

````

### Pod configuration

```{eval-rst}
.. autodata:: config.settings.common.FUNKWHALE_HOSTNAME
   :annotation: = mypod.audio
.. autodata:: config.settings.common.FUNKWHALE_PROTOCOL
   :annotation: =  https
```

### Database and redis configuration

```{eval-rst}
.. autodata:: config.settings.common.DATABASE_URL
   :annotation: = postgresql://<user>:<password>@<host>:<port>/<database>
.. autodata:: config.settings.common.DB_CONN_MAX_AGE
.. autodata:: config.settings.common.CACHE_URL
   :annotation: = redis://<host>:<port>/<database>
.. autodata:: config.settings.common.CELERY_BROKER_URL
   :annotation: = redis://127.0.0.1:6379/0
```

### Accounts and registration

```{eval-rst}

.. autodata:: config.settings.common.ACCOUNT_EMAIL_VERIFICATION_ENFORCE
   :annotation: = true
.. autodata:: config.settings.common.USERS_INVITATION_EXPIRATION_DAYS
   :annotation: = 7
.. autodata:: config.settings.common.DISABLE_PASSWORD_VALIDATORS
   :annotation: = true
.. autodata:: config.settings.common.ACCOUNT_USERNAME_BLACKLIST
   :annotation: = test,funkwhale
```

```{py:data} LDAP_ENABLED
---
value: false
---

Whether to enable LDAP authentication.

See {doc}`/administrator_documentation/configuration_docs/ldap` for more information.

```

### Media storage and serving configuration

```{eval-rst}

.. autodata:: config.settings.common.MEDIA_URL
   :annotation: = https://mypod.audio/media/
.. autodata:: config.settings.common.MEDIA_ROOT
   :annotation: = /srv/funkwhale/data/media
.. autodata:: config.settings.common.PROXY_MEDIA
   :annotation: = true
.. autodata:: config.settings.common.EXTERNAL_MEDIA_PROXY_ENABLED
   :annotation: = false
.. autodata:: config.settings.common.ATTACHMENTS_UNATTACHED_PRUNE_DELAY
   :annotation: = true
.. autodata:: config.settings.common.REVERSE_PROXY_TYPE
   :annotation: = nginx
.. autodata:: config.settings.common.PROTECT_FILES_PATH
   :annotation: = /_protected

```

### S3 storage configuration

```{eval-rst}

.. autodata:: config.settings.common.AWS_QUERYSTRING_AUTH
.. autodata:: config.settings.common.AWS_QUERYSTRING_EXPIRE
.. autodata:: config.settings.common.AWS_ACCESS_KEY_ID
.. autodata:: config.settings.common.AWS_SECRET_ACCESS_KEY
.. autodata:: config.settings.common.AWS_STORAGE_BUCKET_NAME
.. autodata:: config.settings.common.AWS_S3_CUSTOM_DOMAIN
.. autodata:: config.settings.common.AWS_S3_ENDPOINT_URL
   :annotation: = https://minio.mydomain.com
.. autodata:: config.settings.common.AWS_S3_REGION_NAME
   :annotation: = eu-west-2
.. autodata:: config.settings.common.AWS_LOCATION
   :annotation: = funkwhale_music

```

### In-place import configuration

```{eval-rst}

.. autodata:: config.settings.common.MUSIC_DIRECTORY_PATH
   :annotation: = /srv/funkwhale/data/music
.. autodata:: config.settings.common.MUSIC_DIRECTORY_SERVE_PATH
   :annotation: = /srv/funkwhale/data/music

```

### API configuration

```{eval-rst}

.. autodata:: config.settings.common.THROTTLING_ENABLED
.. autodata:: config.settings.common.THROTTLING_RATES
   :annotation: = signup=5/d,password-reset=2/d,anonymous-reports=5/d

```

```{dropdown} Standard endpoints

| Endpoint name             | Description                                              | Default rate (per user) |
|---------------------------|----------------------------------------------------------|-------------------------|
| `anonymous-wildcard`      | Anonymous requests not covered by other limits           | 1000 per hour           |
| `authenticated-wildcard`  | Authenticated requests not covered by other limits       | 2000 per hour           |
| `authenticated-create`    | Authenticated POST requests                              | 1000 per hour           |
| `anonymous-create`        | Anonymous POST requests                                  | 1000 per day            |
| `authenticated-list`      | Authenticated GET requests                               | 10000 per hour          |
| `anonymous-list`          | Anonymous GET requests                                   | 10000 per day           |
| `authenticated-retrieve`  | Authenticated GET requests on resource details           | 10000 per hour          |
| `anonymous-retrieve`      | Anonymous GET requests on resource details               | 10000 per day           |
| `authenticated-destroy`   | Authenticated DELETE requests on resource details        | 500 per hour            |
| `anonymous-destroy`       | Anonymous DELETE requests on resource details            | 1000 per day            |
| `authenticated-update`    | Authenticated PATCH and PUT requests on resource details | 1000 per hour           |
| `anonymous-update`        | Anonymous PATCH and PUT requests on resource details     | 1000 per day            |
| `subsonic`                | All Subsonic API requests                                | 2000 per hour           |

```

```{dropdown} User action endpoints

| Endpoint name             | Description                                              | Default rate (per user) |
|---------------------------|----------------------------------------------------------|-------------------------|
| `login`                   | User login                                               | 30 per hour             |
| `signup`                  | User signup                                              | 10 per day              |
| `verify-email`            | Email address confirmation                               | 20 per hour             |
| `password-change`         | Password change (when authenticated)                     | 20 per hour             |
| `password-reset`          | Password reset request                                   | 20 per hour             |
| `password-reset-confirm`  | Password reset confirmation                              | 20 per hour             |
| `fetch`                   | Fetch remote objects                                     | 200 per day             |

```

```{dropdown} Dangerous endpoints

| Endpoint name             | Description                                              | Default rate (per user) |
|---------------------------|----------------------------------------------------------|-------------------------|
| `authenticated-reports`   | Authenticated report submissions                         | 100 per day             |
| `anonymous-reports`       | Anonymous report submissions                             | 10 per day              |
| `authenticated-oauth-app` | Authenticated OAuth app creation                         | 10 per hour             |
| `anonymous-oauth-app`     | Anonymous OAuth app creation                             | 10 per day              |
| `oauth-authorize`         | OAuth app authorization                                  | 100 per hour            |
| `oauth-token`             | OAuth token creation                                     | 100 per hour            |
| `oauth-revoke-token`      | OAuth token deletion                                     | 100 per hour            |

```

```{eval-rst}

.. autodata:: config.settings.common.ADMIN_URL
.. autodata:: config.settings.common.EXTERNAL_REQUESTS_VERIFY_SSL
.. autodata:: config.settings.common.EXTERNAL_REQUESTS_TIMEOUT

```

### Federation configuration

```{eval-rst}

.. autodata:: config.settings.common.FEDERATION_OBJECT_FETCH_DELAY
.. autodata:: config.settings.common.FEDERATION_DUPLICATE_FETCH_DELAY

```

### Metadata configuration

```{eval-rst}

.. autodata:: config.settings.common.TAGS_MAX_BY_OBJ
.. autodata:: config.settings.common.MUSICBRAINZ_HOSTNAME
.. autodata:: config.settings.common.MUSICBRAINZ_CACHE_DURATION

```

### Channels and podcast configuration

```{eval-rst}

.. autodata:: config.settings.common.PODCASTS_RSS_FEED_REFRESH_DELAY
.. autodata:: config.settings.common.PODCASTS_RSS_FEED_MAX_ITEMS
.. autodata:: config.settings.common.PODCASTS_THIRD_PARTY_VISIBILITY

```

### Subsonic configuration

```{eval-rst}

.. autodata:: config.settings.common.SUBSONIC_DEFAULT_TRANSCODING_FORMAT

```

### Email configuration

```{eval-rst}

.. autodata:: config.settings.common.EMAIL_CONFIG
   :annotation: = consolemail://
.. autodata:: config.settings.common.DEFAULT_FROM_EMAIL
   :annotation: = Funkwhale <noreply@yourdomain>
.. autodata:: config.settings.common.EMAIL_SUBJECT_PREFIX

```

### Plugin configuration

```{eval-rst}

.. autodata:: config.settings.common.FUNKWHALE_PLUGINS_PATH

```

```{py:data} FUNKWHALE_PLUGINS
---
value: "['funkwhale_api.contrib.scrobbler', 'funkwhale_api.contrib.listenbrainz', 'funkwhale_api.contrib.maloja']"
---

List of Funkwhale plugins to load.
```

### Other settings

```{eval-rst}

.. autodata:: config.settings.common.INSTANCE_SUPPORT_MESSAGE_DELAY
.. autodata:: config.settings.common.FUNKWHALE_SUPPORT_MESSAGE_DELAY
.. autodata:: config.settings.common.MIN_DELAY_BETWEEN_DOWNLOADS_COUNT
.. autodata:: config.settings.common.MARKDOWN_EXTENSIONS
.. autodata:: config.settings.common.LINKIFIER_SUPPORTED_TLDS

```