Skip to Content
DocsApplicationsMedia ManagementSickGear
SickGear

SickGear

Overview

SickGear is Sick-Beard evolved. Automate your TV enjoyment with innovation, proven stability and reliability. QuickBox installs it per user, runs it as a systemd service, and places it behind the QuickBox reverse proxy.

Key features

These highlights are pulled directly from QuickBox’s SickGear install and service configuration.

👤 Per-user install layout

QuickBox installs SickGear under /opt/username/SickGear and writes user config to /home/username/.config/SickGear.

🧩 Systemd managed service

Runs as sickgear@username with a dedicated data directory at /home/username/.config/SickGear.

🔐 Reverse proxy + basic auth

Nginx serves /username/sickgear and enforces basic auth using /etc/htpasswd.d/htpasswd.username.

📊 Dashboard visibility

The Service Control card surfaces the SickGear port and API key values for the current user.

When to use it

Use SickGear when you want QuickBox to run a dedicated, per-user TV automation service with a reverse-proxied web UI.

Good fit

  • You want SickGear installed under a specific QuickBox user with isolated config.
  • You prefer accessing SickGear at a user-scoped route like /username/sickgear.
  • You need the port and API key visible in the QuickBox dashboard.

QuickBox handles

  • QuickBox installs SickGear under /opt/username/SickGear and stores config in /home/username/.config/SickGear.
  • Nginx routes /username/sickgear to the local SickGear web port.
  • The Service Control widget shows the live port and API key fields.

Installation

QuickBox can install SickGear either from the CLI or from the Dashboard app catalog.

Install from the QuickBox CLI

The SickGear installer supports the standard software actions shown below.

qb install sickgear -u username
qb reinstall sickgear -u username
qb update sickgear -u username
qb remove sickgear -u username

Install from the Dashboard

In the Dashboard app catalog, SickGear appears with an Install button for eligible users. If SickGear is already installed, the row shows Installed and Reinstall actions.

Access and authentication

QuickBox configures both the SickGear web UI and the nginx proxy during install.

URL / route

SickGear is served at the user-scoped route below through the QuickBox reverse proxy.

  • /username/sickgear

Credentials / tokens

  • QuickBox writes SickGear credentials into /home/username/.config/SickGear/config.ini by setting web_username to the QuickBox username and web_password to the QuickBox user password.
  • The Dashboard Service Control card reads the SickGear API key from api_keys in config.ini and displays it for the current user.

Security notes

Nginx enforces basic authentication for SickGear using /etc/htpasswd.d/htpasswd.username.

Ports and networking

SickGear is configured to listen on a local loopback port and is proxied by nginx.

  • Base/default port: 8081.
  • SickGear binds to 127.0.0.1 and uses the configured port from config.ini.
  • The Dashboard Service Control card displays the current port value for the user.

Configuration and files

The following locations are created or managed by the QuickBox SickGear installer.

/
opt/
└── username/
│ └── SickGear/# Application files and virtual environment
home/
└── username/
│ ├── .config/
│ │ └── SickGear/
│ │ │ └── config.ini# Main SickGear configuration file
│ └── tmp/
│ │ └── SickGear/# TMPDIR used by the systemd service
etc/
├── nginx/
│ └── software/
│ │ └── username.sickgear.conf# Nginx reverse proxy for /username/sickgear
└── systemd/
│ └── system/
│ │ └── sickgear@.service# Systemd unit template for per-user service

Common tasks

Use the QuickBox Dashboard to start or stop the SickGear service, or run a supported CLI action.

  • The Service Control card includes Start, Stop, and Refresh actions for SickGear.
qb update sickgear -u username
qb reinstall sickgear -u username
qb remove sickgear -u username

Best practices

These reminders align with the defaults written by the QuickBox installer.

Do

  • Keep the main configuration at /home/username/.config/SickGear/config.ini and preserve its restricted permissions.
  • Use the Dashboard Service Control card to read the current port and API key values.

Don't

  • Do not change SickGear to listen on a public interface; QuickBox sets web_host to 127.0.0.1.
  • Do not assume an API key is always present; the dashboard shows “API Key Not Generated” when api_keys is empty.

Troubleshooting

If SickGear is not reachable or credentials look wrong, start with these QuickBox-managed locations.

SickGear does not load at /username/sickgear

Confirm the service is running for the user and that /etc/nginx/software/username.sickgear.conf exists. The nginx location definition proxies to 127.0.0.1 on the SickGear port and expects the /username/sickgear path.

Login credentials rejected

QuickBox writes web_username and web_password into /home/username/.config/SickGear/config.ini during install. Verify the values match the QuickBox user credentials.

API key shows as not generated

The Dashboard reads the SickGear API key from the api_keys field in config.ini. If it is empty, the UI displays “API Key Not Generated.”

Resources

Quick links sourced from the QuickBox SickGear routing configuration.

SickGear web UI

User-scoped SickGear route behind the QuickBox reverse proxy.

Join the Community

Media server operators sharing configs, getting support, and shaping the future of QuickBox Pro.

Dedicated Support
Feature Previews
Community Configs
Active Discussions
Join Discord Server
SickChillSonarr