Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(framework:*) Improve Docker docs #4758

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions framework/docs/source/docker/enable-tls.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,11 @@ Transport Layer Security (TLS) for each Flower component to ensure secure commun

.. note::

Because Flower containers, by default, run with a non-root user ``app``, the mounted
files and directories must have the proper permissions for the user ID ``49999``.
When working with Docker Compose on Linux, you may need to change the ownership of
the directory containing the certificates to ensure proper access and permissions.

By default, Flower containers run with a non-root user ``app``. The mounted files
and directories must have the proper permissions for the user ID ``49999``.

For example, to change the user ID of all files in the ``certificates/`` directory,
you can run ``sudo chown -R 49999:49999 certificates/*``.
Expand Down
5 changes: 3 additions & 2 deletions framework/docs/source/docker/persist-superlink-state.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,9 @@ do is specify a directory where you want to save the file on your host system an
for the database file.

By default, the SuperLink container runs with a non-root user called ``app`` with the
user ID ``49999``. It is recommended to create a new directory and change the user ID of
the directory to ``49999`` to ensure the mounted directory has the proper permissions.
user ID ``49999``. When working with Docker Compose on Linux, it is recommended to
create a new directory and set the user ID to ``49999`` to ensure the mounted directory
has the proper permissions.

If you later want to delete the directory, you can change the user ID back to the
current user ID by running ``sudo chown -R $USER:$(id -gn) state``.
Expand Down
2 changes: 1 addition & 1 deletion src/docker/base/alpine/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ FROM python:${PYTHON_VERSION}-${DISTRO}${DISTRO_VERSION} AS compile

# Install system dependencies
RUN apk add --no-cache \
# require for compiling grpcio on ARM64
# required for compiling grpcio on ARM64
g++ \
libffi-dev \
# required for installing flwr via git
Expand Down
3 changes: 2 additions & 1 deletion src/docker/complete/compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ services:
depends_on:
- superlink

# create a two SuperNode service with different node configs
# create a two SuperNode services with different node configs
supernode-1:
image: flwr/supernode:${FLWR_VERSION:-1.15.0}
command:
Expand Down Expand Up @@ -86,6 +86,7 @@ services:
# depends_on:
# - superlink

# create a two ClientApp services
clientapp-1:
build:
context: ${PROJECT_DIR:-.}
Expand Down
Loading