first commit

1 files changed, 56 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..2dbba31
--- /dev/null
+++ b/README.md
@@ -0,0 +1,56 @@
+# MediaGoblin
+
+A basic container for a [MediaGoblin media server](https://git.sr.ht/~heckyel/mediagoblin).
+
+## Environment variables
+
+ * `DATABASE_URL`: Connection string for database to use for persistence, including credentials. See example below.
+ * `NOTIFICATION_EMAIL`: From address for MediaGoblin notification emails.
+ * `EMAIL_HOSTNAME`: Hostname used to send outgoing notification emails.
+ * `EMAIL_PORT`: Port number used to send outgoing notification emails.
+ * `EMAIL_USERNAME`: Username used to connect to outgoing email host.
+ * `EMAIL_PASSWORD`: Password used to connect to outgoing email host.
+ * `EMAIL_TLS_SSL`: "true" or "false" for using TLS/SSL encryption for sending emails.
+ * `EMAIL_STARTTLS`: "true" or "false" for using STARTTLS encryption for sending emails.
+
+## Basic management
+
+Set enviroment file
+
+```console
+$ cp -v .env.example .env
+```
+
+Run with `docker-compose`
+
+```console
+$ docker-compose up -d
+```
+
+## User management
+
+Since this image is for running a private MediaGoblin server, user
+self-registration is disabled. So, to add a user, first exec into the running
+Docker image:
+
+```console
+$ docker exec -it mediagoblin bash
+```
+
+Where `mediagoblin` is the name of your running Docker container. If you don’t
+know the name to use, try looking in `docker ps` output.
+
+Then, add a user (follow the prompts):
+
+```console
+# su - mediagoblin
+$ ./bin/gmg --conf_file /srv/app/mediagoblin_local.ini adduser
+```
+
+Finally, if you want to make the new user into an admin user:
+
+```console
+$ ./bin/gmg --conf_file /srv/app/mediagoblin_local.ini makeadmin username
+```
+
+Where `username` corresponds to the user you added above.