A video game management application inspired by the -Arr apps (Sonarr, Radarr, Prowlarr...) and GamezServer. Track and organize your video game collection with automated discovery and download management.

Features

• 🎮 Game Discovery: Browse popular games, new releases, and upcoming titles via IGDB integration and xREL.to. Sync your Steam wishlist.
• 📚 Library Management: Track your game collection with status indicators (Wanted, Owned, Playing, Completed), user ratings, and Early Access badges.
• ⬇️ Download Management: Integrate with indexers (Prowlarr/Torznab/Newsznab), torrent/usenet downloaders (qBittorrent, Transmission, rTorrent / sabnzbd, nzbget), and optionally enable auto-download to get them right when they're there. Import downloads automatically to your library folder.
• 🔍 Search & Filter: Find games by genre, platform, and search terms. Automatically search for added games until available on your indexers. Blacklist unwanted releases and set preferred release groups and platforms.
• Notifications: thanks to Apprise, you can send notifications to 100+ providers.
• 🗂️ Rich Metadata: Game details enriched with IGDB, Steam, PCGamingWiki links, and NexusMods pages, as well as trending mods (if applicable).
• 📊 Stats Page: Visualize your collection statistics, with Discord sharing support.
• 📰 RSS Feeds: Monitor releases from your favorite groups directly within the app.
• 🔒 Privacy Focused: Hardened security (CSP, SSRF protection), as well as SSL support. The repo itself uses OpenSSF Best Practices, Aikido security checks, CodeQL, StepSecurity and SonarCloud.
• ✨ Clean Interface: UI optimized for browsing game covers and metadata, with light/dark mode.

Screenshots

👀 See the app in action

Dashboard

Your central hub for recent activity, collection overview and downloading available games.

Discover Games

Browse and find new games to add to your collection.

Library & Wishlist

Manage your wanted and owned games.

Calendar

Keep track of upcoming releases.

Downloads Queue

Monitor your downloaders' active downloads and history.

Statistics

Check out your library statistics.

RSS & xRel.to feeds

Custom RSS feeds and xRel.to flux matched to IGDB games directly into the app

Settings

Configure indexers, downloaders, and application preferences.

Tech Stack

• Frontend: React 18, TypeScript, Vite, Tailwind CSS, shadcn/ui
• Backend: Node.js, Express, TypeScript
• Database: SQLite with Drizzle ORM
• APIs: IGDB (game metadata), Torznab/Newznab (indexer search), PCGamingWiki, NexusMods, xREL.to
• AIs usage:
  • Claude and Github Copilot are used for AI-Assisted coding, internal code reviews, PR cleanup. Eventually automated coding and troubleshooting for small tasks and bug reports.
  • Gemini & Codex are used for automated code reviews, and brainstorming from time to time (as well as Perplexity for this usage).
  • Google Jules is used for light periodical refactoring.

Installation

Using Docker (Recommended)

Docker is the easiest way to deploy Questarr with all dependencies included. Questarr uses a SQLite database which is self-contained in the application container.

Fresh Install

Option 1: One-liner (Simplest)

docker run -d -p 5000:5000 -v ./data:/app/data --name questarr ghcr.io/doezer/questarr:latest

Option 2: Docker Compose

1. Create a docker-compose.yml file:

   services:
     app:
       image: ghcr.io/doezer/questarr:latest
       ports:
         - "5000:5000"
       volumes:
         - ./data:/app/data
       environment:
         - SQLITE_DB_PATH=/app/data/sqlite.db
       restart: unless-stopped
   

2. Start the application:

   docker compose up -d
   

3. Access the application: Open your browser to http://localhost:5000

Upgrading from v1.0 (PostgreSQL)

If you are upgrading from an older version that used PostgreSQL, you need to migrate your data.

1. Stop your current application:

   docker compose down
   

2. Get the migration tools: Download the docker-compose.migrate.yml file to your directory.

3. Run the migration: This command spins up your old database and converts the data to the new format automatically.

   docker compose -f docker-compose.migrate.yml up --abort-on-container-exit
   

4. Update your deployment: Replace your docker-compose.yml with the new version (see "Fresh Install" above).

5. Start the new version:

   docker compose up -d
   

See docs/MIGRATION.md for more details.

Home Assistant Add-on

You can install Questarr as a Home Assistant add-on from this repository:

1. In Home Assistant, open Settings → Add-ons → Add-on Store.
2. Click the menu (⋮) and choose Repositories.
3. Add this repository URL: https://github.com/Doezer/Questarr
4. Install the Questarr add-on and start it.
5. Open http://<home-assistant-host>:5000 to access the UI.

Configuration

1. First-time setup:

• Create your admin account
• Configure the IGDB credentials

Once logged-in:

• Configure indexers
• Add downloaders
• Add games!

See Configuration on the Wiki for more detailed info.

Getting IGDB API Credentials

IGDB provides game metadata (covers, descriptions, ratings, release dates, etc.).

1. Go to Twitch Developer Console
2. Log in with your Twitch account (create one if needed)
3. Click "Register Your Application"
4. Fill in:
   • Name: Questarr (or any name)
   • OAuth Redirect URLs: http://localhost (not used, but required)
   • Category: Application Integration
5. Click "Create"
6. Copy your Client ID and Client Secret
7. Add them to your .env file

Advanced usage

Docker compose

This is mainly for users who want the latest commit (e.g when trying out fixes for an issue) or contributing users.

1. Clone the repository:

git clone https://github.com/Doezer/Questarr.git
cd Questarr

1. Configure the application: Edit docker-compose.yml directly if you need to setup a specific environment.

2. Build and start the containers:

docker-compose up -d

1. Access the application: Open your browser to http://localhost:5000

Update to latest version for Docker

Your database content will be kept.

git pull
docker-compose down
docker-compose build --no-cache
docker-compose up -d

Manual Installation (npm) - NOT RECOMMENDED

For development or custom deployments without Docker.

1. Clone and install dependencies:

git clone https://github.com/Doezer/Questarr.git
npm install

1. Configure environment variables in .env: See the .env.example for available variables.

2. Initialize the database: This will run available migration files.

npm run db:migrate

1. Development mode (with hot reload):

npm run dev

1. Access the application: Open your browser to http://localhost:5000

Troubleshooting

See Troubleshooting on the Wiki

Getting Help

• Issues: GitHub Issues
• Discussions: GitHub Discussions
• Discord: Join our Server

Project Security & Documentation

• Start with docs/GITHUB_DOCUMENTATION.md for the canonical documentation map.

Contributing

• See .github/CONTRIBUTING.md for guidelines on how to contribute to this project.
• See MAINTAINERS.md for the current list of project members with access to sensitive resources.

Contributors

Made with contrib.rocks.

License

GPL3 License - see COPYING file for details.

Acknowledgments

• Inspired by Sonarr and GamezServer
• Game metadata powered by IGDB API
• UI components from shadcn/ui

Star History