From 27aee8a0b235711de74125fc002dbfc2d1c6b8a5 Mon Sep 17 00:00:00 2001
From: jp <jp+pleroma@supplntr.io>
Date: Tue, 26 May 2020 16:54:52 -0400
Subject: [PATCH] update README

---
 README.md | 38 ++++++++++++++++++++++++++++++++++++++
 1 file changed, 38 insertions(+)

diff --git a/README.md b/README.md
index 1457144..5c0979c 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,40 @@
 # pleroma-docker-compose
 
+This repo can be used as an example of utilizing docker-compose for your pleroma instance. It will start a pleroma instance container and pleroma-db (postgres) container. The instance will be available on `127.0.0.1:4000` - you will need to provide your own proxy such as nginx. 
+
+Please be advised you may need to adjust some things to fit your environment. 
+
+To deploy a pleroma instance using docker-compose - perform the following:
+
+```
+# git clone https://git.pleroma.social/pleroma/pleroma-docker-compose.git
+# cd pleroma-docker-compose
+```
+
+You will need to edit the `./environments/pleroma/pleroma.env` and replace the `ops.pleroma.social` domain with your own (and other necessary configuration variables you need)
+
+After, start the containers with:
+
+```
+# docker-compuse up -d
+```
+
+After pleroma initializes it should be available to proxy to on port 4000. 
+
+_Notes_
+
+You can customize the mounted config.exs to extend the pleroma config outside the ones generated off environment variables
+
+In `./volumes/pleroma/config.exs` you can append like so:
+
+```
+# cat volumes/pleroma/config.exs
+import Config
+
+config :pleroma, :instance,
+  registrations_open: true,
+  federating: true
+```
+
+The postgres database files are located in `./volumes/pleroma-db/pgdata`. You can also insert postgres startup scripts inside `./volumes/pleroma-db/pginit`
+