From 09ff06e4fffad3882ffb6ed218cbef5196349e32 Mon Sep 17 00:00:00 2001 From: Dan Date: Sat, 20 Jan 2018 15:48:31 -0800 Subject: [PATCH] Add basic README. --- README.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..8b58dc2 --- /dev/null +++ b/README.md @@ -0,0 +1,31 @@ +# MediaGoblin + +A basic container for a MediaGoblin media server (https://mediagoblin.org/), including Nginx and uWSGI. Assumes a separate PostgreSQL database for persistence, and an email relay host for sending email notifications. + +Source at https://projects.torsion.org/witten/mediagoblin-docker + +## Environment variables + +`NOTIFICATION_EMAIL`: From address for MediaGoblin notification emails. +`EMAIL_RELAY_HOST`: Hostname used to send outgoing notification emails. Since MediaGoblin isn't terribly configurable as an email client, it's recommended that this "host" is a mail relay like https://hub.docker.com/r/alterrebe/postfix-relay/. +`DATABASE_URL`: Connection string for database to use for persistence, including credentials. See example below. + +## Volumes + +`/app/user_dev`: Location to store user media uploads. + +## Ports + +`80`: Only listens on port 80 for HTTP. Intended to be used in conjunction with an external reverse proxy like https://hub.docker.com/r/jwilder/nginx-proxy/ to provide HTTPS or anything else that's needed. + +## Example + +```console +docker run --detach --name=mediagoblin \ + --env NOTIFICATION_EMAIL=media@example.org \ + --env EMAIL_RELAY_HOST=relay.example.org \ + --env DATABASE_URL=postgresql://mediagoblin:password@database.example.org/mediagoblin \ + --volume /var/lib/mediagoblin/user_dev:/app/user_dev \ + --publish 80:80 \ + witten/mediagoblin:latest +```