diff --git a/docs/UNRAID.md b/docs/UNRAID.md new file mode 100644 index 0000000..ecf9a58 --- /dev/null +++ b/docs/UNRAID.md @@ -0,0 +1,66 @@ +# Unraid Installation Guide for PNGer + +This guide walks you through installing PNGer on Unraid using the Docker tab and "Add Container" feature. + +## Requirements +- Unraid OS with Docker enabled. +- Appdata path ready (optional, if you want persistent temp storage). + +## Step-by-Step Installation + +1. Log into your Unraid WebGUI and navigate to the **Docker** tab. +2. Scroll to the bottom and click on **Add Container**. +3. Fill in the following details: + - **Name**: `PNGer` + - **Repository**: `jason/pnger:latest` (or the repository you pushed the image to, e.g., `ghcr.io/yourusername/pnger:latest` if hosted, or `pnger:latest` if built locally). + - **Network Type**: `Bridge` + +4. Click on **+ Add another Path, Port, Variable, Label or Device** to add the required parameters. + +### Port Configuration +- **Config Type**: `Port` +- **Name**: `WebUI` +- **Container Port**: `3000` +- **Host Port**: `8080` (or whichever port is free on your Unraid system). +- **Connection Protocol**: `TCP` + +### Environment Variables +Add the following variables by clicking **+ Add another Path, Port, Variable...** and selecting **Variable** as the Config Type: + +1. **PUID** + - **Name**: `User ID (PUID)` + - **Key**: `PUID` + - **Value**: `99` (Unraid's nobody user). + +2. **PGID** + - **Name**: `Group ID (PGID)` + - **Key**: `PGID` + - **Value**: `100` (Unraid's users group). + +3. **TZ** + - **Name**: `Timezone` + - **Key**: `TZ` + - **Value**: `America/New_York` (Enter your specific Timezone here). + +4. **MAX_FILE_SIZE** (Optional) + - **Name**: `Max Upload Size (Bytes)` + - **Key**: `MAX_FILE_SIZE` + - **Value**: `10485760` (Default is 10MB; 10485760 bytes). + +### Volume Mapping (Optional) +If you require persistence for the temporary directory processing uploads (usually not required): +- **Config Type**: `Path` +- **Name**: `Temp Processing Dir` +- **Container Path**: `/app/temp` +- **Host Path**: `/mnt/user/appdata/pnger/temp` + +5. **Apply Settings**: + - Scroll to the bottom and press **Apply**. Unraid will pull the image and create the container with the specified settings. + +## Accessing PNGer +Once the container states "started", you can access the Web GUI by navigating to your Unraid IP and the port you assigned (e.g., `http://192.168.1.100:8080`). + +--- + +**Troubleshooting:** +If the container stops instantly, check the **Logs** in Unraid. Ensure that the port you selected on the host is not already in use by another container (like a web server or another app).