From 544321510bc0ad6f8c637730f7cb00dc8fa0bcac Mon Sep 17 00:00:00 2001 From: sn0w Date: Fri, 12 Apr 2019 01:26:21 +0200 Subject: [PATCH] Update readme --- README.md | 23 ++++++++++++++--------- 1 file changed, 14 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index b4fc7e8..739e2fb 100644 --- a/README.md +++ b/README.md @@ -24,14 +24,6 @@ This repository dockerizes it for easier deployment.
-## Alternatives - -If this setup is a bit overwhelming there are a lot of other great dockerfiles -or guides from the community. A few are linked below. This list is not exhaustive and not ordered. - -- [Angristan/dockerfiles/pleroma](https://github.com/Angristan/dockerfiles/tree/master/pleroma) -- [RX14/iscute.moe](https://github.com/RX14/kurisu.rx14.co.uk/blob/master/services/iscute.moe/pleroma/Dockerfile) - ## In the Wild My own instance is managed by this script.
@@ -42,6 +34,12 @@ Let me know and I'll add you to this list. ## Docs +These docs assume that you have at least a basic understanding +of the pleroma installation process and common docker commands. + +If you have questions about Pleroma head over to https://docs-develop.pleroma.social/.
+For help with docker check out https://docs.docker.com/. + ### Prerequisites - ~500mb of free HDD space @@ -76,7 +74,7 @@ For example: `/pleroma mix pleroma.user new sn0w ...` Add your customizations (and their folder structure) to `custom.d/`.
They will be copied into the right place when the container starts.
-You can even replace/patch pleroma’s code with this,
+You can even replace/patch pleroma’s code with this, because the project is recompiled at startup if needed. In general: Prepending `custom.d/` to pleroma’s customization guides should work all the time.
@@ -198,3 +196,10 @@ ssl_certificate_key /ssl/ssl.key; ``` In traefik-mode and manual-mode these files and the `SCRIPT_ENABLE_SSL` value are ignored. + +## Attribution + +Thanks to [Angristan](https://github.com/Angristan/dockerfiles/tree/master/pleroma) and [RX14](https://github.com/RX14/kurisu.rx14.co.uk/blob/master/services/iscute.moe/pleroma/Dockerfile) for their dockerfiles, which served as an inspiration for the early versions of this script. + +The current version is based on the [official wiki guides](https://git.pleroma.social/pleroma/pleroma/tree/develop/docs/installation).
+Thanks to all people who contributed to those.