Skip to content

fgrfn/unraid-templates

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

130 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

fgrfn Unraid Templates

Validate Templates Deploy Update Templates

Welcome to the central repository for all my personally maintained Unraid Docker Templates.

These templates can be conveniently loaded and automatically updated via the Unraid GUI – hosted via GitHub Pages.


📦 Available Templates

🖨️ Bambuddy

Quick Install:

https://fgrfn.github.io/unraid-templates/templates/Bambuddy/my-Bambuddy.xml

🖨️ Scan2Target

Quick Install:

https://fgrfn.github.io/unraid-templates/templates/Scan2Target/my-Scan2Target.xml

📊 Netzbremse

Quick Install:

https://fgrfn.github.io/unraid-templates/templates/Netzbremse/my-Netzbremse.xml

📈 Reddit WSB Crawler

Quick Install:

https://fgrfn.github.io/unraid-templates/templates/RedditWSBCrawler/my-RedditWSBCrawler.xml

⛏️ BitAxe Discord Status Bot

Quick Install:

https://fgrfn.github.io/unraid-templates/templates/BitaxeDiscordBot/my-BitaxeDiscordBot.xml

📝 Blank Template

A template file is available for quickly creating new templates:

  • Template: blank-template.xml
  • Contains all important fields with examples for ports, volumes, and environment variables
  • Perfect for converting Docker-Compose files to Unraid templates

🌐 GitHub Pages Overview

Central landing page with link index:
➡️ https://fgrfn.github.io/unraid-templates/


🛠️ Installation Methods

Method 1: Quick Install (Single Template)

  1. Open Unraid: Docker → Add Container
  2. Select at the top: Template repositories
  3. Copy & paste the template URL from the "Quick Install" section above
  4. Click "Add", then "Apply"

Method 2: Add Template Repository

Add this repository URL to automatically get all templates:

https://github.com/fgrfn/unraid-templates
  1. Open Unraid: Docker → Add Container
  2. Click Template repositories (or settings icon)
  3. Add the repository URL above
  4. Save and browse all available templates

Method 3: Manual Installation

Option A: Download via Browser

  1. Download the desired .xml file from this repository
  2. Place it in /boot/config/plugins/dockerMan/templates-user/
  3. Refresh the Docker page in Unraid
  4. The template will appear in your template list

Option B: Download via wget (SSH/Terminal)

Open Unraid terminal or SSH and run:

# For Bambuddy template: 
wget -P /boot/config/plugins/dockerMan/templates-user/ https://raw.githubusercontent.com/fgrfn/unraid-templates/main/templates/Bambuddy/my-Bambuddy.xml

# For Scan2Target template:
wget -P /boot/config/plugins/dockerMan/templates-user/ https://raw.githubusercontent.com/fgrfn/unraid-templates/main/templates/Scan2Target/my-Scan2Target.xml

# For Netzbremse template:
wget -P /boot/config/plugins/dockerMan/templates-user/ https://raw.githubusercontent.com/fgrfn/unraid-templates/main/templates/Netzbremse/my-Netzbremse.xml

# For Reddit WSB Crawler template:
wget -P /boot/config/plugins/dockerMan/templates-user/ https://raw.githubusercontent.com/fgrfn/unraid-templates/main/templates/RedditWSBCrawler/my-RedditWSBCrawler.xml

# For BitAxe Discord Status Bot template:
wget -P /boot/config/plugins/dockerMan/templates-user/ https://raw.githubusercontent.com/fgrfn/unraid-templates/main/templates/BitaxeDiscordBot/my-BitaxeDiscordBot.xml

# For blank template:
wget -P /boot/config/plugins/dockerMan/templates-user/ https://raw.githubusercontent.com/fgrfn/unraid-templates/main/templates/blank-template.xml

Then refresh the Docker page in Unraid to see the new template.


🔄 Automatic Template Updates

Templates in this repository are automatically updated daily through a GitHub Actions workflow that:

  • 📡 Checks upstream project repositories for changes (docker-compose.yml)
  • 🔍 Detects new environment variables, ports, and volumes
  • ✨ Automatically adds missing configuration to templates
  • ✅ Validates and commits changes back to the repository

Monitored Projects:

The workflow runs daily at 2 AM UTC and can also be triggered manually via workflow_dispatch.

Script Usage:

# Check for template updates manually
python scripts/update-templates.py

✍️ Contributing

Want to add or improve a template?
Pull requests are welcome – or contact me directly!

Use blank-template.xml as a starting point for new templates.

📋 Template Guidelines

When creating or updating templates, please ensure:

  1. Always include an icon - Icons display in both Unraid UI and on the GitHub Pages website

    • Option 1 (Recommended): Local logo file - Place a logo.png, logo.svg, or other image file in the template folder

      • Example: templates/MyApp/logo.png
      • The system will automatically detect and use it
      • Supported formats: .png, .svg, .jpg, .jpeg, .webp, .ico
    • Option 2: Icon URL in XML - Add an <Icon> tag in your template XML:

      • Project favicon: https://raw.githubusercontent.com/user/repo/main/static/favicon.ico
      • Project logo (use ?raw=true): https://github.com/user/repo/blob/main/logo.png?raw=true
      • Organization/user avatar: https://avatars.githubusercontent.com/u/12345678
    • Fallback: If no logo file or Icon URL is found, a generated avatar with the app's initials will be used

  2. Test the icon URL - If using Option 2, verify the URL is accessible and returns an image before submitting

  3. Commit and push your changes - The GitHub Actions workflow will automatically:

    No manual script execution needed!


📄 License

All templates are based on freely accessible projects.
The templates themselves are licensed under the MIT License.

About

unraid-templates

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages