Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added assets/gamarr/logos/128.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/gamarr/logos/16.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
52 changes: 52 additions & 0 deletions gamarr.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
---
title: Gamarr
description: Gamarr wiki homepage
published: true
date: 2025-02-02T00:00:00.000Z
tags: gamarr, installation, games
editor: markdown
dateCreated: 2025-02-02T00:00:00.000Z
---

![128.png](/assets/gamarr/logos/128.png)

> Gamarr is a game collection manager for Usenet and BitTorrent users. It can monitor multiple RSS feeds for new games and will interface with clients and indexers to grab, sort, and rename them. It can also be configured to automatically upgrade the quality of existing files in the library when a better quality format becomes available.
{.is-info}

# Getting Started

- [<i class="fas fa-plus-square"></i>&emsp;Installation Guide](/gamarr/installation)
- [<i class="far fa-question-circle"></i>&emsp;FAQ](/gamarr/faq)
{.links-list}

# User Guide

- [<i class="fas fa-play"></i>&emsp;Library](/gamarr/library)
- [<i class="fas fa-clock"></i>&emsp;Activity](/gamarr/activity)
- [<i class="fas fa-cogs"></i>&emsp;Settings](/gamarr/settings)
- [<i class="fas fa-laptop"></i>&emsp;System](/gamarr/system)
- [<i class="fas fa-database"></i>&emsp;Application Data Directory](/gamarr/appdata-directory)
{.links-list}

# Troubleshooting

- [<i class="far fa-life-ring"></i>&emsp;General Troubleshooting](/gamarr/troubleshooting)
- [<i class="fas fa-shield-alt"></i>&emsp;VPN Guide *When and how to use VPNs properly*](/vpn)
{.links-list}

# Development

- [<i class="fas fa-laptop-code"></i>&emsp;Contributing](/gamarr/contributing)
{.links-list}

# Support

Still having issues? Feel free to stop by one of our support sites for extra help

