DUMB (Debrid Unlimited Media Bridge)

https://dumbarr.com
Admin
DUMB is an all-in-one containerized platform that bridges debrid or Usenet services with media...
Tokens:113,175
Snippets:1,503
Trust Score:1.7
Update:3 months ago
Show doc for...
Tokens:
Raw
### Start Core Services with Dependencies

Source: https://dumbarr.com/api/process

Starts one or more core services along with all their required dependencies. This is typically used during the initial setup or onboarding process. `service_options` can override default configurations.

```json
{
  "core_services": {
    "name": "riven_backend",
    "debrid_service": "RealDebrid",
    "debrid_key": "abc123",
    "service_options": {}
  },
  "optional_services": ["zilean", "pgadmin", "riven_frontend"]
}
```

```json
{
  "core_services": {
    "name": "decypharr",
    "debrid_service": "RealDebrid",
    "debrid_key": "abc123",
    "service_options": {
      "decypharr": {
        "mount_type": "dfs",
        "mount_path": "/mnt/debrid/decypharr"
      }
    }
  },
  "optional_services": []
}
```

```json
{
  "core_services": {
    "name": "cli_debrid",
    "debrid_service": "RealDebrid",
    "debrid_key": "abc123",
    "service_options": {
      "phalanx_db": { "enabled": true }
    }
  },
  "optional_services": ["zilean"]
}
```

```json
{
  "core_services": {
    "name": "plex_debrid",
    "debrid_service": "RealDebrid",
    "debrid_key": "abc123",
    "service_options": {
      "rclone": { "log_level": "DEBUG" },
      "zurg": { "port": 9194 }
    }
  },
  "optional_services": []
}
```

--------------------------------

### NzbDAV Configuration Example

Source: https://dumbarr.com/services/core/nzbdav

This JSON snippet shows the configuration for the NzbDAV service within a DUMB setup. It includes settings for enabling the service, repository details, versioning, ports, update behavior, platform support, and file paths.

```json
{
    "nzbdav": {
        "enabled": false,
        "process_name": "NzbDAV",
        "repo_owner": "nzbdav-dev",
        "repo_name": "nzbdav",
        "release_version_enabled": false,
        "release_version": "latest",
        "branch_enabled": false,
        "branch": "main",
        "suppress_logging": false,
        "log_level": "INFO",
        "frontend_port": 3000,
        "backend_port": 8080,
        "auto_update": false,
        "auto_update_interval": 24,
        "clear_on_update": false,
        "exclude_dirs": [],
        "platforms": [
            "pnpm",
            "dotnet"
        ],
        "command": [],
        "config_dir": "/nzbdav",
        "log_file": "/log/nzbdav.log",
        "webdav_password": "",
        "env": {}
    }
}
```

--------------------------------

### Install Docker

Source: https://dumbarr.com/deployment/proxmox

Downloads and executes the official Docker installation script. Verifies the installation afterwards.

```bash
curl -fsSL https://get.docker.com -o get-docker.sh
sh get-docker.sh
```

```bash
docker --version
docker compose version
```

--------------------------------

### DUMB Configuration Example

Source: https://dumbarr.com/deployment/proxmox

Example of how to set PUID and PGID in DUMB configuration files.

```json
"puid": 1000,
"pgid": 1000,
```

--------------------------------

### Service Environment Variables Example

Source: https://dumbarr.com/reference/environment-variables

Example of setting service-specific environment variables within the dumb_config.json file for a service named 'nzbdav'. These variables are merged with defaults during service setup.

```json
"nzbdav": {
  "env": {
    "WEBDAV_USER": "admin",
    "WEBDAV_PASSWORD": "change-me"
  }
}
```

--------------------------------

### Run Docker Installer Script

Source: https://dumbarr.com/deployment/docker

Executes the downloaded Docker installation script. Follow any on-screen prompts.

```bash
sh get-docker.sh

```

--------------------------------

### Python WebSocket Client Example

Source: https://dumbarr.com/api/websocket_logs

Connect to the WebSocket logs endpoint and print incoming log messages. Ensure the 'websockets' and 'asyncio' libraries are installed.

```python
import websockets
import asyncio
import json

async def consume_logs():
    uri = "ws://localhost:8000/ws/logs"
    async with websockets.connect(uri) as websocket:
        async for message in websocket:
            print(message)

asyncio.run(consume_logs())

```

--------------------------------

### Skip Setup

Source: https://dumbarr.com/api/auth

Skips the initial setup wizard, leaving authentication disabled. This action results in unauthenticated access to all endpoints.

```json
{
  "message": "Setup skipped, authentication disabled"
}
```

--------------------------------

### Enable and Start Systemd Service

Source: https://dumbarr.com/faq/rclone

Commands to reload the systemd daemon, enable the rshared service to start on boot, and start the service immediately.

```bash
sudo systemctl daemon-reload
sudo systemctl enable make-rshared.service
```

```bash
sudo systemctl start make-rshared.service
```

--------------------------------

### POST /api/auth/skip-setup

Source: https://dumbarr.com/api/auth

Skips the initial setup wizard, resulting in authentication being disabled.

```APIDOC
## POST /api/auth/skip-setup

### Description
Skips the initial setup wizard, leaving authentication disabled.

### Method
POST

### Endpoint
/api/auth/skip-setup

### Response
#### Success Response (200)
- **message** (string) - Confirmation message indicating setup was skipped and authentication is disabled.

#### Response Example
```json
{
  "message": "Setup skipped, authentication disabled"
}
```
```

--------------------------------

### GET /process/capabilities Example Response

Source: https://dumbarr.com/api/process

This JSON object represents the backend capabilities and feature flags. It is used by the frontend to determine available features.

```json
{
  "optional_only_onboarding": true,
  "optional_service_options": true,
  "manual_update_check": true,
  "seerr_sync": true,
  "auto_update_start_time": true,
  "symlink_repair": true,
  "symlink_repair_async": true,
  "symlink_manifest_backup": true,
  "symlink_manifest_backup_async": true,
  "symlink_job_status": true,
  "symlink_job_latest": true,
  "symlink_manifest_restore": true,
  "symlink_manifest_restore_async": true,
  "symlink_manifest_compare": true,
  "symlink_backup_schedule": true,
  "symlink_backup_manifest_list": true,
  "symlink_manifest_file_list": true
}

```

--------------------------------

### Download Docker Installer Script

Source: https://dumbarr.com/deployment/docker

Downloads the official Docker installation script. Ensure you have curl installed.

```bash
curl -fsSL https://get.docker.com -o get-docker.sh

```

--------------------------------

### Docker Volume Mount Example

Source: https://dumbarr.com/deployment

Example of how to bind-mount the local config directory to the container. Ensure the config directory exists on your host machine.

```yaml
dumb:
  image: iampuid0/dumb:latest
  volumes:
    - ./config:/config

```

--------------------------------

### Core Services Start Response

Source: https://dumbarr.com/api/process

Provides the status of started core services and lists any errors encountered during the startup process.

```json
{
  "results": [
    {"service": "riven_backend", "status": "started"},
    {"service": "decypharr", "status": "started"}
  ],
  "errors": []
}
```

--------------------------------

### Start Portainer Container

Source: https://dumbarr.com/deployment/proxmox

Run this command to start the Portainer CE container, exposing its UI and mounting necessary volumes for Docker management.

```bash
docker run -d \
-p 8000:8000 \
-p 9443:9443 \
--name portainer \
--restart=always \
-v /var/run/docker.sock:/var/run/docker.sock \
-v portainer_data:/data \
portainer/portainer-ce:latest

```

--------------------------------

### POST /process/start-service

Source: https://dumbarr.com/api/process

Starts a specified process.

```APIDOC
## POST /process/start-service

### Description
Starts a specific process.

### Method
POST

### Endpoint
/process/start-service

### Request Body
- **process_name** (string) - Required - The name of the process to start.

### Request Example
```json
{
  "process_name": "rclone w/ RealDebrid"
}
```

### Response
#### Success Response (200)
- **status** (string) - The status message indicating successful service start.
- **process_name** (string) - The name of the process that was started.

#### Response Example
```json
{
  "status": "Service started successfully",
  "process_name": "rclone w/ RealDebrid"
}
```
```

--------------------------------

### Install Portainer CE

Source: https://dumbarr.com/deployment/portainer

Run this command to install Portainer Community Edition as a container. Ensure Docker is installed and running first. Access the web UI via https://<host>:9443.

