Skip to content
This repository was archived by the owner on Jun 14, 2026. It is now read-only.
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions docs/docker-wiki-full.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,19 @@ docker run --rm -it --network=host \
ghcr.io/audionut/upload-assistant:latest /downloads/path/to/content --help
```

## Run as non root

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Fix hyphenation in section header.

The term "non-root" should be hyphenated as it's a compound adjective modifying "user."

📝 Proposed fix
-## Run as non root
+## Run as non-root
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
## Run as non root
## Run as non-root
🧰 Tools
🪛 LanguageTool

[grammar] ~58-~58: Use a hyphen to join words.
Context: ...ath/to/content --help ``` ## Run as non root mount tmp and `banned` directorie...

(QB_NEW_EN_HYPHEN)

🤖 Prompt for AI Agents
In `@docs/docker-wiki-full.md` at line 58, The section header "## Run as non root"
should be hyphenated; update the header text to "## Run as non-root" so the
compound adjective correctly modifies "user" (locate and edit the header string
"## Run as non root" in docs/docker-wiki-full.md).

mount `tmp` and `banned` directories to run as a non root user

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Fix hyphenation and enhance clarity.

The term "non-root" should be hyphenated. Additionally, consider adding a brief explanation of why these directories need to be mounted for better user understanding.

📝 Proposed fix
-mount `tmp` and `banned` directories to run as a non root user
+Mount `tmp` and `banned` directories to run as a non-root user. These directories require write access, so they must be explicitly mounted when running with a non-root user ID.
🧰 Tools
🪛 LanguageTool

[grammar] ~59-~59: Use a hyphen to join words.
Context: ...and banned directories to run as a non root user ``` docker run --rm -it --net...

(QB_NEW_EN_HYPHEN)

🤖 Prompt for AI Agents
In `@docs/docker-wiki-full.md` at line 59, Update the sentence that currently
reads "mount `tmp` and `banned` directories to run as a non root user" to use
the hyphenated term "non-root" and expand it with a short rationale; e.g.,
change the phrase to "mount `tmp` and `banned` directories to run as a non-root
user" and append a brief explanation such as "to ensure the container process
has write access while avoiding running as root, improving security and
preserving host permissions." Make sure the edited sentence replaces the
original wording verbatim and keeps backticks around `tmp` and `banned`.


```
docker run --rm -it --network=host \
-u 1000:1000 \
-v /full/path/to/config.py:/Upload-Assistant/data/config.py \
-v /full/path/to/downloads:/downloads \
-v /full/path/to/tmp:/Upload-Assistant/tmp \
-v /full/path/to/banned:/Upload-Assistant/data/banned \
ghcr.io/audionut/upload-assistant:latest /downloads/path/to/content --help
```
Comment on lines +61 to +69

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Add language identifier to code block and consider documenting UID selection.

The code block should specify a language identifier for proper syntax highlighting. Additionally, consider adding guidance about the UID/GID values (1000:1000) and how users should adjust them to match their host system user.

📝 Proposed fix

Fix 1: Add language identifier

-```
+```bash
 docker run --rm -it --network=host \

Optional enhancement: Add note about UID/GID

After line 59, consider adding a note like:

Mount `tmp` and `banned` directories to run as a non-root user. These directories require write access, so they must be explicitly mounted when running with a non-root user ID.

Replace `1000:1000` with your host user's UID:GID (use `id -u` and `id -g` to find yours). Ensure the mounted directories have appropriate permissions for this user.
🧰 Tools
🪛 markdownlint-cli2 (0.20.0)

[warning] 61-61: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

🤖 Prompt for AI Agents
In `@docs/docker-wiki-full.md` around lines 61 - 69, Add a language identifier
(bash) to the fenced Docker command block so it renders with proper syntax
highlighting, and add a short note after the block explaining the UID:GID
1000:1000 token: instruct users to replace 1000:1000 with their host UID:GID
(use id -u and id -g) and to ensure the mounted dirs referenced in the command
(/Upload-Assistant/tmp, /Upload-Assistant/data/banned, /downloads, etc.) are
owned or writable by that user when running the container as a non-root user.


## What is docker?
Google is your friend

Expand Down