- [<i class="fab fa-discord"></i>&emsp;Discord *Official Gamarr Discord*](https://discord.gg/gamarr)
{.links-list}

# Links

- [GitHub *Source Code*](https://github.com/gamarr-app/Gamarr)
{.links-list}
19 changes: 19 additions & 0 deletions gamarr/installation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
title: Gamarr Installation
description: Instructions and Guides for Installation of Gamarr
published: true
date: 2025-02-02T00:00:00.000Z
tags: installation, setup, docker, gamarr, guide
editor: markdown
dateCreated: 2025-02-02T00:00:00.000Z
---

# By Platform

[<i class="fab fa-windows" style="font-size: 3em;"></i>](/gamarr/installation/windows)&nbsp;&nbsp;&nbsp;&nbsp;[<i class="fab fa-linux" style="font-size: 3em;"></i>](/gamarr/installation/linux)&nbsp;&nbsp;&nbsp;&nbsp;[<i class="fab fa-apple" style="font-size: 3em;"></i>](/gamarr/installation/macos)&nbsp;&nbsp;&nbsp;&nbsp;[<i class="fab fa-docker" style="font-size: 3em;"></i>](/gamarr/installation/docker)

# Recommended Guides

- [Setup Reverse Proxy *Complete guide for reverse proxy setup with Nginx or Apache*](/gamarr/installation/reverse-proxy)
- [Setup Multiple Instances *Setup guide for running multiple instances on various platforms*](/gamarr/installation/multiple-instances)
{.links-list}
61 changes: 61 additions & 0 deletions gamarr/installation/docker.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
---
title: Gamarr Docker Installation
description: Docker installation guide for Gamarr
published: true
date: 2025-02-02T00:00:00.000Z
tags: docker, installation, gamarr
editor: markdown
dateCreated: 2025-02-02T00:00:00.000Z
---

# Docker

These instructions provide generic guidance that should apply to any Gamarr Docker image.

Synology Users can see [TRaSH's Synology Docker Guide](https://trash-guides.info/Hardlinks/How-to-setup-for/Synology/)

## Portainer

> **Portainer should be avoided for setting up docker containers** {.is-danger}

- Portainer gives a pretty GUI for managing containers, but that is all it is useful for.
- Portainer should only for viewing docker container logs / container status.
- It's strongly suggested to use Docker compose and to not use Portainer.
- Portainer has many issues, such as:
- Incorrect order of source and target of mounts
- Inconsistent case-sensitivity
- No automatically created custom networks for inter-container communication
- Inconsistent compose implementations on different architectures
- Pulls every tag on update when you don't set a specific tag
- Capabilities are hidden and some don't work at all on ARM platforms

See this [Docker Guide](/docker-guide) and [TRaSH's Docker Tutorial](https://trash-guides.info/hardlinks/) instead for how to setup Docker Compose.

## Avoid Common Pitfalls

### Volumes and Paths

There are two common problems with Docker volumes: Paths that differ between the Gamarr and download client container and paths that prevent fast moves and hard links.

The first is a problem because the download client will report a download's path as `/torrents/My.Game/`, but in the Gamarr container that might be at `/downloads/My.Game/`. The second is a performance issue and causes problems for seeding torrents. Both problems can be solved with well planned, consistent paths.

Most Docker images suggest paths like `/games` and `/downloads`. This causes slow moves and doesn't allow hard links because they are considered two different file systems inside the container. Some also recommend paths for the download client container that are different from the Gamarr container, like /torrents.

The best solution is to use a single, common volume inside the containers, such as /data. Your Games would be in `/data/Games`, torrents in `/data/downloads/torrents` and/or usenet downloads in `/data/downloads/usenet`.

If this advice is not followed, you may have to configure a Remote Path Mapping in the Gamarr web UI (Settings › Download Clients).

### Ownership and Permissions

Permissions and ownership of files is one of the most common problems for Gamarr users, both inside and outside Docker. Most images have environment variables that can be used to override the default user, group and umask, you should decide this before setting up all of your containers. The recommendation is to use a common group for all related containers so that each container can use the shared group permissions to read and write files on the mounted volumes.
Keep in mind that Gamarr will need read and write to the download folders as well as the final folders.

> For a more detailed explanation of these issues, see [The Best Docker Setup and Docker Guide](/docker-guide) wiki article.
{.is-info}

## Install Gamarr

To install and use these Docker images, you will need to keep the above in mind while following their documentation. There are many ways to manage Docker images and containers too, so installation and maintenance of them will depend on the route you choose.

- [ghcr.io/gamarr-app/gamarr](https://github.com/gamarr-app/Gamarr/pkgs/container/gamarr)
{.links-list}
1 change: 1 addition & 0 deletions home.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ At times, one may be able to edit on the Wiki directly, just authenticate with G

## Media Automation

- [![16.png](/assets/gamarr/logos/16.png)&emsp;Gamarr *Games*](/gamarr)
- [![16.png](/assets/lidarr/logos/16.png)&emsp;Lidarr *Music*](/lidarr)
- [![16.png](/assets/radarr/logos/16.png)&emsp;Radarr *Movies*](/radarr)
- [![16.png](/assets/readarr/logos/16.png)&emsp;Readarr *Books*](/readarr)
Expand Down
5 changes: 2 additions & 3 deletions lidarr/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -169,15 +169,14 @@ As of Lidarr v2, Authentication is Mandatory.

- Artists that do not show up in search may be added by searching for `lidarr:mbid` where `mbid` is the Musicbrainz ID of the artist.

## How can I find a MusicBrainz ID?
## How can I find a MusicBrainz ID

1. [Search for your desired artist or album](https://musicbrainz.org/search) (use `Release Group` type for albums)
2. The MusicBrainz ID can be found under the "Details" tab:
2. The MusicBrainz ID can be found under the "Details" tab:
![musicbrainz_id_detail_tab.png](/images/musicbrainz_id_detail_tab.png)
3. Or at the end of the URL:
![musicbrainz_id_url.png](/images/musicbrainz_id_url.png)


## Lidarr matched an album with too many tracks. How can I change the Album to the correct Release

- Open the Album details page and select the Edit Icon in the top nav. There you can find a dropdown of all releases tied to that Album.
Expand Down