From d5aba09de94a34edc22ab69aa62b11a8c4ba3dd7 Mon Sep 17 00:00:00 2001
From: ExploracuriousAlex
 <127612956+ExploracuriousAlex@users.noreply.github.com>
Date: Wed, 17 Sep 2025 18:16:58 +0200
Subject: [PATCH] Development: devcontainer fixes for Windows (#10843)

* chore(devcontainer): drop read-only host .gitconfig bind mount

The bind mount prevented adjusting git config inside the dev container, and VS Code Dev Containers already copies the host .gitconfig automatically, making the mount unnecessary. This restores ability to manage git settings within the container.

* chore(gitignore): ignore .pnpm-store folder for pnpm package management

Add .pnpm-store/ to .gitignore to prevent local pnpm package store from being tracked by git when using the devcontainer.

* docs(development): clarify VS Code devcontainer setup steps for Windows

Add instructions, how to overcome some issues caused by using Windows as host system.
---
 .../docker-compose.devcontainer.sqlite-tika.yml          | 1 -
 .gitignore                                               | 3 +++
 docs/development.md                                      | 9 +++++++--
 3 files changed, 10 insertions(+), 3 deletions(-)

diff --git a/.devcontainer/docker-compose.devcontainer.sqlite-tika.yml b/.devcontainer/docker-compose.devcontainer.sqlite-tika.yml
index 13d59c776..e106cea1b 100644
--- a/.devcontainer/docker-compose.devcontainer.sqlite-tika.yml
+++ b/.devcontainer/docker-compose.devcontainer.sqlite-tika.yml
@@ -49,7 +49,6 @@ services:
       - ./data:/usr/src/paperless/paperless-ngx/data
       - ./media:/usr/src/paperless/paperless-ngx/media
       - ./consume:/usr/src/paperless/paperless-ngx/consume
-      - ~/.gitconfig:/usr/src/paperless/.gitconfig:ro
     environment:
       PAPERLESS_REDIS: redis://broker:6379
       PAPERLESS_TIKA_ENABLED: 1
diff --git a/.gitignore b/.gitignore
index 452273705..c7b5c4d8e 100644
--- a/.gitignore
+++ b/.gitignore
@@ -107,3 +107,6 @@ celerybeat-schedule*
 /.devcontainer/data/
 /.devcontainer/media/
 /.devcontainer/redisdata/
+
+# ignore pnpm package store folder created when setting up the devcontainer
+.pnpm-store/
diff --git a/docs/development.md b/docs/development.md
index c624f97c4..71ca4d930 100644
--- a/docs/development.md
+++ b/docs/development.md
@@ -470,9 +470,14 @@ To get started:
 
 2. VS Code will prompt you with "Reopen in container". Do so and wait for the environment to start.
 
-3. Initialize the project by running the task **Project Setup: Run all Init Tasks**. This
+3. In case your host operating system is Windows:
+
+    - The Source Control view in Visual Studio Code might show: "The detected Git repository is potentially unsafe as the folder is owned by someone other than the current user." Use "Manage Unsafe Repositories" to fix this.
+    - Git might have detecteded modifications for all files, because Windows is using CRLF line endings. Run `git checkout .` in the containers terminal to fix this issue.
+
+4. Initialize the project by running the task **Project Setup: Run all Init Tasks**. This
    will initialize the database tables and create a superuser. Then you can compile the front end
    for production or run the frontend in debug mode.
 
-4. The project is ready for debugging, start either run the fullstack debug or individual debug
+5. The project is ready for debugging, start either run the fullstack debug or individual debug
    processes. Yo spin up the project without debugging run the task **Project Start: Run all Services**