# Self-host Cleanuparr

> A companion for Sonarr, Radarr and your download client that removes stalled, failed and malicious downloads and cleans up leftovers. GPL-3.0 licensed. Open the web UI and add your arr apps and download client under Settings.

- Page: https://levelrail.com/templates/cleanuparr/
- JSON: https://levelrail.com/templates/cleanuparr.json
- Category: Applications
- Licence: GPL-3.0 (Copyleft license)
- Source: https://github.com/Cleanuparr/Cleanuparr
- Upstream docs: https://cleanuparr.github.io/Cleanuparr/

## Requirements
- Memory: about 256 MiB
- amd64: published, arm64: published
- Needs configuration before start: no
- Pinned image tag: 2.10.12

## Services

| Service | Image | Tag | Ports | Volumes |
| --- | --- | --- | --- | --- |
| cleanuparr | ghcr.io/cleanuparr/cleanuparr | 2.10.12 | 11011 | config -> /config |

## Environment

| Service | Variable | Kind |
| --- | --- | --- |
| cleanuparr | PGID | preset |
| cleanuparr | PORT | preset |
| cleanuparr | PUID | preset |
| cleanuparr | TZ | preset |

## Deploy

### CLI

```bash
levelrail-cli templates install cleanuparr --name my-cleanuparr
```

Add --domain SERVICE=HOST to serve a service on your own domain, for example --domain cleanuparr=app.example.com.

### API

```bash
curl -X POST -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" \
  https://levelrail.example.com/api/v1/service-templates/cleanuparr/install \
  -d '{
    "name": "my-cleanuparr"
  }'
```

Create a token in the dashboard first. Name, env and domains are the request fields.

## Questions

### Can I deploy Cleanuparr on Dokploy or Dokku?

The services and pinned images on this page can be run on any Docker host. The public Dokploy templates list we compared does not have an entry with the same id for Cleanuparr, so on Dokploy you would use a Docker Compose application with the file from this page. Dokku deploys container images with its own commands, so the pinned image ghcr.io/cleanuparr/cleanuparr:2.10.12 is what you deploy there.

Self-host Cleanuparr, Cleanuparr docker compose file, deploy Cleanuparr on a VPS: this page lists the pinned image, ports, volumes and the commands for each.
