Skip to content

Commit

Permalink
Document new Docker group ID option
Browse files Browse the repository at this point in the history
  • Loading branch information
martinburchell committed Jun 22, 2024
1 parent cb83324 commit 7c007d0
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 1 deletion.
2 changes: 2 additions & 0 deletions docker/dockerfiles/docker-compose.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@
# CRATE_DOCKER_CONFIG_HOST_DIR
# CRATE_DOCKER_FILES_HOST_DIR
# CRATE_DOCKER_GATE_BIOYODIE_RESOURCES_HOST_DIR
# CRATE_DOCKER_INSTALL_GROUP_ID
# CRATE_DOCKER_INSTALL_USER_ID
# CRATE_DOCKER_MYSQL_CRATE_USER_PASSWORD
# CRATE_DOCKER_MYSQL_CRATE_ROOT_PASSWORD
# CRATE_DOCKER_STATIC_HOST_DIR
Expand Down
2 changes: 2 additions & 0 deletions docs/source/changelog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1658,6 +1658,8 @@ Changes

**0.20.5, in progress**

- When the Docker image is built, it is now possible to specify both a user ID and a group ID
so that file systems shared between the host and the container have the correct permissions.

To do
-----
Expand Down
20 changes: 19 additions & 1 deletion docs/source/installation/docker.rst
Original file line number Diff line number Diff line change
Expand Up @@ -306,8 +306,8 @@ GATE). (You need to download UMLS data and use the
directory used with that command is the directory you should specify here.)
On Windows, ensure this is within the Windows (not WSL2) file system.

.. _CRATE_DOCKER_GATE_VERSION:

.. _CRATE_DOCKER_GATE_VERSION:

CRATE_DOCKER_GATE_VERSION
^^^^^^^^^^^^^^^^^^^^^^^^^
Expand All @@ -317,6 +317,24 @@ CRATE_DOCKER_GATE_VERSION
Version of GATE to be installed.


.. _CRATE_DOCKER_INSTALL_GROUP_ID:

CRATE_DOCKER_INSTALL_GROUP_ID
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

**No default. Must be set to the ID of a group on the host so that file systems
can be shared.** See :ref:`CRATE_DOCKER_INSTALL_USER_ID <CRATE_DOCKER_INSTALL_USER_ID>`


.. _CRATE_DOCKER_INSTALL_USER_ID:

CRATE_DOCKER_INSTALL_USER_ID
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

**No default. Must be set to the ID of a user on the host so that file systems
can be shared.** See :ref:`CRATE_DOCKER_INSTALL_GROUP_ID <CRATE_DOCKER_INSTALL_GROUP_ID>`


.. _CRATE_DOCKER_MYSQL_CRATE_DATABASE_NAME:

CRATE_DOCKER_MYSQL_CRATE_DATABASE_NAME
Expand Down

0 comments on commit 7c007d0

Please sign in to comment.