feat: Docker support

Dockerfile

@@ -0,0 +1,50 @@
+# Build the UI using minimalistic nodejs image and yarn
+FROM node:18.19-alpine3.18 AS selfie-ui
+
+# Set the working directory in the container
+WORKDIR /selfie
+
+# Copy the package.json and yarn.lock files
+COPY selfie-ui/package.json selfie-ui/yarn.lock ./
+
+# Install dependencies
+RUN yarn install
+
+# Copy the rest of the code
+COPY selfie-ui/ .
+
+# Build the project (if needed)
+RUN yarn build
+
+# Use the official Python image to run selfie
+FROM python:3.11 as selfie
+
+# Set environment variables
+ENV PYTHONDONTWRITEBYTECODE 1
+ENV PYTHONUNBUFFERED 1
+
+# Install libGL
+RUN apt-get update && apt-get install -y \
+    libgl1-mesa-glx \
+    && rm -rf /var/lib/apt/lists/*
+
+# Set the working directory
+WORKDIR /selfie
+
+# Copy code and dependencies into the docker image
+COPY . .
+
+# Copy the built UI from the previous stage
+COPY --from=selfie-ui /selfie/out/ ./selfie-ui/out
+
+# Install poetry
+RUN pip install poetry --no-cache-dir
+
+# Install dependencies
+RUN poetry run poetry add colorlog
+
+EXPOSE 8181
+
+# Run start.sh, add --skip-deps and --skip-build to skip installing dependencies and building the UI
+# since that is done in the previous stages
+CMD ["/selfie/start.sh", "--skip-deps", "--skip-build"]

README.md

@@ -80,6 +80,25 @@ For most users, the easiest way to install Selfie is to follow the [Quick Start]
 
 > **Note**: You can host selfie at a publicly-accessible URL with [ngrok](https://ngrok.com). Add your ngrok token (and optionally, ngrok domain) in `selfie/.env` and run `poetry run python -m selfie --share`.
 
+## Using docker
+
+You can also run Selfie using Docker. To do so, follow these steps:
+
+1. Ensure that [Docker](https://www.docker.com) is installed.
+2. Clone or [download](https://github.com/vana-com/selfie) selfie repository.
+3. In a terminal, navigate to the project directory.
+
+```shell
+docker build -t selfie .
+docker run -p 8181:8181 \
+  --name selfie \
+  -v $(pwd)/data:/selfie/data \
+  -v $(pwd)/selfie:/selfie/selfie \
+  -v $(pwd)/selfie-ui:/selfie/selfie-ui \
+  selfie:latest
+```
+This will start the server and the UI in your browser at http://0.0.0.0:8181/. 
+Your personal data will be stored in the `data` directory.
 
 ## Setting Up Selfie
 

start.sh

@@ -1,27 +1,57 @@
 #!/bin/bash
 
+# Flags to optionally skip dependencies and build, used for docker multi-stage builds
+SKIP_DEPS=false
+SKIP_BUILD=false
+
+# Parse flags
+for arg in "$@"
+do
+    case $arg in
+        --skip-deps)
+        SKIP_DEPS=true
+        shift # Remove --skip-deps from processing
+        ;;
+        --skip-build)
+        SKIP_BUILD=true
+        shift # Remove --skip-build from processing
+        ;;
+        *)
+        # Unknown option
+        ;;
+    esac
+done
+
 if [ ! -f "selfie/.env" ]; then
     echo "Copying selfie/.env.example to selfie/.env..."
     cp selfie/.env.example selfie/.env
 else
     echo "selfie/.env already exists. Skipping copy."
 fi
 
-MISSING_DEPENDENCIES=""
-command -v python >/dev/null 2>&1 || MISSING_DEPENDENCIES="${MISSING_DEPENDENCIES} Python (https://www.python.org/downloads/)\n"
-command -v poetry >/dev/null 2>&1 || MISSING_DEPENDENCIES="${MISSING_DEPENDENCIES} Poetry (https://python-poetry.org/docs/#installation)\n"
-command -v yarn >/dev/null 2>&1 || MISSING_DEPENDENCIES="${MISSING_DEPENDENCIES} Yarn (https://yarnpkg.com/getting-started/install)\n"
+if [ "$SKIP_DEPS" = false ]; then
+    MISSING_DEPENDENCIES=""
+    command -v python >/dev/null 2>&1 || MISSING_DEPENDENCIES="${MISSING_DEPENDENCIES} Python (https://www.python.org/downloads/)\n"
+    command -v poetry >/dev/null 2>&1 || MISSING_DEPENDENCIES="${MISSING_DEPENDENCIES} Poetry (https://python-poetry.org/docs/#installation)\n"
+    command -v yarn >/dev/null 2>&1 || MISSING_DEPENDENCIES="${MISSING_DEPENDENCIES} Yarn (https://yarnpkg.com/getting-started/install)\n"
 
-if [ ! -z "$MISSING_DEPENDENCIES" ]; then
-    echo -e "Missing dependencies:\n$MISSING_DEPENDENCIES"
-    exit 1
+    if [ ! -z "$MISSING_DEPENDENCIES" ]; then
+        echo -e "Missing dependencies:\n$MISSING_DEPENDENCIES"
+        exit 1
+    fi
+else
+    echo "Skipping dependency checks..."
 fi
 
-echo "Installing Python dependencies with Poetry..."
-poetry check || poetry install
+echo "Installing Python dependencies with Poetry including dev..."
+poetry check || poetry install --with dev
 
-echo "Building UI with Yarn..."
-./scripts/build-ui.sh
+if [ "$SKIP_BUILD" = false ]; then
+    echo "Building UI with Yarn..."
+    ./scripts/build-ui.sh
+else
+    echo "Skipping UI build..."
+fi
 
 ACCELERATION_FLAG=""
 
@@ -38,4 +68,4 @@ else
 fi
 
 echo "Running selfie..."
-poetry run python -m selfie $ACCELERATION_FLAG
+poetry run python -m selfie $ACCELERATION_FLAG