From 19d32ecc7a6898b1e418aead65b562fd160cb015 Mon Sep 17 00:00:00 2001 From: Bastian Dietrich Date: Sat, 5 Feb 2022 19:19:46 +0100 Subject: [PATCH] Aktualisieren README.md --- README.md | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..7cf74b1 --- /dev/null +++ b/README.md @@ -0,0 +1,34 @@ +# ivatar / libravatar as docker image +This is [ivatar](https://www.libravatar.org) as a docker image. The image is freshly built every month from the [ivatar repository at git.linux-kernel.at](https://git.linux-kernel.at/oliver/ivatar). + +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 + +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` | | - + + +## To Do +- Figure out where the pictures are stored +- Write some setup instructions