Getting Started

Learn how to add and manage your Unraid server in RaidMan.

Welcome to RaidMan, the ultimate companion for Unraid server management. This guide will walk you through setting up your Unraid server in the mobile app and completing your first connection.

Prerequisites & Optional Plugin

Before adding your server, ensure you have:

  1. Optional Companion Plugin: While RaidMan can connect to Unraid out of the box to monitor basic dashboard stats, array status, Docker/VM lists, and perform simple operations, you can optionally install the RaidMan Companion Plugin on your Unraid server to unlock advanced capabilities like Host/Docker/VM Terminals, real-time Logs, VNC access, and File Browsing.
  2. Secure Connection: Make sure your connection is secure. We highly recommend utilizing a secure VPN (such as WireGuard or Tailscale) if you are connecting to your Unraid server from outside your local area network.

Adding a Server

To add a new server, tap the + (Add) button in the bottom right corner of the server list dashboard. This will open the Add Server configuration modal.

1. Connection Details

Provide the basic connection info for your Unraid host:

  • Server Name: A friendly name to identify this server inside the app (e.g., Tower, Main-Unraid).
  • Host/IP Address: The full web URL or IP address of your Unraid server. Be sure to include the protocol (http:// or https://) and port if custom (e.g., http://192.168.1.100 or https://myunraid.domain.com).

2. API Key Authentication

RaidMan uses Unraid's secure API key authentication to authorize actions. You have two options to configure this:

  • Method A: Get API Key Automatically (Recommended):
    1. Click the "Get from Unraid" button.
    2. RaidMan will open Unraid's secure login page in a web browser.
    3. Authenticate with your Unraid server credentials. Once authenticated, Unraid will automatically issue a secure API key and redirect you back to the app, auto-filling the API Key field.
    • Note: RaidMan never sees or stores your password. The login process happens directly inside the browser framework.
  • Method B: Manual Entry:
    • Copy your API Key from the Unraid dashboard and paste it into the API Key input field.

3. Custom HTTP Headers (Optional / Advanced)

If you host your Unraid server behind an authenticated reverse proxy (such as Cloudflare Access, Authelia, Authentik, or basic HTTP authentication):

  • Click Add Header under the Custom Headers section.
  • Enter the header Key (e.g., Authorization, CF-Access-Client-Id) and the corresponding Value.
  • These headers will automatically be appended to all API requests sent from the app.

Editing an Existing Server

If your server IP address changes or you need to rotate your API key:

  1. Locate the server card on the dashboard list.
  2. Long-press the server card.
  3. Update any of the parameters (Name, IP, API Key, Headers) and tap Save.

Deleting a Server

To delete a server from RaidMan:

  1. Swipe left on the desired server.
  2. Tap the Delete Server button at the bottom of the form.
  3. Confirm the deletion. This will instantly purge the server configuration and cached statistics from your device's secure local storage.