```bash
docker volume create portainer_data
docker run -d \
  --name portainer \
  -p 9443:9443 \
  -p 9000:9000 \
  -v /var/run/docker.sock:/var/run/docker.sock \
  -v portainer_data:/data \
  --restart=always \
  portainer/portainer-ce:latest

```

--------------------------------

### PostgreSQL Connection String

Source: https://dumbarr.com/reference/ports

Example connection string for a PostgreSQL database.

```sql
postgresql://localhost:5432/dumb
```

--------------------------------

### Rclone Instance Configuration Example

Source: https://dumbarr.com/services/dependent/rclone

Example configuration for an rclone instance in dumb_config.json, specifically for RealDebrid. This defines mount points, cache directories, and service integrations.

```json
"rclone": {
    "instances": {
        "RealDebrid": {
            "enabled": false,
            "core_service": "",
            "process_name": "rclone w/ RealDebrid",
            "suppress_logging": false,
            "log_level": "INFO",
            "key_type": "RealDebrid",
            "zurg_enabled": true,
            "decypharr_enabled": false,
            "mount_dir": "/mnt/debrid",
            "mount_name": "rclone_RD",
            "cache_dir": "/cache",
            "config_dir": "/config",
            "config_file": "/config/rclone.config",
            "log_file": "/log/rclone_w_realdebrid.log",
            "zurg_config_file": "/zurg/RD/config.yml",
            "command": [],
            "api_key": ""
        }
    }
},
```

--------------------------------

### Install and Run Intel GPU Tools in Docker Container

Source: https://dumbarr.com/services/core/plex-media-server

Enter the Plex container and install intel-gpu-tools to monitor Intel GPU usage for video decoding and encoding.

```bash
# Enter the container
docker exec -it DUMB bash

# Install the tools (Debian/Ubuntu based images)
apt update && apt install -y intel-gpu-tools

# Launch real-time GPU monitor
intel_gpu_top
```

--------------------------------

### Start a Specific Process

Source: https://dumbarr.com/api/process

Initiates the execution of a specified process. Ensure the `process_name` accurately matches a configured service.

```json
{
  "process_name": "rclone w/ RealDebrid"
}
```

--------------------------------

### Create User Response

Source: https://dumbarr.com/api/auth

Example success response after creating a new user account.

```json
{
  "message": "User created successfully",
  "username": "newuser"
}

```

--------------------------------

### Check Docker Version

Source: https://dumbarr.com/deployment/docker

Verify that Docker is installed and check its version.

```bash
docker --version

```

--------------------------------

### Install and Launch Midnight Commander

Source: https://dumbarr.com/deployment/unraid

Install the Midnight Commander file manager within the DUMB container using the Alpine package manager and then launch it. This provides a text-based, dual-pane file explorer for easier navigation and management of files inside the container.

```bash
apk add mc && mc
```

--------------------------------

### GET /process/core-services

Source: https://dumbarr.com/api/process

Retrieves a list of available core services, their dependencies, and default configuration options.

```APIDOC
## GET /process/core-services

### Description
Returns the available core services, their dependencies, and default service options (used by onboarding).

### Method
GET

### Endpoint
/process/core-services
```

--------------------------------

### List Users Response

Source: https://dumbarr.com/api/auth

Example response when listing all user accounts. Shows username and disabled status.

```json
{
  "users": [
    {
      "username": "admin",
      "disabled": false
    },
    {
      "username": "readonly",
      "disabled": true
    }
  ]
}

```

--------------------------------

### GET /process

Source: https://dumbarr.com/api/process

Fetches detailed information about a specific process, including its configuration and version.

```APIDOC
## GET /process

### Description
Fetch details about a specific process.

### Method
GET

### Endpoint
/process

### Parameters
#### Query Parameters
- **process_name** (string) - Required - The name of the process to fetch details for.
- **scope** (string) - Optional - Specifies the scope of information to retrieve. Can be `runtime` (default) or `all`. `runtime` returns runtime/configured hard dependencies, while `all` additionally includes soft linkage edges.

### Response
#### Success Response (200)
- **process_name** (string) - The name of the process.
- **config** (object) - Configuration details for the process.
- **version** (string) - The version of the process.
- **config_key** (string) - The configuration key for the process.

#### Response Example
```json
{
  "process_name": "rclone w/ RealDebrid",
  "config": { "enabled": true, "...": "..." },
  "version": "1.65.1",
  "config_key": "rclone"
}
```
```

