Merge pull request #223 from entelecheia/main

Main

.copier-docker-config.yaml

@@ -1,5 +1,5 @@
 # Changes here will be overwritten by Copier; do NOT edit manually
-_commit: v0.30.0-6-gbd443ac
+_commit: v0.30.6-10-g90bb37e
 _src_path: .
 app_dirname: entelecheia
 app_install_root: /opt
@@ -73,6 +73,7 @@ use_deploy_workflows: true
 use_jupyter: true
 use_semantic_versioning_for_image: true
 use_ssh_service: true
+use_tty: false
 use_web_service: true
 web_service_host_port: 19090
 web_service_port: 8080

.copier-template/.docker/scripts/`{{ launch_scripts }}`.jinja

@@ -35,14 +35,15 @@ fi
 # set token to value of JUPYTER_TOKEN
 # set port to value of JUPYTER_DOCKER_PORT
 if [[ -z "$(command -v jupyter)" ]]; then
-    echo "Jupyter not installed. Exiting..."
-    exit 1
+    echo "Jupyter not installed."
+else
+    echo "Starting Jupyter Lab..."
+    jupyter lab \
+        --no-browser \
+        --notebook-dir="$WORKSPACE_ROOT" \
+        --ServerApp.token="$JUPYTER_TOKEN" \
+        --port="$JUPYTER_PORT" \
+        --ip=0.0.0.0 \
+        --allow-root
 fi
-{% if not install_dotfiles %}exec gosu "${USER}" {% endif %}jupyter lab \
-    --no-browser \
-    --notebook-dir="$WORKSPACE_ROOT" \
-    --ServerApp.token="$JUPYTER_TOKEN" \
-    --port="$JUPYTER_PORT" \
-    --ip=0.0.0.0 \
-    --allow-root
 {%- endif %}

.copier-template/.docker/scripts/entrypoint.sh.jinja

@@ -31,7 +31,7 @@ if [ "$USER_UID" != "$LOCAL_UID" ]; then
         echo "Changing ownership of $APP_INSTALL_ROOT directory to $USER_UID:$USER_UID"
         chown -R "$USER_UID:$USER_UID" "$APP_INSTALL_ROOT"
     fi
-    if [ -n "$WORKSPACE_ROOT" ] && [ -d "$WORKSPACE_ROOT" ]; then
+    if [ -n "$WORKSPACE_ROOT" ] && [ -d "$WORKSPACE_ROOT" ] && [ "$WORKSPACE_ROOT" != "$APP_INSTALL_ROOT" ]; then
         echo "Changing ownership of workspace directory [$WORKSPACE_ROOT] to $USER_UID:$USER_UID"
         chown -R "$USER_UID:$USER_UID" "$WORKSPACE_ROOT"
     fi

.copier-template/.docker/{% if build_images_from_dockerfile %}docker-compose.`{{ docker_image_variant_name }}`.yaml{% endif %}.jinja

@@ -28,10 +28,12 @@ services:
     image: $IMAGE_NAME:$IMAGE_TAG
     # Sets the hostname of the container
     hostname: $CONTAINER_HOSTNAME
-    command:
-      # Specifies the command to be executed when the container is run
-      - bash
-      - $CONTAINER_LAUNCH_SCRIPT
+    # Sets tty to true if the container needs a pseudo-TTY
+    tty: `{{ use_tty | lower }}`
+    {% if use_tty %}# {% endif %}command:
+    {% if use_tty %}# {% endif %}  # Specifies the command to be executed when the container is run
+    {% if use_tty %}# {% endif %}  - bash
+    {% if use_tty %}# {% endif %}  - $CONTAINER_LAUNCH_SCRIPT
     # set the environment variables
     environment:
       USER_UID: $CONTAINER_USER_UID

.copier-template/.github/workflows/{% if use_deploy_workflows %}deploy-`{{ docker_image_variant_name }}`-image.yaml{% endif %}.jinja

@@ -73,7 +73,7 @@ jobs:
       # It uses the `context` parameter to define the build's context as the set of files located in the specified path. For more information, see "[Usage](https://github.com/docker/build-push-action#usage)" in the README of the `docker/build-push-action` repository.
       # It uses the `tags` and `labels` parameters to tag and label the image with the output from the "meta" step.
       - name: Build and push Docker image
-        uses: docker/build-push-action@v6.1.0
+        uses: docker/build-push-action@v6.3.0
         with:
           context: .
           file: ./.docker/Dockerfile.`{{ docker_image_variant_name }}`

.docker/docker-compose.base.yaml

