diff --git a/README.md b/README.md index 7cf74b1..464e44d 100644 --- a/README.md +++ b/README.md @@ -4,29 +4,30 @@ This is [ivatar](https://www.libravatar.org) as a docker image. The image is fre I couldn't deeply test the image, so please use it with caution. ## How to use this image - - docker run --name ivatar -p 8080:8080 -d registry.gudd-it.de/bastian/ivatar-docker +```shell +docker run --name ivatar -p 8080:8080 -d registry.gudd-it.de/bastian/ivatar-docker +``` Please be aware that this will not persist any data. ## Environment Variables -| Variable | Description | Default from [config.py](https://git.linux-kernel.at/oliver/ivatar/-/blob/master/config.py) -|-- |-- |-- | -| `SITE_NAME` | | `libravatar` -| `SECURE_BASE_URL` | | `https://avatars.linux-kernel.at/avatar/` -| `BASE_URL` | | `http://avatars.linux-kernel.at/avatar/` -| `EMAIL_BACKEND` | | - -| `IVATAR_MAILGUN_API_KEY` | | - -| `IVATAR_MAILGUN_SENDER_DOMAIN`| | - -| `SERVER_EMAIL` | | `ivatar@mg.linux-kernel.at` -| `DEFAULT_FROM_EMAIL` | | `ivatar@mg.linux-kernel.at` -| `MYSQL_DATABASE` | | - -| `MYSQL_USER` | | - -| `MYSQL_PASSWORD` | | - -| `POSTGRESQL_DATABASE` | | - -| `POSTGRESQL_USER` | | - -| `POSTGRESQL_PASSWORD` | | - +| Variable | Description | Default from [config.py](https://git.linux-kernel.at/oliver/ivatar/-/blob/master/config.py)| +| --- | --- | --- | +| `SITE_NAME` | | `libravatar` | +| `SECURE_BASE_URL` | | `https://avatars.linux-kernel.at/avatar/` | +| `BASE_URL` | | `http://avatars.linux-kernel.at/avatar/` | +| `EMAIL_BACKEND` | | - | +| `IVATAR_MAILGUN_API_KEY` | | - | +| `IVATAR_MAILGUN_SENDER_DOMAIN`| | - | +| `SERVER_EMAIL` | | `ivatar@mg.linux-kernel.at` | +| `DEFAULT_FROM_EMAIL` | | `ivatar@mg.linux-kernel.at` | +| `MYSQL_DATABASE` | | - | +| `MYSQL_USER` | | - | +| `MYSQL_PASSWORD` | | - | +| `POSTGRESQL_DATABASE` | | - | +| `POSTGRESQL_USER` | | - | +| `POSTGRESQL_PASSWORD` | | - | ## To Do