docker: change user, add nvidia instructions and a cache folder (#90)

* docs(docker): add nvidia instructions

* docs(docker): fix wording

* docs(docker): create a cache directory

* docker: run as mmoreuser instead of root

* use apt instead of apt-get

Author: Androz2091

Dockerfile

@@ -32,12 +32,17 @@ RUN apt-get update && \
     dpkg-reconfigure --frontend noninteractive tzdata && \
     apt-get clean && rm -rf /var/lib/apt/lists/*
 
-# Copy the project into the image
-ADD . /app
+# Create a non-root user
+RUN useradd -m -u 1000 mmoreuser
 
-# Sync the project into a new environment, using the frozen lockfile
+# Set up working directory and permissions
+RUN mkdir -p /app && chown -R mmoreuser:mmoreuser /app
 WORKDIR /app
 
+# Copy the project into the image and set ownership
+ADD . /app
+RUN chown -R mmoreuser:mmoreuser /app
+
 # Define the build argument with a default value of an empty string (optional)
 COPY pyproject.toml ./
 # RUN uv sync --frozen ${UV_ARGUMENTS}
@@ -51,5 +56,7 @@ RUN uv pip install -e . --system
 
 ENV DASK_DISTRIBUTED__WORKER__DAEMON=False
 
+USER mmoreuser
+
 ENTRYPOINT /bin/bash
 

docs/installation.md

@@ -80,7 +80,39 @@ sudo docker build --build-arg PLATFORM=cpu -t mmore .
 ##### Step 3: Start an interactive session
 
 ```bash
-sudo docker run -it -v ./examples:/app/examples mmore
+sudo docker run --gpus all -it -v ./examples:/app/examples -v ./.cache:/mmoreuser/.cache mmore
 ```
 
+For CPU-only platforms:
+```bash
+sudo docker run -it -v ./examples:/app/examples -v ./.cache:/mmoreuser/.cache mmore
+```
+
+> [!WARNING]
+> You may need the Nvidia toolkit so the containers can access your GPUs.
+> Read [this tutorial](https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/latest/install-guide.html) if something breaks here!
+>
+> Configure the production repository:
+>
+> ```sh
+> curl -fsSL https://nvidia.github.io/libnvidia-container/gpgkey | sudo gpg --dearmor -o /usr/share/keyrings/nvidia-container-toolkit-keyring.gpg \
+>   && curl -s -L https://nvidia.github.io/libnvidia-container/stable/deb/nvidia-container-toolkit.list | \
+>   sed 's#deb https://#deb [signed-by=/usr/share/keyrings/nvidia-container-toolkit-keyring.gpg] https://#g' | \
+>   sudo tee /etc/apt/sources.list.d/nvidia-container-toolkit.list
+> ```
+>
+> ```sh
+> sudo apt update
+> sudo apt install -y nvidia-container-toolkit
+> ```
+>
+> Modify the Docker daemon to use Nvidia:
+>
+> ```sh
+> sudo nvidia-ctk runtime configure --runtime=docker
+> sudo systemctl restart docker
+> ```
+>
+> You can now use `docker run --gpus all`!
+
 *Note:* The `examples` folder is mapped to `/app/examples` inside the container, corresponding to the default path in `examples/process/config.yaml`.