@@ -26,6 +26,8 @@ services:
     image: $IMAGE_NAME:$IMAGE_TAG
     # Sets the hostname of the container
     hostname: $CONTAINER_HOSTNAME
+    # Sets tty to true if the container needs a pseudo-TTY
+    tty: false
     command:
       # Specifies the command to be executed when the container is run
       - bash

.docker/docker.version

@@ -1 +1 @@
-IMAGE_VERSION="0.30.6"                    # The version of the project
+IMAGE_VERSION="0.31.0"                    # The version of the project

.docker/scripts/entrypoint.sh

@@ -31,7 +31,7 @@ if [ "$USER_UID" != "$LOCAL_UID" ]; then
         echo "Changing ownership of $APP_INSTALL_ROOT directory to $USER_UID:$USER_UID"
         chown -R "$USER_UID:$USER_UID" "$APP_INSTALL_ROOT"
     fi
-    if [ -n "$WORKSPACE_ROOT" ] && [ -d "$WORKSPACE_ROOT" ]; then
+    if [ -n "$WORKSPACE_ROOT" ] && [ -d "$WORKSPACE_ROOT" ] && [ "$WORKSPACE_ROOT" != "$APP_INSTALL_ROOT" ]; then
         echo "Changing ownership of workspace directory [$WORKSPACE_ROOT] to $USER_UID:$USER_UID"
         chown -R "$USER_UID:$USER_UID" "$WORKSPACE_ROOT"
     fi

.docker/scripts/launch.sh

@@ -19,13 +19,14 @@ sudo service ssh start
 # set token to value of JUPYTER_TOKEN
 # set port to value of JUPYTER_DOCKER_PORT
 if [[ -z "$(command -v jupyter)" ]]; then
-    echo "Jupyter not installed. Exiting..."
-    exit 1
+    echo "Jupyter not installed."
+else
+    echo "Starting Jupyter Lab..."
+    jupyter lab \
+        --no-browser \
+        --notebook-dir="$WORKSPACE_ROOT" \
+        --ServerApp.token="$JUPYTER_TOKEN" \
+        --port="$JUPYTER_PORT" \
+        --ip=0.0.0.0 \
+        --allow-root
 fi
-jupyter lab \
-    --no-browser \
-    --notebook-dir="$WORKSPACE_ROOT" \
-    --ServerApp.token="$JUPYTER_TOKEN" \
-    --port="$JUPYTER_PORT" \
-    --ip=0.0.0.0 \
-    --allow-root

.github/workflows/deploy-base-image.yaml

@@ -73,7 +73,7 @@ jobs:
       # It uses the `context` parameter to define the build's context as the set of files located in the specified path. For more information, see "[Usage](https://github.com/docker/build-push-action#usage)" in the README of the `docker/build-push-action` repository.
       # It uses the `tags` and `labels` parameters to tag and label the image with the output from the "meta" step.
       - name: Build and push Docker image
-        uses: docker/build-push-action@v6.1.0
+        uses: docker/build-push-action@v6.3.0
         with:
           context: .
           file: ./.docker/Dockerfile.base

CHANGELOG.md

@@ -1,5 +1,17 @@
 <!--next-version-placeholder-->
 
