
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 / and writes user config to /.
Systemd managed service
Runs as sickgear@username with a dedicated data directory at /.
Reverse proxy + basic auth
Nginx serves / and enforces basic auth using /.
Dashboard visibility
The SickGear row on the App Dashboard surfaces the port, and its API & Secrets section shows the API key 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 SickGear row on the App Dashboard shows the live port, and its API & Secrets section shows the API key.
Installation
Install from the Dashboard
Open App Dashboard → Package Management (/), find SickGear in the catalog (browse Media Management or search), and click Install. The dashboard streams the install log live and SickGear appears in your Application Control panel when it finishes. Reinstall and Remove are in the same Package Management panel. To update, use the amber Update badge on the SickGear row in the App Dashboard.
What you see and can manage is gated by your account: admins manage any user’s apps; regular users manage their own. See App Management for the full flow.
Install from the CLI (automation)
The CLI runs the same install and is suited to automation and scripting:
qb install sickgear -u username
qb reinstall sickgear -u username
qb update sickgear -u username
qb remove sickgear -u usernameFull flag reference: CLI Reference.
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_usernameto the QuickBox username andweb_passwordto the QuickBox user password. - The easiest place to get the API key is the dashboard: open the App Dashboard, stay on Application Control and expand SickGear’s row. The API & Secrets section shows the key masked, with buttons to reveal it and copy it. It reads the key from
api_keysin config.ini 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 App Dashboard displays the current port value on the SickGear row for the user.
Configuration and files
The following locations are created or managed by the QuickBox SickGear installer.
Common tasks
Use the QuickBox Dashboard to start or stop the SickGear service, or run a supported CLI action.
- The App Dashboard row includes Start, Stop, and Refresh actions for SickGear.
qb update sickgear -u username
qb reinstall sickgear -u username
qb remove sickgear -u usernameBest 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 App Dashboard (expand the SickGear row, then read API & Secrets) to see the current port and API key values.
Don't
- Do not change SickGear to listen on a public interface; QuickBox sets
web_hostto 127.0.0.1. - Do not assume an API key is always present; the dashboard shows “API key not generated or empty” when
api_keysis empty.
Troubleshooting
If SickGear is not reachable or credentials look wrong, start with these QuickBox-managed locations.
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.
QuickBox writes web_username and web_password into
/home/username/.config/SickGear/config.ini during install. Verify the values match the QuickBox user credentials.
The Dashboard reads the SickGear API key from the api_keys field in config.ini. If it is empty, the
API & Secrets section displays “API key not generated or empty.”
Resources
Quick links sourced from the QuickBox SickGear routing configuration.
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