--------------------------------

### Get Authentication Status

Source: https://dumbarr.com/api/auth

Retrieves the current authentication status, including whether it's enabled, if users exist, and if setup was skipped.

```json
{
  "enabled": true,
  "has_users": true,
  "setup_skipped": false
}
```

--------------------------------

### Get Historical Metrics

Source: https://dumbarr.com/frontend/metrics

Retrieve historical metrics data for a specified date range. Ensure the start and end dates are in YYYY-MM-DD format.

```bash
# Historical metrics
curl http://localhost:8000/api/metrics/history?start=2025-01-01&end=2025-01-15
```

--------------------------------

### Setup First User Account

Source: https://dumbarr.com/api/auth

Creates the initial user account, enabling authentication. This endpoint is only available when no users exist. It returns a success message and initial tokens.

```json
{
  "username": "admin",
  "password": "yourpassword"
}
```

```json
{
  "message": "User created successfully",
  "access_token": "eyJhbGciOiJIUzI1NiIs...",
  "refresh_token": "eyJhbGciOiJIUzI1NiIs..."
}
```

--------------------------------

### GET /api/auth/status

Source: https://dumbarr.com/api/auth

Returns the current authentication status, indicating whether authentication is enabled, if user accounts exist, and if the initial setup was skipped.

```APIDOC
## GET /api/auth/status

### Description
Returns the current authentication status.

### Method
GET

### Endpoint
/api/auth/status

### Response
#### Success Response (200)
- **enabled** (boolean) - Whether authentication is currently required
- **has_users** (boolean) - Whether any user accounts exist
- **setup_skipped** (boolean) - Whether initial setup was skipped

#### Response Example
```json
{
  "enabled": true,
  "has_users": true,
  "setup_skipped": false
}
```
```

--------------------------------

### POST /process/start-core-service

Source: https://dumbarr.com/api/process

Initiates the startup of one or more core services along with their necessary dependencies, primarily used during the onboarding process.

```APIDOC
## POST /process/start-core-service

### Description
Starts one or more core services and all required dependencies. This is used during onboarding.

### Method
POST

### Endpoint
/process/start-core-service

### Request Body
- **core_services** (object or array) - Required - Defines the core service(s) to start. Each service can include its name, debrid service details, debrid key, and service-specific options.
  - **name** (string) - Required - The name or config key of the core service (e.g., `riven_backend`, `decypharr`).
  - **debrid_service** (string) - Optional - The debrid service to use (e.g., `RealDebrid`).
  - **debrid_key** (string) - Optional - The debrid API key.
  - **service_options** (object) - Optional - Configuration options for the service.
- **optional_services** (array) - Optional - A list of optional services to start (e.g., `zilean`, `pgadmin`).

### Request Body Examples
```json
{
  "core_services": {
    "name": "riven_backend",
    "debrid_service": "RealDebrid",
    "debrid_key": "abc123",
    "service_options": {}
  },
  "optional_services": ["zilean", "pgadmin", "riven_frontend"]
}
```

```json
{
  "core_services": {
    "name": "decypharr",
    "debrid_service": "RealDebrid",
    "debrid_key": "abc123",
    "service_options": {
      "decypharr": {
        "mount_type": "dfs",
        "mount_path": "/mnt/debrid/decypharr"
      }
    }
  },
  "optional_services": []
}
```

```json
{
  "core_services": {
    "name": "cli_debrid",
    "debrid_service": "RealDebrid",
    "debrid_key": "abc123",
    "service_options": {
      "phalanx_db": { "enabled": true }
    }
  },
  "optional_services": ["zilean"]
}
```

```json
{
  "core_services": {
    "name": "plex_debrid",
    "debrid_service": "RealDebrid",
    "debrid_key": "abc123",
    "service_options": {
      "rclone": { "log_level": "DEBUG" },
      "zurg": { "port": 9194 }
    }
  },
  "optional_services": []
}
```

### Response
#### Success Response (200)
- **results** (array) - A list of services that were started and their status.
  - **service** (string) - The name of the service.
  - **status** (string) - The status of the service (e.g., "started").
- **errors** (array) - A list of any errors encountered during startup.

#### Response Example
```json
{
  "results": [
    {"service": "riven_backend", "status": "started"},
    {"service": "decypharr", "status": "started"}
  ],
  "errors": []
}
```
```