+## v0.31.0 (2024-07-04)
+
+### Feature
+
+* **docker:** Add support for tty configuration in Docker containers ([`f23dad5`](https://github.com/entelecheia/hyperfast-docker-template/commit/f23dad5df1b3d75038d9571e5cc248a832a71642))
+
+### Fix
+
+* **docker:** Add message before starting Jupyter Lab ([`528bcb8`](https://github.com/entelecheia/hyperfast-docker-template/commit/528bcb83ba500c19e8b47ba1253180008aacee54))
+* **workflows:** Upgrade docker/build-push-action to 63.0 ([`81e6bf5`](https://github.com/entelecheia/hyperfast-docker-template/commit/81e6bf5b860c1312f5df506594a9f5f7c3a25c8e))
+* **docker:** Correct typo in `tty` Jinja2 template variable ([`b908113`](https://github.com/entelecheia/hyperfast-docker-template/commit/b908113477405671b0f624f6b31d1958348cdf39))
+
 ## v0.30.6 (2024-06-23)
 
 ### Fix

copier.yaml

@@ -208,6 +208,11 @@ cuda_device_id:
   type: str
   help: "What is your CUDA device to use? (default: all)"
 
+use_tty:
+  default: false
+  type: bool
+  help: Do you want to enable tty (pseudo-terminal) when running the Docker container?
+
 use_ssh_service:
   default: true
   type: bool

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "hyperfast-docker-template"
-version = "0.30.6"
+version = "0.31.0"
 description = "Hyperfast Docker Template is a powerful tool that leverages copier to streamline the creation of new Docker projects. It simplifies and accelerates Docker configurations, fostering a highly efficient and user-friendly development experience."
 authors = ["Young Joon Lee <entelecheia@hotmail.com>"]
 license = "MIT"

tmp/.copier-docker-config.yaml

@@ -1,5 +1,5 @@
 # Changes here will be overwritten by Copier; do NOT edit manually
-_commit: v0.29.2-4-g59101f8
+_commit: v0.30.6-4-gd74e456
 _src_path: .
 app_dirname: entelecheia
 app_install_root: /workspace/projects
@@ -73,6 +73,7 @@ use_deploy_workflows: true
 use_jupyter: true
 use_semantic_versioning_for_image: true
 use_ssh_service: true
+use_tty: false
 use_web_service: true
 web_service_host_port: 18080
 web_service_port: 8080

tmp/.docker/.docker-scripts/docker-compose.sh

@@ -150,6 +150,7 @@ fi
 set +a
 
 # prepare docker network
+CONTAINER_NETWORK_NAME=${CONTAINER_NETWORK_NAME:-""}
 if [[ -n "${CONTAINER_NETWORK_NAME}" ]] && ! docker network ls | grep -q "${CONTAINER_NETWORK_NAME}"; then
     echo "Creating network ${CONTAINER_NETWORK_NAME}"
     docker network create "${CONTAINER_NETWORK_NAME}"
@@ -159,11 +160,16 @@ fi
 
 # prepare local workspace to be mounted
 echo "Preparing local workspace directories"
-[ ! -d "${HOST_WORKSPACE_ROOT}" ] && mkdir -p "${HOST_WORKSPACE_ROOT}"
-[ ! -d "${HOST_SCRIPTS_DIR}" ] && cp -r "$PWD/.docker/scripts" "${HOST_SCRIPTS_DIR}"
-[ ! -d "${HOST_SSH_DIR}" ] && mkdir -p "${HOST_SSH_DIR}"
-[ ! -d "${HOST_CACHE_DIR}" ] && mkdir -p "${HOST_CACHE_DIR}"
-[ ! -d "${HOST_HF_HOME}" ] && mkdir -p "${HOST_HF_HOME}"
+HOST_WORKSPACE_ROOT="${HOST_WORKSPACE_ROOT:-}"
+[ -n "${HOST_WORKSPACE_ROOT}" ] && [ ! -d "${HOST_WORKSPACE_ROOT}" ] && mkdir -p "${HOST_WORKSPACE_ROOT}"
+HOST_SCRIPTS_DIR="${HOST_SCRIPTS_DIR:-}"
+[ -n "${HOST_SCRIPTS_DIR}" ] && [ ! -d "${HOST_SCRIPTS_DIR}" ] && cp -r "$PWD/.docker/scripts" "${HOST_SCRIPTS_DIR}"
+HOST_SSH_DIR="${HOST_SSH_DIR:-}"
+[ -n "${HOST_SSH_DIR}" ] && [ ! -d "${HOST_SSH_DIR}" ] && mkdir -p "${HOST_SSH_DIR}"
+HOST_CACHE_DIR="${HOST_CACHE_DIR:-}"
+[ -n "${HOST_CACHE_DIR}" ] && [ ! -d "${HOST_CACHE_DIR}" ] && mkdir -p "${HOST_CACHE_DIR}"
+HOST_HF_HOME="${HOST_HF_HOME:-}"
+[ -n "${HOST_HF_HOME}" ] && [ ! -d "${HOST_HF_HOME}" ] && mkdir -p "${HOST_HF_HOME}"
 
 # run docker-compose
 if [ "${COMMAND}" == "push" ]; then

tmp/.docker/Dockerfile.base

@@ -1,6 +1,5 @@
 # Sets the base image for subsequent instructions
-ARG ARG_BUILD_FROM="library/ubuntu:22.04"
-FROM $ARG_BUILD_FROM AS builder
+FROM library/ubuntu:22.04 AS builder
 
 # Sets labels for the image
 LABEL org.opencontainers.image.source="https://github.com/entelecheia/hyperfast-docker-template"
@@ -11,7 +10,7 @@ LABEL org.opencontainers.image.licenses="MIT"
 ARG DEBIAN_FRONTEND=noninteractive
 # Updates the image and installs necessary packages
 RUN apt-get update --fix-missing \
-    && apt-get install -y curl wget jq sudo gosu git build-essential \
+    && apt-get install -y curl wget jq sudo gosu git build-essential software-properties-common \
     locales locales-all fontconfig fonts-nanum \
     tzdata openssh-server \
     # Cleans up unnecessary packages to reduce image size
@@ -57,20 +56,33 @@ ENV USER_UID $ARG_USER_UID
 ENV USER_GID $ARG_USER_GID
 
 # Creates a non-root user with sudo privileges
-RUN groupadd --gid $USER_GID $USERNAME \
-    && adduser --uid $USER_UID --gid $USER_GID --force-badname --disabled-password --gecos "" $USERNAME  \
-    && echo "$USERNAME:$USERNAME" | chpasswd \
-    && adduser $USERNAME sudo \
-    && echo "$USERNAME ALL=(ALL) NOPASSWD:ALL" >> /etc/sudoers \
-    && echo "$USERNAME ALL=(ALL) NOPASSWD:ALL" > /etc/sudoers.d/$USERNAME \
-    && chmod 0440 /etc/sudoers.d/$USERNAME
-
+# check if user exists and if not, create user
+RUN if id -u $USERNAME >/dev/null 2>&1; then \
+        # if the current user's user id is different from the specified user id, change the user id of the current user to the specified user id
+        if [ "$USER_UID" -ne "$(id -u $USERNAME)" ]; then \
+            usermod --uid $USER_UID $USERNAME; \
+            chown --recursive $USER_UID:$USER_UID $WORKSPACE_ROOT; \
+            chown --recursive $USER_UID:$USER_UID $APP_INSTALL_ROOT; \
+        fi; \
+    else \
+        groupadd --gid $USER_GID $USERNAME && \
+        adduser --uid $USER_UID --gid $USER_GID --force-badname --disabled-password --gecos "" $USERNAME && \
+        echo "$USERNAME:$USERNAME" | chpasswd && \
+        adduser $USERNAME sudo && \
+        echo "$USERNAME ALL=(ALL) NOPASSWD:ALL" >> /etc/sudoers && \
+        echo "$USERNAME ALL=(ALL) NOPASSWD:ALL" > /etc/sudoers.d/$USERNAME && \
+        chmod 0440 /etc/sudoers.d/$USERNAME; \
+    fi
 
 
 USER root
-RUN chown --recursive "${USER_UID}:${USER_GID}" "${WORKSPACE_ROOT}"
-RUN chown --recursive "${USER_UID}:${USER_GID}" "${APP_INSTALL_ROOT}"
-USER $USERNAME
 
+# Copies entrypoint script from host into the image
+COPY ./.docker/scripts/entrypoint.sh /usr/local/bin/entrypoint.sh
+# Changes the entrypoint script permissions to make it executable
+RUN chmod +x /usr/local/bin/entrypoint.sh
+# Sets the entrypoint script as the default command that will be executed when the container is run
+ENTRYPOINT ["/usr/local/bin/entrypoint.sh"]
+
 # Specifies the command that will be executed when the container is run
 CMD ["bash"]

tmp/.docker/docker-compose.base.yaml

@@ -1,5 +1,3 @@
-version: "3"
-
 services:
   # Defines a service name
   workspace:
@@ -22,6 +20,8 @@ services:
     image: $IMAGE_NAME:$IMAGE_TAG
     # Sets the hostname of the container
     hostname: $CONTAINER_HOSTNAME
+    # Sets tty to true if the container needs a pseudo-TTY
+    tty: false
     command:
       # Specifies the command to be executed when the container is run
       - bash

tmp/.docker/docker.common.env

@@ -33,7 +33,7 @@ DOCKER_PROJECT_ID=${DOCKER_PROJECT_ID:-"default"}
 DOCKER_USERNAME=${DOCKER_USERNAME:-"entelecheia"}                            # The username for Docker.
 IMAGE_VERSION=${APP_VERSION:-"1.0.0"}                     # The version of the Docker image. If not set, "1.0.0" will be used.
 CONTAINER_REGISTRY=${CONTAINER_REGISTRY:-"ghcr.io"}                      # The Docker registry to push the image to.
-CONTAINER_USERNAME=${USERNAME:-"app"}                      # The username of the user. If not set, the current user's username will be used.
+CONTAINER_USERNAME="app"                                   # The username of the user. If not set, the current user's username will be used.
 CONTAINER_USER_UID=${USER_UID:-"9001"}                           # The user ID in the Docker container.
 CONTAINER_USER_GID=${USER_GID:-"9001"}                           # The group ID in the Docker container.
 CONTAINER_GITHUB_USERNAME=${GITHUB_USERNAME:-"entelecheia"}                  # The GitHub username of the project

tmp/.docker/scripts/entrypoint.sh

@@ -0,0 +1,41 @@
+#!/bin/bash
+VERBOSE=${DOCKER_VERBOSE:-"false"}
+# add your custom commands here that should be executed every time the docker container starts
+if [ "$VERBOSE" = "true" ]; then
+    echo "Starting docker container..."
+    echo "---"
+    # Print out the environment variables
+    env
+    echo "---"
+    echo "Fixing permissions..."
+    echo "---"
+fi
+
+### Set the USER_UID envvar to match your user.
+# Ensures files created in the container are owned by you:
+#   docker run --rm -it -v /some/path:/invokeai -e USER_UID=$(id -u) <this image>
+# Default UID: 1000 chosen due to popularity on Linux systems. Possibly 501 on MacOS.
+USER_UID=${USER_UID:-"1000"}
+USERNAME=${USERNAME:-"app"}
+LOCAL_UID=$(id -u "$USERNAME")
+WORKSPACE_ROOT=${WORKSPACE_ROOT:-""}
+APP_INSTALL_ROOT=${APP_INSTALL_ROOT:-""}
+
+if [ "$USER_UID" != "$LOCAL_UID" ]; then
+    echo "Updating UID and GID to $USER_UID:$USER_UID from $LOCAL_UID:$LOCAL_UID"
+    usermod -u "$USER_UID" "$USERNAME"
+    groupmod -g "$USER_UID" "$USERNAME"
+    echo "Changing ownership of home directory to $USER_UID:$USER_UID"
+    chown -R "$USER_UID:$USER_UID" "/home/$USERNAME"
+    if [ -n "$APP_INSTALL_ROOT" ] && [ -d "$APP_INSTALL_ROOT" ]; then
+        echo "Changing ownership of $APP_INSTALL_ROOT directory to $USER_UID:$USER_UID"
+        chown -R "$USER_UID:$USER_UID" "$APP_INSTALL_ROOT"
+    fi
+    if [ -n "$WORKSPACE_ROOT" ] && [ -d "$WORKSPACE_ROOT" ]; then
+        echo "Changing ownership of workspace directory [$WORKSPACE_ROOT] to $USER_UID:$USER_UID"
+        chown -R "$USER_UID:$USER_UID" "$WORKSPACE_ROOT"
+    fi
+fi
+
+# Run the provided command
+exec gosu "${USERNAME}" "$@"

tmp/.github/workflows/deploy-base-image.yaml

@@ -9,7 +9,8 @@ on:
     branches:
       - docker*
     paths:
-      - ".docker/**"
+      - ".docker/**/*.base*"
+      - ".docker/docker.version"
 
 # Defines two custom environment variables for the workflow. These are used for the Container registry domain, and a name for the Docker image that this workflow builds.
 env:
@@ -66,17 +67,17 @@ jobs:
             type=raw,value=${{ env.IMAGE_VERSION }}-${{ env.IMAGE_VARIANT }}
             # set latest tag for docker branch
             type=raw,value=latest-${{ env.IMAGE_VARIANT }}
+            type=raw,value=latest
 
       # This step uses the `docker/build-push-action` action to build the image, based on your repository's `Dockerfile`. If the build succeeds, it pushes the image to GitHub Packages.
       # It uses the `context` parameter to define the build's context as the set of files located in the specified path. For more information, see "[Usage](https://github.com/docker/build-push-action#usage)" in the README of the `docker/build-push-action` repository.
       # It uses the `tags` and `labels` parameters to tag and label the image with the output from the "meta" step.
       - name: Build and push Docker image
-        uses: docker/build-push-action@v6.1.0
+        uses: docker/build-push-action@v6.3.0
         with:
           context: .
           file: ./.docker/Dockerfile.base
           build-args: |
-            ARG_BUILD_FROM=${{ env.BUILD_FROM }}
             ARG_USERNAME=${{ env.CONTAINER_USERNAME }}
             ARG_USER_UID=${{ env.CONTAINER_USER_UID }}
             ARG_USER_GID=${{ env.CONTAINER_USER_GID }}

tmp/pyproject.toml

@@ -8,7 +8,7 @@ repository = "https://github.com/entelecheia/hyperfast-docker-template"
 readme = "README.md"
 
 [tool.poetry.dependencies]
-python = ">=3.9.1,<3.12"
+python = ">=3.9,<3.13"
 
 [tool.poetry.group.dev]
 optional = true