documentation updates

Dockerfile

@@ -61,8 +61,6 @@ WORKDIR /home/pleroma/pleroma
 # Bust the build cache (if needed)
 # This works by setting an environment variable with the last
 # used version/branch/tag/commit/... which originates in the script.
-# If the host doesn't have the required tool for "smart version detection"
-# we'll just use the current timestamp here which forces a rebuild every time.
 ARG __CACHE_TAG
 ENV __CACHE_TAG $__CACHE_TAG
 

README.md

@@ -53,7 +53,7 @@ For other problems related to this script, contact me or open an issue :)
 - Clone this repository
 - Create a `config.exs` and `.env` file
 - Run `./pleroma.sh build` and `./pleroma.sh up`
-- Configure a reverse-proxy
+- [Configure a reverse-proxy](#my-instance-is-up-how-do-i-reach-it)
 - Profit!
 
 Hint:<br>

config.dist.exs

@@ -1,19 +1,8 @@
 use Mix.Config
 
-# pleroma/pleroma/pleroma are the default credentials for the
+# Listening to 0.0.0.0 is required in a container since the IP is not known in advance.
-# managed database container. "db" is the default interlinked hostname.
+# You should not change the following three ip/port mappings.
-# You shouldn't need to change this unless you modifed .env
+# Instead, change the mapping to your host ports in "docker-compose.yml".
-config :pleroma, Pleroma.Repo,
-    adapter: Ecto.Adapters.Postgres,
-    username: "pleroma",
-    password: "pleroma",
-    database: "pleroma",
-    hostname: "db",
-    pool_size: 10
-
-# Listening to 0.0.0.0 is required in a container since the IP is not known in advance
-# You should not change the options below this.
-# Instead, go change the mapping to your host ports in "docker-compose.yml"
 
 config :pleroma, Pleroma.Web.Endpoint,
     http: [
@@ -28,7 +17,19 @@ config :pleroma, :gopher,
 config :esshd,
   port: 2222
 
+# pleroma/pleroma/pleroma are the default credentials.
+# "db" is the default interlinked hostname.
+# You shouldn't need to change this.
+config :pleroma, Pleroma.Repo,
+    adapter: Ecto.Adapters.Postgres,
+    username: "pleroma",
+    password: "pleroma",
+    database: "pleroma",
+    hostname: "db"
+
+#
 # vvv Your awesome config options go here vvv
+#
 
 ###
 # Here are some example values.

docker-compose.yml

@@ -5,10 +5,17 @@ services:
     image: postgres:10-alpine
     init: true
     restart: unless-stopped
-    environment:
+    environment: {
-      POSTGRES_DB: pleroma
+      # This might seem insecure but is usually not a problem.
-      POSTGRES_USER: pleroma
+      # You should leave this at the "pleroma" default.
-      POSTGRES_PASSWORD: pleroma
+      # The DB is only reachable by containers in the same docker network,
+      # and is not exposed to the open internet.
+      #
+      # If you do change this, remember to update "config.exs".
+      POSTGRES_DB: pleroma,
+      POSTGRES_USER: pleroma,
+      POSTGRES_PASSWORD: pleroma,
+    }
     volumes:
       - $DOCKER_DATADIR/db:/var/lib/postgresql/data
       - ./initdb.sql:/docker-entrypoint-initdb.d/pleroma.sql