pleroma-docker/README.md

152 lines
5.7 KiB
Markdown
Raw Normal View History

# Pleroma-Docker (Unofficial)
2018-04-08 20:49:07 +00:00
[Pleroma](https://pleroma.social/) is a selfhosted social network that uses OStatus/ActivityPub.
This repository dockerizes it for easier deployment.
<hr>
```cpp
#include <LICENSE>
/*
* This repository comes with ABSOLUTELY NO WARRANTY
*
* I am not responsible for burning servers, angry users, fedi drama,
2019-01-10 00:06:29 +00:00
* thermonuclear war, or you getting fired because your boss saw your NSFW posts.
* Please do some research if you have any concerns about included
* features or the software used by this script ***before*** using it.
*
*/
```
<hr>
2018-04-08 20:49:07 +00:00
2019-04-11 23:14:25 +00:00
## In the Wild
My own instance is managed by this script.<br>
Take a look at [hosted/pleroma](https://glitch.sh/hosted/pleroma) if you get stuck or need some inspiration.
Does your instance use pleroma-docker?<br>
Let me know and I'll add you to this list.
2018-04-08 20:49:07 +00:00
## Docs
2018-04-08 20:49:07 +00:00
2019-04-11 23:26:21 +00:00
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/.<br>
For help with docker check out https://docs.docker.com/.
2019-08-25 16:44:49 +00:00
For other problems related to this script, contact me or open an issue :)
2019-01-10 00:27:52 +00:00
### Prerequisites
2019-08-25 21:59:29 +00:00
- ~1GB of free HDD space
2019-04-11 23:14:25 +00:00
- `git` if you want smart build caches
2019-08-25 16:44:49 +00:00
- `curl`, `jq`, and `dialog` if you want to use `./pleroma.sh mod`
- Bash 4+
2019-04-11 23:14:25 +00:00
- Docker 18.06+ and docker-compose 1.22+
2019-01-10 00:27:52 +00:00
2019-01-10 00:06:29 +00:00
### Installation
2018-04-08 20:49:07 +00:00
- Clone this repository
2019-01-10 00:27:52 +00:00
- Create a `config.exs` and `.env` file
2019-08-25 16:44:49 +00:00
- Run `./pleroma.sh build` and `./pleroma.sh up`
2019-08-25 21:41:08 +00:00
- [Configure a reverse-proxy](#my-instance-is-up-how-do-i-reach-it)
2018-04-08 20:49:07 +00:00
- Profit!
2019-08-25 16:44:49 +00:00
Hint:<br>
You can also use normal `docker-compose` commands to maintain your setup.<br>
The only command that you cannot use is `docker-compose build` due to build caching.
2019-08-25 21:59:29 +00:00
### Configuration
All the pleroma options that you usually put into your `*.secret.exs` now go into `config.exs`.
`.env` stores config values that need to be known at orchestration/build time.<br>
Documentation for the possible values is inside of that file.
2019-01-10 00:06:29 +00:00
### Updates
2019-08-25 16:44:49 +00:00
Run `./pleroma.sh build` again and start the updated image with `./pleroma.sh up`.
2019-01-10 00:06:29 +00:00
You don't need to stop your pleroma server for either of those commands.
2018-04-08 20:49:07 +00:00
2019-01-10 00:06:29 +00:00
### Maintenance
2018-08-18 21:32:33 +00:00
2019-01-10 00:06:29 +00:00
Pleroma maintenance is usually done with mix tasks.
2019-08-25 21:59:29 +00:00
2019-08-25 16:44:49 +00:00
You can run these tasks in your running pleroma server using `./pleroma.sh mix [task] [arguments...]`.
2019-08-25 21:59:29 +00:00
2019-08-25 22:03:08 +00:00
For example: `./pleroma.sh mix pleroma.user new sn0w ...`
2019-08-25 16:44:49 +00:00
2019-08-25 22:02:45 +00:00
If you need to fix bigger problems you can also spawn a shell with `./pleroma.sh enter`.
2019-08-25 21:59:29 +00:00
### Customization
Add your customizations (and their folder structure) to `custom.d/`.<br>
They will be copied into the right place when the container starts.<br>
You can even replace/patch pleromas code with this,
because the project is recompiled at startup if needed.
In general: Prepending `custom.d/` to pleromas customization guides should work all the time.<br>
Check them out in the official pleroma wiki.
For example: A custom thumbnail now goes into `custom.d/` + `priv/static/instance/thumbnail.jpeg`.
### Patches
Works exactly like customization, but we have a neat little helper here.
Use `./pleroma.sh mod [regex]` to mod any file that ships with pleroma, without having to type the complete path.
2019-08-25 16:44:49 +00:00
### My instance is up, how do I reach it?
2019-08-25 21:47:25 +00:00
To reach Gopher or SSH, just uncomment the port-forward in your `docker-compose.yml`.
2019-08-25 16:44:49 +00:00
2019-08-25 21:47:25 +00:00
To reach HTTP you will have to configure a "reverse-proxy".
Older versions of this script contained a huge amount of scripting to support all kinds of reverse-proxy setups.
This newer version tries to focus only on providing good pleroma tooling.
That makes the whole process a bit more manual, but also more flexible.
You can use Caddy, Traefik, Apache, nginx, or whatever else you come up with.<br>
2019-08-25 16:44:49 +00:00
Just modify your `docker-compose.yml` accordingly.
One example would be to add an [nginx server](https://hub.docker.com/_/nginx) to your `docker-compose.yml`:
```yml
# ...
proxy:
image: nginx
init: true
restart: unless-stopped
links:
- server
volumes:
- ./my-nginx-config.conf:/etc/nginx/nginx.conf:ro
ports:
- "80:80"
- "443:443"
```
Then take a look at [the pleroma nginx example](https://git.pleroma.social/pleroma/pleroma/blob/develop/installation/pleroma.nginx) for hints about what to put into `my-nginx-config.conf`.
Using apache would work in a very similar way (see [Apache Docker Docs](https://hub.docker.com/_/httpd) and [the pleroma apache example](https://git.pleroma.social/pleroma/pleroma/blob/develop/installation/pleroma-apache.conf)).
The target that you proxy to is called `http://server:4000/`.<br>
This will work automagically when the proxy also lives inside of docker.
2018-08-18 21:32:33 +00:00
2019-08-25 21:47:25 +00:00
If you need help with this, or if you think that this needs more documentation, please let me know.
2019-08-25 16:44:49 +00:00
Something that cofe.rocks uses is simple port-forwarding of the `server` container to the host's `127.0.0.1`.
From there on, the natively installed nginx server acts as a proxy to the open internet.
2019-08-25 21:43:43 +00:00
You can take a look at [this file](https://glitch.sh/hosted/pleroma/src/commit/4e88d93276f0bb2ef62d7f18477b156318924325/docker-compose.m4#L93) and [cofe's proxy config](https://glitch.sh/hosted/pleroma/src/commit/4e88d93276f0bb2ef62d7f18477b156318924325/proxy.xconf) if that setup sounds interesting.
2019-08-25 16:44:49 +00:00
### Attribution
2019-04-11 23:26:21 +00:00
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).<br>
Thanks to all people who contributed to those.