*file
elixir_buildpack.config
test/
-instance/
-_build
-deps
test
benchmarks
docs/site
+docker-db
+uploads
+instance
# Required to get version
!.git
/instance
/priv/ssh_keys
vm.args
+.cache/
+.hex/
+.mix/
+.psql_history
+docker-resources/Dockerfile
+docker-resources/Caddyfile
+pgdata
# Prevent committing custom emojis
/priv/static/emoji/custom/*
# Generated documentation
docs/site
+
+# docker stuff
+docker-db
## Unreleased
+## Added
+- Officially supported docker release
+
## Changes
- Follows no longer override domain blocks, a domain block is final
- Deletes are now the lowest priority to publish and will be handled after creates
-FROM elixir:1.13.4-alpine as build
-
-COPY . .
+FROM hexpm/elixir:1.13.4-erlang-24.3.4.5-alpine-3.15.6
ENV MIX_ENV=prod
-RUN apk add git gcc g++ musl-dev make cmake file-dev &&\
- echo "import Config" > config/prod.secret.exs &&\
- mix local.hex --force &&\
- mix local.rebar --force &&\
- mix deps.get --only prod &&\
- mkdir release &&\
- mix release --path release
-
-FROM alpine:3.16
-
-ARG BUILD_DATE
-ARG VCS_REF
+ARG HOME=/opt/akkoma
+ARG DATA=/var/lib/akkoma
LABEL org.opencontainers.image.title="akkoma" \
org.opencontainers.image.description="Akkoma for Docker" \
org.opencontainers.image.revision=$VCS_REF \
org.opencontainers.image.created=$BUILD_DATE
-ARG HOME=/opt/akkoma
-ARG DATA=/var/lib/akkoma
+RUN apk add git gcc g++ musl-dev make cmake file-dev exiftool ffmpeg imagemagick libmagic ncurses postgresql-client
-RUN apk update &&\
- apk add exiftool ffmpeg imagemagick libmagic ncurses postgresql-client &&\
- adduser --system --shell /bin/false --home ${HOME} akkoma &&\
- mkdir -p ${DATA}/uploads &&\
- mkdir -p ${DATA}/static &&\
- chown -R akkoma ${DATA} &&\
- mkdir -p /etc/akkoma &&\
- chown -R akkoma /etc/akkoma
+EXPOSE 4000
-USER akkoma
+ARG UID=1000
+ARG GID=1000
+ARG UNAME=akkoma
-COPY --from=build --chown=akkoma:0 /release ${HOME}
+RUN addgroup -g $GID $UNAME
+RUN adduser -u $UID -G $UNAME -D -h $HOME $UNAME
-COPY ./config/docker.exs /etc/akkoma/config.exs
-COPY ./docker-entrypoint.sh ${HOME}
+WORKDIR /opt/akkoma
-EXPOSE 4000
+USER $UNAME
+RUN mix local.hex --force &&\
+ mix local.rebar --force
-ENTRYPOINT ["/opt/akkoma/docker-entrypoint.sh"]
+CMD ["/opt/akkoma/docker-entrypoint.sh"]
config :web_push_encryption, :vapid_details, subject: "mailto:#{System.get_env("NOTIFY_EMAIL")}"
config :pleroma, :database, rum_enabled: false
-config :pleroma, :instance, static_dir: "/var/lib/pleroma/static"
-config :pleroma, Pleroma.Uploaders.Local, uploads: "/var/lib/pleroma/uploads"
+config :pleroma, :instance, static_dir: "/var/lib/akkoma/static"
+config :pleroma, Pleroma.Uploaders.Local, uploads: "/var/lib/akkoma/uploads"
# We can't store the secrets in this file, since this is baked into the docker image
-if not File.exists?("/var/lib/pleroma/secret.exs") do
+if not File.exists?("/var/lib/akkoma/secret.exs") do
secret = :crypto.strong_rand_bytes(64) |> Base.encode64() |> binary_part(0, 64)
signing_salt = :crypto.strong_rand_bytes(8) |> Base.encode64() |> binary_part(0, 8)
{web_push_public_key, web_push_private_key} = :crypto.generate_key(:ecdh, :prime256v1)
web_push_private_key: Base.url_encode64(web_push_private_key, padding: false)
)
- File.write("/var/lib/pleroma/secret.exs", secret_file)
+ File.write("/var/lib/akkoma/secret.exs", secret_file)
end
-import_config("/var/lib/pleroma/secret.exs")
+import_config("/var/lib/akkoma/secret.exs")
# For additional user config
-if File.exists?("/var/lib/pleroma/config.exs"),
- do: import_config("/var/lib/pleroma/config.exs"),
+if File.exists?("/var/lib/akkoma/config.exs"),
+ do: import_config("/var/lib/akkoma/config.exs"),
else:
- File.write("/var/lib/pleroma/config.exs", """
+ File.write("/var/lib/akkoma/config.exs", """
import Config
# For additional configuration outside of environmental variables
--- /dev/null
+version: "3.7"
+
+services:
+ db:
+ image: akkoma-db:latest
+ build: ./docker-resources/database
+ restart: unless-stopped
+ user: ${DOCKER_USER}
+ environment: {
+ # This might seem insecure but is usually not a problem.
+ # You should leave this at the "akkoma" default.
+ # 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: akkoma,
+ POSTGRES_USER: akkoma,
+ POSTGRES_PASSWORD: akkoma,
+ }
+ env_file:
+ - .env
+ volumes:
+ - type: bind
+ source: ./pgdata
+ target: /var/lib/postgresql/data
+
+ akkoma:
+ image: akkoma:latest
+ build: .
+ restart: unless-stopped
+ env_file:
+ - .env
+ links:
+ - db
+ ports: [
+ # Uncomment/Change port mappings below as needed.
+ # The left side is your host machine, the right one is the akkoma container.
+ # You can prefix the left side with an ip.
+
+ # Webserver (for reverse-proxies outside of docker)
+ # If you use a dockerized proxy, you can leave this commented
+ # and use a container link instead.
+ "127.0.0.1:4000:4000",
+ ]
+ volumes:
+ - .:/opt/akkoma
+
+ # Uncomment the following if you want to use a reverse proxy
+ #proxy:
+ # image: caddy:2-alpine
+ # restart: unless-stopped
+ # links:
+ # - akkoma
+ # ports: [
+ # "443:443",
+ # "80:80"
+ # ]
+ # volumes:
+ # - ./docker-resources/Caddyfile:/etc/caddy/Caddyfile
+ # - ./caddy-data:/data
+ # - ./caddy-config:/config
\ No newline at end of file
done
echo "-- Running migrations..."
-$HOME/bin/pleroma_ctl migrate
+mix ecto.migrate
echo "-- Starting!"
-exec $HOME/bin/pleroma start
+mix phx.server
--- /dev/null
+# default docker Caddyfile config for Akkoma
+#
+# Simple installation instructions:
+# 1. Replace 'example.tld' with your instance's domain wherever it appears.
+
+example.tld {
+ log {
+ output file /var/log/caddy/akkoma.log
+ }
+
+ encode gzip
+
+ reverse_proxy akkoma:4000
+}
--- /dev/null
+#!/bin/sh
+
+docker-compose build --build-arg UID=$(id -u) --build-arg GID=$(id -g) akkoma
+docker-compose build --build-arg UID=$(id -u) --build-arg GID=$(id -g) db
--- /dev/null
+FROM postgres:14-alpine
+
+ARG UID=1000
+ARG GID=1000
+ARG UNAME=akkoma
+
+RUN addgroup -g $GID $UNAME
+RUN adduser -u $UID -G $UNAME -D -h $HOME $UNAME
+
+USER akkoma
--- /dev/null
+MIX_ENV=prod
+DB_NAME=akkoma
+DB_USER=akkoma
+DB_PASS=akkoma
--- /dev/null
+#!/bin/sh
+
+docker-compose run --rm akkoma $@
--- /dev/null
+# Installing in Docker
+
+## Installation
+
+This guide will show you how to get akkoma working in a docker container,
+if you want isolation, or if you run a distribution not supported by the OTP
+releases.
+
+### Prepare the system
+
+* Install docker and docker-compose
+ * [Docker](https://docs.docker.com/engine/install/)
+ * [Docker-compose](https://docs.docker.com/compose/install/)
+ * This will usually just be a repository installation and a package manager invocation.
+* Clone the akkoma repository
+ * `git clone https://akkoma.dev/AkkomaGang/akkoma.git -b stable`
+ * `cd akkoma`
+
+### Set up basic configuration
+
+```bash
+cp docker-resources/env.example .env
+echo "DOCKER_USER=$(id -u):$(id -g)" >> .env
+```
+
+This probably won't need to be changed, it's only there to set basic environment
+variables for the docker-compose file.
+
+### Building the container
+
+The container provided is a thin wrapper around akkoma's dependencies,
+it does not contain the code itself. This is to allow for easy updates
+and debugging if required.
+
+```bash
+./docker-resources/build.sh
+```
+
+This will generate a container called `akkoma` which we can use
+in our compose environment.
+
+### Generating your instance
+
+```bash
+mkdir pgdata
+# if you want to use caddy
+mkdir caddy-data
+mkdir caddy-config
+./docker-resources/manage.sh mix deps.get
+./docker-resources/manage.sh mix compile
+./docker-resources/manage.sh mix pleroma.instance gen
+```
+
+This will ask you a few questions - the defaults are fine for most things,
+the database hostname is `db`, and you will want to set the ip to `0.0.0.0`.
+
+Now we'll want to copy over the config it just created
+
+```bash
+cp config/generated_config.exs config/prod.secret.exs
+```
+
+### Setting up the database
+
+We need to run a few commands on the database container, this isn't too bad
+
+```bash
+docker-compose run --rm --user akkoma -d db
+# Note down the name it gives here, it will be something like akkoma_db_run
+docker-compose run --rm akkoma psql -h db -U akkoma -f config/setup_db.psql
+docker stop akkoma_db_run # Replace with the name you noted down
+```
+
+Now we can actually run our migrations
+
+```bash
+./docker-resources/manage.sh mix ecto.migrate
+# this will recompile your files at the same time, since we changed the config
+```
+
+### Start the server
+
+We're going to run it in the foreground on the first run, just to make sure
+everything start up.
+
+```bash
+docker-compose up
+```
+
+If everything went well, you should be able to access your instance at http://localhost:4000
+
+You can `ctrl-c` out of the docker-compose now to shutdown the server.
+
+### Running in the background
+
+```bash
+docker-compose up -d
+```
+
+### Create your first user
+
+If your instance is up and running, you can create your first user with administrative rights with the following task:
+
+```shell
+./docker-resources/manage.sh mix pleroma.user new MY_USERNAME MY_EMAIL@SOMEWHERE --admin
+```
+
+And follow the prompts
+
+### Reverse proxies
+
+This is a tad more complex in docker than on the host itself. It
+
+You've got two options.
+
+#### Running caddy in a container
+
+This is by far the easiest option. It'll handle HTTPS and all that for you.
+
+```bash
+cp docker-resources/Caddyfile.example docker-resources/Caddyfile
+```
+
+Then edit the TLD in your caddyfile to the domain you're serving on.
+
+Uncomment the `caddy` section in the docker-compose file,
+then run `docker-compose up -d` again.
+
+#### Running a reverse proxy on the host
+
+If you want, you can also run the reverse proxy on the host. This is a bit more complex, but it's also more flexible.
+
+Follow the guides for source install for your distribution of choice, or adapt
+as needed. Your standard setup can be found in the [Debian Guide](../debian_based_en/#nginx)
+
+### You're done!
+
+All that's left is to set up your frontends.
+
+The standard from-source commands will apply to you, just make sure you
+prefix them with `./docker-resources/manage.sh`!
+
+{! installation/frontends.include !}
+
+### Updating Docker Installs
+
+```bash
+git pull
+./docker-resources/build.sh
+./docker-resources/manage.sh mix deps.get
+./docker-resources/manage.sh mix compile
+./docker-resources/manage.sh mix ecto.migrate
+docker-compose restart akkoma
+```
+
+#### Further reading
+
+{! installation/further_reading.include !}
+
+{! support.include !}
mix pleroma.frontend install admin-fe --ref stable
```
+=== "Docker"
+ ```sh
+ ./docker-resources/manage.sh mix pleroma.frontend install pleroma-fe --ref stable
+ ./docker-resources/manage.sh mix pleroma.frontend install admin-fe --ref stable
+ ```
+
For more customised installations, refer to [Frontend Management](../../configuration/frontend_management)
projects / akkoma / commitdiff