ehlxr/pleroma-docker
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

tmp

Browse Source
This commit is contained in:
sn0w 2018-08-20 23:06:34 +02:00
parent 2ea5c3b1d2
commit 1abd956c1a
8 changed files with 151 additions and 111 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
.env.dist
View File

@ -37,6 +37,11 @@ DOCKER_NETWORK=pleroma
# Named docker volumes are currently not supported. # Named docker volumes are currently not supported.
DOCKER_DATADIR=./data DOCKER_DATADIR=./data
# The uid/gid used by pleroma.
# custom.d will be automatically chown'ed to this.
DOCKER_UID=1000
DOCKER_GID=1000
########################### ###########################
# Database settings # # Database settings #
########################### ###########################

1
.gitignore vendored
View File

@ -71,3 +71,4 @@ $RECYCLE.BIN/
# End of https://www.gitignore.io/api/osx,linux,windows # End of https://www.gitignore.io/api/osx,linux,windows
debug.d

82
Dockerfile
View File

@ -1,37 +1,69 @@
FROM elixir:1.6-alpine FROM elixir:1.7-slim
ENV MIX_HOME /mix ENV DEBIAN_FRONTEND=noninteractive
ENV MIX_ARCHIVES /mix-archives ENV LANG=C.UTF-8
ENV MIX_ENV=prod
# Prepare system VOLUME /custom.d
RUN apk add --no-cache --virtual .build alpine-sdk git rsync
# Bust the cache with a build arg EXPOSE 4000
# that is different on every build
# Register pseudo-entrypoint
ADD ./entrypoint.sh /
RUN chmod +x /entrypoint.sh
CMD ["/entrypoint.sh"]
# Set "real" entrypoint to an init system.
# TODO: Replace with --init when docker 18.06 is GA
ENV TINI_VERSION v0.18.0
ADD https://github.com/krallin/tini/releases/download/${TINI_VERSION}/tini /tini
RUN chmod +x /tini
ENTRYPOINT ["/tini", "--"]
# Get git
RUN \
apt-get update \
&& apt-get install -y --no-install-recommends git ca-certificates \
&& rm -rf /var/lib/apt/lists/*
# Limit rights
ARG DOCKER_UID
ARG DOCKER_GID
ARG PLEROMA_UPLOADS_PATH
RUN \
addgroup --gid ${DOCKER_GID} pleroma \
&& adduser --system --home /pleroma --shell /bin/bash --ingroup pleroma --uid ${DOCKER_UID} pleroma \
&& mkdir -p /pleroma /custom.d $PLEROMA_UPLOADS_PATH \
&& touch /pleroma.md5 \
&& chown -R pleroma:pleroma /pleroma /pleroma.md5 /custom.d $PLEROMA_UPLOADS_PATH
USER pleroma
# Get the sources and rebar/hex
ARG PLEROMA_VERSION
WORKDIR /pleroma
RUN \
git clone --progress https://git.pleroma.social/pleroma/pleroma.git . \
&& mix local.hex --force \
&& mix local.rebar --force
# Bust the build cache
ARG __BUST_CACHE ARG __BUST_CACHE
ENV __BUST_CACHE $__BUST_CACHE ENV __BUST_CACHE $__BUST_CACHE
# Get the sources # Fetch changes, checkout
ARG PLEROMA_VERSION RUN \
WORKDIR /pleroma git fetch --all \
RUN git clone --progress https://git.pleroma.social/pleroma/pleroma.git . && git checkout $PLEROMA_VERSION && git checkout $PLEROMA_VERSION \
&& git pull --rebase --autostash
# Inject config # Modify sources
ADD ./docker-config.exs /docker-config.exs ADD ./docker-config.exs /docker-config.exs
RUN \ RUN \
ln -s /docker-config.exs config/prod.secret.exs && \ ln -s /docker-config.exs config/prod.secret.exs && \
ln -s /docker-config.exs config/dev.secret.exs ln -s /docker-config.exs config/dev.secret.exs
# Correct paths ADD ./custom.d /pleroma
WORKDIR /
VOLUME /custom.d
# Register entrypoint
ADD ./entrypoint.ash /
RUN chmod +x /entrypoint.ash
CMD ["/entrypoint.ash"]
# Call entrypoint to precompile pleroma
RUN /entrypoint.ash onbuild
EXPOSE 4000

4
README.md
View File

@ -68,7 +68,7 @@ If you need to fix some bigger issues you can also spawn a shell using `./plerom
## Customizing Pleroma ## Customizing Pleroma
Just add your customizations (and their folder structure) to `custom.d`.<br> Just add your customizations (and their folder structure) to `custom.d`.<br>
They will be copied (*not* mounted) into the right place when the container starts.<br> They will be mounted and symlinked into the right place when the container starts.<br>
You can even replace/patch pleroma's code with this, because the project is recompiled at startup.<br> You can even replace/patch pleroma's code with this, because the project is recompiled at startup.<br>
In general: Prepending `custom.d/` to pleroma's customization guides should work all the time.<br> In general: Prepending `custom.d/` to pleroma's customization guides should work all the time.<br>
@ -76,6 +76,8 @@ Check them out in the [official pleroma wiki](https://git.pleroma.social/pleroma
For example: A custom thumbnail now goes into `custom.d/priv/static/instance/thumbnail.jpeg` instead of `priv/static/instance/thumbnail.jpeg`. For example: A custom thumbnail now goes into `custom.d/priv/static/instance/thumbnail.jpeg` instead of `priv/static/instance/thumbnail.jpeg`.
Note: Since `custom.d` needs to be accessible at runtime by the pleroma process, the container will automatically chown these files to `$UID:$GID` from your `.env` file.
## Configuring Pleroma ## Configuring Pleroma
pleroma-docker tries to stay out of your way as much as possible while providing pleroma-docker tries to stay out of your way as much as possible while providing

5
docker-compose.m4
View File

@ -85,7 +85,10 @@ define(<env_inline_fb>, <${upcase($1):-$2}>)
"build": { "build": {
"context": ".", "context": ".",
"args": [ "args": [
"env(<pleroma_version>)" "env(<pleroma_version>)",
"env(<docker_uid>)",
"env(<docker_gid>)",
"env_fb(<pleroma_uploads_path>, </uploads>)",
] ]
}, },
"restart": "unless-stopped", "restart": "unless-stopped",

55
entrypoint.ash
View File

@ -1,55 +0,0 @@
#!/bin/ash
set -e
function compile {
# Make sure that the tooling is present
if [[ ! -d /mix-archives/hex-* ]] || [[ ! -f /mix/rebar ]] || [[ ! -f /mix/rebar3 ]]; then
mix local.hex --force
mix local.rebar --force
fi
# Recompile
mix deps.get
mix compile
}
# Execute onbuild actions if required
if [[ "$1" == "onbuild" ]]; then
# Pretend we're in runtime mode
mv /pleroma /pleroma-runtime
cd /pleroma-runtime
# Build pleroma
compile
# Put precompiled sources back
cd /
mv /pleroma-runtime /pleroma
exit 0
fi
# Ensure that the environment is clean
if [[ -d /pleroma-runtime ]]; then
rm -rf /pleroma-runtime
fi
mkdir /pleroma-runtime
# Copy sources
rsync -azI /pleroma/ /pleroma-runtime/
# Copy overrides
rsync -azI /custom.d/ /pleroma-runtime/
# Go to runtime workspace
cd /pleroma-runtime
# Build
compile
# Prepare DB
mix ecto.create
mix ecto.migrate
# Liftoff o/
exec mix phx.server

9
entrypoint.sh Executable file
View File

@ -0,0 +1,9 @@
#!/bin/bash
set -e
set -x
mix deps.get
mix ecto.create
mix ecto.migrate
exec mix phx.server

87
pleroma
View File

@ -1,6 +1,7 @@
#!/bin/bash #!/bin/bash
set -e set -e
set -o pipefail
print_help() { print_help() {
echo " echo "
@ -10,23 +11,36 @@ Usage:
$0 [action] $0 [action]
Actions: Actions:
build Rebuild the pleroma container build Rebuild the pleroma container.
start / up Start pleroma and sibling services dump Dump the generated docker-compose.yml to stdout.
stop / down Stop pleroma and sibling services debug [bin] [args...] Launches a new pleroma container but uses \$bin instead of phx.server as entrypoint.
**Warning**: This is intended for debugging pleroma with tools like :debugger and :observer.
It thus forwards your X-Server into docker and temporarily fiddles with your xhost
access controls. If this is a security concern for you, please export NO_X_FORWARDING=1
before launching a debugger session.
enter Spawn a shell inside the container for debugging/maintenance.
This command does not link to the postgres container.
If you need that use #debug instead.
logs Show the current container logs.
mix [task] [args...] Run a mix task without entering the container.
mod [file] Creates the file in custom.d and downloads the content from pleroma.social.
The download respects your \$PLEROMA_VERSION from .env.
passthrough / p [...] Pass any custom command to docker-compose.
restart Executes #stop and #start respectively. restart Executes #stop and #start respectively.
status / ps Show the current container status start / up Start pleroma and sibling services.
logs Show the current container logs stop / down Stop pleroma and sibling services.
enter Enter the pleroma container for debugging/maintenance status / ps Show the current container status.
mix [task] [args...] Run a mix task without entering the container
dump Dump the generated docker-compose.yml to stdout
Environment: Environment:
DEBUG can be used to modify the loglevel. DEBUG can be used to modify the loglevel.
@ -38,7 +52,7 @@ Environment:
-e is always on unless you set it to +e. -e is always on unless you set it to +e.
For setting long options with -o use a colon (:) instead of a space For setting long options with -o use a colon (:) instead of a space
to seperate the option from -o. For example: SHOPT='-x -e -o:pipefail' to seperate the option from -o. For example: SHOPT='-x -e -o:pipefail'.
Contributing: Contributing:
You can report bugs or contribute to this project at: You can report bugs or contribute to this project at:
@ -78,25 +92,54 @@ load_env() {
} }
action__build() { docker_compose build --build-arg __BUST_CACHE="$(date +%s)" server; } action__build() { docker_compose build --build-arg __BUST_CACHE="$(date +%s)" server; }
action__debug() { render_template; } action__dump() { cat <(render_template); }
action__down() { action__stop; }
action__enter() { docker_compose exec server ash -c 'cd /pleroma && ash'; } action__enter() { docker_compose exec server ash -c 'cd /pleroma && ash'; }
action__lint() { render_template | jq; }
action__logs() { docker_compose logs -f; } action__logs() { docker_compose logs -f; }
action__mix() { docker_compose exec server ash -c "cd /pleroma && mix $*"; } action__mix() { docker_compose exec server ash -c "cd /pleroma && mix $*"; }
action__ps() { action__status; } action__passthrough() { docker_compose $*; }
action__p() { action__passthrough $*; }
action__restart() { action__stop; action__start; } action__restart() { action__stop; action__start; }
action__start() { docker_compose up --remove-orphans -d; } action__start() { docker_compose up --remove-orphans -d; }
action__status() { docker_compose ps; }
action__stop() { docker_compose down; }
action__up() { action__start; } action__up() { action__start; }
action__dump() { action__stop() { docker_compose down; }
if command -v jq 2>&1 1>/dev/null; then action__down() { action__stop; }
cat <(render_template) | jq
else action__status() { docker_compose ps; }
cat <(render_template) action__ps() { action__status; }
###
# This function rips out the mix caches from the container
# in order to speed up rebuilds during debugging/modding sessions.
# To persist the changes, the user still needs to rebuild the container.
###
action__debug() {
debug_mounts="-v $(pwd)/custom.d:/custom.d -v $(pwd)/debug.d/build:/pleroma/_build -v $(pwd)/debug.d/deps:/pleroma/deps"
if [[ ! -d ./debug.d ]]; then
mkdir -p ./debug.d/{build,deps}
fi fi
action__stop
docker_compose run --rm -u pleroma -w /pleroma $debug_mounts server bash -c 'mix deps.get && mix compile'
x_flags=""
if [[ $NO_X_FORWARDING != 1 ]]; then
x_flags="-e DISPLAY=$DISPLAY -v /tmp/.X11-unix:/tmp/.X11-unix -v $HOME/.Xauthority:/pleroma/.Xauthority"
fi
[[ $NO_X_FORWARDING == 1 ]] || xhost +local:root
docker_compose run --rm -u pleroma -w /pleroma $debug_mounts $x_flags server bash -c "cp -rf /custom.d/* /pleroma && $*"
[[ $NO_X_FORWARDING == 1 ]] || xhost -local:root
}
action__mod() {
echo "Preparing 'custom.d/$1' for modding..."
install -D <(echo '') ./custom.d/$1
wget -O ./custom.d/$1 https://git.pleroma.social/pleroma/pleroma/raw/$PLEROMA_VERSION/$1
} }
# Check if there is any command at all # Check if there is any command at all