2019-02-05 14:42:21 +01:00
|
|
|
# Dockerfile to build the matrixdotorg/synapse docker images.
|
|
|
|
#
|
2022-01-12 11:37:57 +01:00
|
|
|
# Note that it uses features which are only available in BuildKit - see
|
|
|
|
# https://docs.docker.com/go/buildkit/ for more information.
|
|
|
|
#
|
2019-02-05 14:42:21 +01:00
|
|
|
# To build the image, run `docker build` command from the root of the
|
|
|
|
# synapse repository:
|
|
|
|
#
|
2022-01-12 11:37:57 +01:00
|
|
|
# DOCKER_BUILDKIT=1 docker build -f docker/Dockerfile .
|
2019-02-05 14:42:21 +01:00
|
|
|
#
|
|
|
|
# There is an optional PYTHON_VERSION build argument which sets the
|
|
|
|
# version of python to build against: for example:
|
|
|
|
#
|
2022-03-01 14:55:18 +01:00
|
|
|
# DOCKER_BUILDKIT=1 docker build -f docker/Dockerfile --build-arg PYTHON_VERSION=3.10 .
|
2019-02-05 14:42:21 +01:00
|
|
|
#
|
|
|
|
|
2022-04-07 13:43:31 +02:00
|
|
|
# Irritatingly, there is no blessed guide on how to distribute an application with its
|
|
|
|
# poetry-managed environment in a docker image. We have opted for
|
|
|
|
# `poetry export | pip install -r /dev/stdin`, but there are known bugs in
|
|
|
|
# in `poetry export` whose fixes (scheduled for poetry 1.2) have yet to be released.
|
|
|
|
# In case we get bitten by those bugs in the future, the recommendations here might
|
|
|
|
# be useful:
|
|
|
|
# https://github.com/python-poetry/poetry/discussions/1879#discussioncomment-216865
|
|
|
|
# https://stackoverflow.com/questions/53835198/integrating-python-poetry-with-docker?answertab=scoredesc
|
|
|
|
|
|
|
|
|
|
|
|
|
2022-03-01 14:55:18 +01:00
|
|
|
ARG PYTHON_VERSION=3.9
|
2018-02-03 20:18:36 +01:00
|
|
|
|
2018-10-01 13:29:17 +02:00
|
|
|
###
|
2022-04-07 13:43:31 +02:00
|
|
|
### Stage 0: generate requirements.txt
|
2018-10-01 13:29:17 +02:00
|
|
|
###
|
2022-04-07 13:43:31 +02:00
|
|
|
FROM docker.io/python:${PYTHON_VERSION}-slim as requirements
|
2018-09-10 16:02:42 +02:00
|
|
|
|
2022-01-12 11:37:57 +01:00
|
|
|
# RUN --mount is specific to buildkit and is documented at
|
|
|
|
# https://github.com/moby/buildkit/blob/master/frontend/dockerfile/docs/syntax.md#build-mounts-run---mount.
|
2022-04-07 13:43:31 +02:00
|
|
|
# Here we use it to set up a cache for apt (and below for pip), to improve
|
|
|
|
# rebuild speeds on slow connections.
|
|
|
|
RUN \
|
|
|
|
--mount=type=cache,target=/var/cache/apt,sharing=locked \
|
|
|
|
--mount=type=cache,target=/var/lib/apt,sharing=locked \
|
|
|
|
apt-get update && apt-get install -y git \
|
|
|
|
&& rm -rf /var/lib/apt/lists/*
|
|
|
|
|
|
|
|
# We install poetry in its own build stage to avoid its dependencies conflicting with
|
|
|
|
# synapse's dependencies.
|
|
|
|
# We use a specific commit from poetry's master branch instead of our usual 1.1.12,
|
|
|
|
# to incorporate fixes to some bugs in `poetry export`. This commit corresponds to
|
|
|
|
# https://github.com/python-poetry/poetry/pull/5156 and
|
|
|
|
# https://github.com/python-poetry/poetry/issues/5141 ;
|
|
|
|
# without it, we generate a requirements.txt with incorrect environment markers,
|
|
|
|
# which causes necessary packages to be omitted when we `pip install`.
|
2022-01-12 11:37:57 +01:00
|
|
|
#
|
2022-04-07 13:43:31 +02:00
|
|
|
# NB: In poetry 1.2 `poetry export` will be moved into a plugin; we'll need to also
|
|
|
|
# pip install poetry-plugin-export (https://github.com/python-poetry/poetry-plugin-export).
|
|
|
|
RUN --mount=type=cache,target=/root/.cache/pip \
|
|
|
|
pip install --user git+https://github.com/python-poetry/poetry.git@fb13b3a676f476177f7937ffa480ee5cff9a90a5
|
|
|
|
|
|
|
|
WORKDIR /synapse
|
|
|
|
|
|
|
|
# Copy just what we need to run `poetry export`...
|
|
|
|
COPY pyproject.toml poetry.lock README.rst /synapse/
|
|
|
|
|
|
|
|
RUN /root/.local/bin/poetry export --extras all -o /synapse/requirements.txt
|
|
|
|
|
|
|
|
###
|
|
|
|
### Stage 1: builder
|
|
|
|
###
|
|
|
|
FROM docker.io/python:${PYTHON_VERSION}-slim as builder
|
|
|
|
|
|
|
|
# install the OS build deps
|
2022-01-12 11:37:57 +01:00
|
|
|
RUN \
|
|
|
|
--mount=type=cache,target=/var/cache/apt,sharing=locked \
|
|
|
|
--mount=type=cache,target=/var/lib/apt,sharing=locked \
|
|
|
|
apt-get update && apt-get install -y \
|
2021-03-26 19:42:58 +01:00
|
|
|
build-essential \
|
|
|
|
libffi-dev \
|
|
|
|
libjpeg-dev \
|
|
|
|
libpq-dev \
|
|
|
|
libssl-dev \
|
|
|
|
libwebp-dev \
|
|
|
|
libxml++2.6-dev \
|
|
|
|
libxslt1-dev \
|
|
|
|
openssl \
|
|
|
|
rustc \
|
|
|
|
zlib1g-dev \
|
|
|
|
&& rm -rf /var/lib/apt/lists/*
|
|
|
|
|
|
|
|
# To speed up rebuilds, install all of the dependencies before we copy over
|
2022-04-07 13:43:31 +02:00
|
|
|
# the whole synapse project, so that this layer in the Docker cache can be
|
2021-03-26 19:42:58 +01:00
|
|
|
# used while you develop on the source
|
|
|
|
#
|
2022-04-07 13:43:31 +02:00
|
|
|
# This is aiming at installing the `[tool.poetry.depdendencies]` from pyproject.toml.
|
|
|
|
COPY --from=requirements /synapse/requirements.txt /synapse/
|
2022-01-12 11:37:57 +01:00
|
|
|
RUN --mount=type=cache,target=/root/.cache/pip \
|
2022-04-12 11:16:01 +02:00
|
|
|
pip install --prefix="/install" --no-deps --no-warn-script-location -r /synapse/requirements.txt
|
2021-03-26 19:42:58 +01:00
|
|
|
|
2022-04-07 13:43:31 +02:00
|
|
|
# Copy over the rest of the synapse source code.
|
2021-03-26 19:42:58 +01:00
|
|
|
COPY synapse /synapse/synapse/
|
2022-04-07 13:43:31 +02:00
|
|
|
# ... and what we need to `pip install`.
|
|
|
|
# TODO: once pyproject.toml declares poetry-core as its build system, we'll need to copy
|
|
|
|
# pyproject.toml here, ditching setup.py and MANIFEST.in.
|
|
|
|
COPY setup.py MANIFEST.in README.rst /synapse/
|
2021-03-26 19:42:58 +01:00
|
|
|
|
2022-04-07 13:43:31 +02:00
|
|
|
# Install the synapse package itself.
|
2021-03-26 19:42:58 +01:00
|
|
|
RUN pip install --prefix="/install" --no-deps --no-warn-script-location /synapse
|
2018-10-01 13:29:17 +02:00
|
|
|
|
|
|
|
###
|
2022-04-07 13:43:31 +02:00
|
|
|
### Stage 2: runtime
|
2018-10-01 13:29:17 +02:00
|
|
|
###
|
|
|
|
|
2020-07-17 18:40:53 +02:00
|
|
|
FROM docker.io/python:${PYTHON_VERSION}-slim
|
2018-10-01 13:29:17 +02:00
|
|
|
|
2021-04-08 14:49:14 +02:00
|
|
|
LABEL org.opencontainers.image.url='https://matrix.org/docs/projects/server/synapse'
|
|
|
|
LABEL org.opencontainers.image.documentation='https://github.com/matrix-org/synapse/blob/master/docker/README.md'
|
|
|
|
LABEL org.opencontainers.image.source='https://github.com/matrix-org/synapse.git'
|
|
|
|
LABEL org.opencontainers.image.licenses='Apache-2.0'
|
|
|
|
|
2022-01-12 11:37:57 +01:00
|
|
|
RUN \
|
|
|
|
--mount=type=cache,target=/var/cache/apt,sharing=locked \
|
|
|
|
--mount=type=cache,target=/var/lib/apt,sharing=locked \
|
|
|
|
apt-get update && apt-get install -y \
|
2021-03-26 19:42:58 +01:00
|
|
|
curl \
|
|
|
|
gosu \
|
|
|
|
libjpeg62-turbo \
|
|
|
|
libpq5 \
|
|
|
|
libwebp6 \
|
|
|
|
xmlsec1 \
|
|
|
|
libjemalloc2 \
|
|
|
|
libssl-dev \
|
|
|
|
openssl \
|
|
|
|
&& rm -rf /var/lib/apt/lists/*
|
2018-10-01 13:29:17 +02:00
|
|
|
|
|
|
|
COPY --from=builder /install /usr/local
|
|
|
|
COPY ./docker/start.py /start.py
|
|
|
|
COPY ./docker/conf /conf
|
|
|
|
|
2019-02-05 14:42:21 +01:00
|
|
|
EXPOSE 8008/tcp 8009/tcp 8448/tcp
|
2018-02-04 12:55:20 +01:00
|
|
|
|
2018-02-03 20:18:36 +01:00
|
|
|
ENTRYPOINT ["/start.py"]
|
2020-08-24 19:15:18 +02:00
|
|
|
|
2021-05-05 17:33:04 +02:00
|
|
|
HEALTHCHECK --start-period=5s --interval=15s --timeout=5s \
|
2021-03-26 19:42:58 +01:00
|
|
|
CMD curl -fSs http://localhost:8008/health || exit 1
|