--------------------------------

### Example Zurg Webhook Update Script

Source: https://dumbarr.com/services/core/cli-debrid

This bash script sends GET requests to a webhook URL for each argument provided, encoding them for safe transmission. It's used to notify CLI Debrid about completed downloads.

```bash
#!/bin/bash
webhook_url="http://localhost:5000/webhook/rclone"
for arg in "$@"
do
  encoded=$(echo -n "$arg" | python3 -c "import sys, urllib.parse as ul; print(ul.quote(sys.stdin.read()))")
  curl -s -X GET "$webhook_url?file=$encoded"
done
echo "Webhook update complete."

```

--------------------------------

### POST /api/auth/setup

Source: https://dumbarr.com/api/auth

Creates the first user account, enabling authentication. This endpoint is only available when no users exist.

```APIDOC
## POST /api/auth/setup

### Description
Creates the first user account and enables authentication. Only works when no users exist.

### Method
POST

### Endpoint
/api/auth/setup

### Parameters
#### Request Body
- **username** (string) - Required - The username for the new user.
- **password** (string) - Required - The password for the new user.

### Request Example
```json
{
  "username": "admin",
  "password": "yourpassword"
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.
- **access_token** (string) - The JWT access token for the newly created user.
- **refresh_token** (string) - The JWT refresh token for the newly created user.

#### Response Example
```json
{
  "message": "User created successfully",
  "access_token": "eyJhbGciOiJIUzI1NiIs...",
  "refresh_token": "eyJhbGciOiJIUzI1NiIs..."
}
```

### Error Responses
- **400** - Users already exist
- **422** - Invalid username or password format
```

--------------------------------

### Get Historical Metrics API Endpoint

Source: https://dumbarr.com/features/metrics

Retrieve historical metrics data with options for time range, aggregation, and data point limits. Supports query parameters for start date, end date, bucket size, and maximum points.

```http
GET /api/metrics/history
```

--------------------------------

### Prepare DUMB Directory Structure

Source: https://dumbarr.com/deployment/portainer

Create the necessary directories for persistent data storage for DUMB. Use full paths as Portainer may not expand '~'.

```bash
mkdir -p /home/$USER/docker/DUMB/config /home/$USER/docker/DUMB/log /home/$USER/docker/DUMB/data /home/$USER/docker/DUMB/mnt/debrid

```

--------------------------------

### Zilean Configuration Example

Source: https://dumbarr.com/services/optional/zilean

This snippet shows a sample configuration for the Zilean service within the dumb_config.json file. It includes settings for enabling the service, repository details, version control, logging, network binding, auto-updates, and environment variable management.

```json
"zilean": {
  "enabled": false,
  "process_name": "Zilean",
  "repo_owner": "iPromKnight",
  "repo_name": "zilean",
  "release_version_enabled": false,
  "release_version": "v3.3.0",
  "branch_enabled": false,
  "branch": "main",
  "suppress_logging": false,
  "log_level": "INFO",
  "host": "127.0.0.1",
  "port": 8182,
  "auto_update": false,
  "auto_update_interval": 24,
  "clear_on_update": true,
  "exclude_dirs": ["/zilean/app/data"],
  "env_copy": {
    "source": "/zilean/app/data/.env",
    "destination": "/zilean/app/src/.env"
  },
  "platforms": ["python", "dotnet"],
  "command": ["/zilean/app/zilean-api"],
  "config_dir": "/zilean",
  "config_file": "/zilean/app/data/settings.json",
  "log_file": "/log/zilean.log",
  "env": {
    "DOTNET_RUNNING_IN_CONTAINER": "true",
    "DOTNET_gcServer": "1",
    "DOTNET_GCDynamicAdaptationMode": "1",
    "DOTNET_SYSTEM_GLOBALIZATION_INVARIANT": "false",
    "PYTHONUNBUFFERED": "1",
    "ASPNETCORE_URLS": "http://+:{port}",
    "PYTHONPATH": "/zilean/venv/lib/python3.11/site-packages",
    "PATH": "/zilean/venv/bin:${PATH}",
    "ZILEAN_PYTHON_PYLIB": "/usr/local/lib/libpython3.11.so.1.0",
    "Zilean__Database__ConnectionString": "Host={postgres_host};Port={postgres_port};Database=zilean;Username={postgres_user};Password={postgres_password};Timeout=300;CommandTimeout=3600;"
  }
}
```

--------------------------------

### Complete Onboarding

Source: https://dumbarr.com/api/config

Marks the onboarding process as completed.

```bash
POST http://localhost:8000/config/onboarding-completed
```

--------------------------------

### UFW Firewall Configuration for Basic Access

Source: https://dumbarr.com/reference/ports

Example UFW commands to allow minimum required ports for basic DUMB operation.

```bash
# Example UFW configuration
sudo ufw allow 3005/tcp  # DUMB Frontend
sudo ufw allow 8000/tcp  # DUMB API
sudo ufw allow 18080/tcp # Traefik (embedded UIs)
sudo ufw allow 32400/tcp # Plex
```

--------------------------------

### AI Model List Response Example

Source: https://dumbarr.com/api/ai

Example response structure when listing available models for a provider.

```json
{
  "provider": "ollama",
  "models": [
    {
      "name": "llama3.1:latest",
      "size": 4661224676,
      "modified_at": "2026-06-18T00:00:00Z"
    }
  ]
}
```

--------------------------------

### Start LXC Container

Source: https://dumbarr.com/deployment/proxmox

Starts or restarts an LXC container. Changes to container configuration may require a restart.

```bash
pct start <CTID>
```

```bash
systemctl restart pve-container@<CTID>
```

--------------------------------

### Automate Ubuntu LXC Container Creation

Source: https://dumbarr.com/deployment/proxmox

Use this script to download and install an Ubuntu container on Proxmox VE. Ensure you have internet access on the host.

```bash
bash -c "$(curl -fsSL https://raw.githubusercontent.com/community-scripts/ProxmoxVE/main/ct/ubuntu.sh)"
```

--------------------------------

### Symlink Repair Example Response

Source: https://dumbarr.com/api/process

This is an example response after a dry run of the symlink repair operation, showing scanned, changed, and skipped symlinks.

```json
{
  "dry_run": true,
  "scanned_symlinks": 2451,
  "changed": 312,
  "moved": 120,
  "copied": 0,
  "skipped_unchanged": 2139,
  "errors": [],
  "changes": []
}
```

--------------------------------

### Whisparr Configuration Example

Source: https://dumbarr.com/services/core/whisparr

This JSON snippet shows the configuration structure for the Whisparr core service within `dumb_config.json`. It includes settings for enabling instances, database configurations, repository details, and update preferences.

```json
"whisparr": {
  "instances": {
    "Default": {
      "enabled": false,
      "core_service": "",
      "use_neutarr": false,
      "postgres_enabled": false,
      "postgres_main_db": "",
      "postgres_log_db": "",
      "process_name": "Whisparr",
      "repo_owner": "Whisparr",
      "repo_name": "Whisparr",
      "release_version_enabled": false,
      "release_version": "latest",
      "clear_on_update": false,
      "exclude_dirs": [],
      "platforms": [],
      "suppress_logging": false,
      "auto_update": false,
      "auto_update_interval": 24,
      "pinned_version": "",
      "port": 6969,
      "config_dir": "/whisparr/default",
      "config_file": "/whisparr/default/config.xml",
      "log_file": "/whisparr/default/logs/whisparr.txt",
      "command": [],
      "env": {}
    }
  }
}

```

--------------------------------

### Create Docker Directory

Source: https://dumbarr.com/deployment/proxmox

Creates a 'docker' directory in the user's home and changes the current directory into it.

```bash
cd ~ && mkdir docker && cd docker
```

--------------------------------

### Rclone Filter Exclude File Example

Source: https://dumbarr.com/faq/rclone

Content for a filter file to exclude specific resolutions. This example excludes 4k, uhd, and 2160p content.

```text
- **/**{{(?i)(4k|uhd|2160)}}**
+ *
```

--------------------------------

### Enable Prerelease Versions

Source: https://dumbarr.com/features/auto-update

Configure auto-update to receive beta or release candidate versions. Scheduled auto-update checks continue to run at the configured interval.

```json
{
  "service_name": {
    "release_version_enabled": true,
    "release_version": "prerelease"
  }
}
```

--------------------------------

### Get Current Configuration

Source: https://dumbarr.com/api/config

Retrieves the currently loaded in-memory configuration. Optionally, filter by a specific `process_name` to get a single service's configuration block.

```APIDOC
## GET /config

### Description
Returns the currently loaded in-memory configuration. You can optionally pass `process_name` to fetch a single service block.

### Method
GET

### Endpoint
/config

### Parameters
#### Query Parameters
- **process_name** (string) - Optional - The name of the process to retrieve configuration for.
```

--------------------------------

### Install and Run NVIDIA SMI in Docker Container

Source: https://dumbarr.com/services/core/plex-media-server

Enter the Plex container and install nvidia-smi to monitor NVIDIA GPU usage, including utilization and encoder activity during transcoding.

```bash
# Enter the container
docker exec -it DUMB bash

# If not already installed, install NVIDIA tools
apt update && apt install -y nvidia-smi

# Monitor GPU usage
nvidia-smi
```

--------------------------------

### Rclone Filter Include File Example

Source: https://dumbarr.com/faq/rclone

Content for a filter file to include specific resolutions. This example excludes 1080p, 720p, and 480p content, effectively including higher resolutions.

```text
- **/**{{(?i)(1080|720|480)}}**
+ *
```

--------------------------------

### Configure Whisparr with Multiple Core Services

Source: https://dumbarr.com/features/configuration

This example shows how to configure Whisparr to utilize multiple core automation services simultaneously: Decypharr, NzbDAV, and AltMount. This allows for combined routing of automation tasks.

```json
"whisparr": {
  "instances": {
    "Combined": {
      "core_service": ["decypharr", "nzbdav", "altmount"]
    }
  }
}

```

--------------------------------

### Complete Onboarding

Source: https://dumbarr.com/api/config

Marks the initial onboarding process as completed.

```APIDOC
## POST /config/onboarding-completed

### Description
Marks onboarding as complete.

### Method
POST

### Endpoint
/config/onboarding-completed
```

--------------------------------

### GET /process/service-status

Source: https://dumbarr.com/api/process

Retrieves the current operational status of a specified process.

```APIDOC
## GET /process/service-status

### Description
Gets the current status of a process.

### Method
GET

### Endpoint
/process/service-status

### Response
#### Success Response (200)
- **process_name** (string) - The name of the process.
- **status** (string) - The current status of the process (e.g., "running").

#### Response Example
```json
{
  "process_name": "rclone w/ RealDebrid",
  "status": "running"
}
```
```

--------------------------------

### Delete User Response

Source: https://dumbarr.com/api/auth

Example success response after deleting a user account.

```json
{
  "message": "User deleted successfully"
}

```

--------------------------------

### Create DUMB Directories

Source: https://dumbarr.com/deployment/proxmox

Creates the necessary directory structure for DUMB application data, logs, and configurations.

```bash
mkdir -p DUMB/config DUMB/log DUMB/Zurg/RD DUMB/Riven/data DUMB/Riven/mnt DUMB/PostgreSQL/data DUMB/pgAdmin4/data DUMB/Zilean/data
```

--------------------------------

### Onboarding Status Check

Source: https://dumbarr.com/api/config

Checks whether the initial onboarding process is required.

```bash
curl http://localhost:8000/config/onboarding-status
```

--------------------------------

### GET /process/symlink-backup-status

Source: https://dumbarr.com/api/process

Retrieves the current state of the symlink-backup scheduler for a given service.

```APIDOC
## GET /process/symlink-backup-status

### Description
Returns current symlink-backup scheduler state for a service.

### Method
GET

### Endpoint
/process/symlink-backup-status
```

--------------------------------

### Riven Symlink Media Directory Example

Source: https://dumbarr.com/faq/general

Configure the Docker bind mount and dumb_config.json for Riven's symlink media directory when your media server runs on the host.

```bash
/docker/DUMB/mnt/debrid:/docker/DUMB/mnt/debrid
```

```json
{
  "riven_backend": {
    "symlink_library_path": "/docker/DUMB/mnt/debrid/riven_symlinks"
  }
}
```
Tokens:
Raw