117 lines
3.2 KiB
Markdown
117 lines
3.2 KiB
Markdown
# Getting API Keys from *Arr Services
|
|
|
|
After installing Radarr, Sonarr, and Lidarr, you'll need to get their API keys to connect them to beStream.
|
|
|
|
## Quick Access URLs
|
|
|
|
After running the installation script, access each service at:
|
|
|
|
- **Radarr**: `http://YOUR_SERVER_IP:7878`
|
|
- **Sonarr**: `http://YOUR_SERVER_IP:8989`
|
|
- **Lidarr**: `http://YOUR_SERVER_IP:8686`
|
|
|
|
Replace `YOUR_SERVER_IP` with your Ubuntu server's IP address.
|
|
|
|
## Getting API Keys
|
|
|
|
### Step 1: Access the Web Interface
|
|
|
|
Open each service in your web browser using the URLs above.
|
|
|
|
### Step 2: Complete Initial Setup (First Time Only)
|
|
|
|
If this is your first time accessing a service:
|
|
1. You'll see a setup wizard
|
|
2. Complete the basic configuration (language, port, etc.)
|
|
3. You can skip advanced settings for now
|
|
|
|
### Step 3: Navigate to Settings
|
|
|
|
1. Click the **Settings** icon (⚙️) in the top menu
|
|
2. Click **General** in the left sidebar
|
|
3. Scroll down to the **Security** section
|
|
|
|
### Step 4: Find the API Key
|
|
|
|
You'll see a field labeled **API Key** with a long string of characters. It looks like:
|
|
```
|
|
a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6
|
|
```
|
|
|
|
### Step 5: Copy the API Key
|
|
|
|
1. Click the **copy icon** (📋) next to the API key, OR
|
|
2. Select the entire API key text and copy it (Ctrl+C / Cmd+C)
|
|
|
|
## For Each Service
|
|
|
|
### Radarr (Movies)
|
|
1. Go to `http://YOUR_SERVER_IP:7878`
|
|
2. Settings → General → Security
|
|
3. Copy the API Key
|
|
|
|
### Sonarr (TV Shows)
|
|
1. Go to `http://YOUR_SERVER_IP:8989`
|
|
2. Settings → General → Security
|
|
3. Copy the API Key
|
|
|
|
### Lidarr (Music)
|
|
1. Go to `http://YOUR_SERVER_IP:8686`
|
|
2. Settings → General → Security
|
|
3. Copy the API Key
|
|
|
|
## Using API Keys in beStream
|
|
|
|
1. Open beStream
|
|
2. Go to **Settings** → **Integrations**
|
|
3. For each service:
|
|
- Enter the URL: `http://YOUR_SERVER_IP:PORT`
|
|
- Paste the API Key
|
|
- Click **Test Connection**
|
|
- If successful, the status will show as "Connected"
|
|
|
|
## Security Notes
|
|
|
|
- **Keep API keys secret** - They provide full access to your services
|
|
- **Don't share API keys** - Anyone with the key can control your services
|
|
- **Regenerate if compromised** - You can regenerate keys in Settings → General → Security
|
|
|
|
## Troubleshooting
|
|
|
|
### Can't Access Web Interface
|
|
|
|
1. **Check if services are running:**
|
|
```bash
|
|
sudo systemctl status radarr
|
|
sudo systemctl status sonarr
|
|
sudo systemctl status lidarr
|
|
```
|
|
|
|
2. **Check firewall:**
|
|
```bash
|
|
sudo ufw allow 7878/tcp # Radarr
|
|
sudo ufw allow 8989/tcp # Sonarr
|
|
sudo ufw allow 8686/tcp # Lidarr
|
|
```
|
|
|
|
3. **Check service logs:**
|
|
```bash
|
|
sudo journalctl -u radarr -n 50
|
|
sudo journalctl -u sonarr -n 50
|
|
sudo journalctl -u lidarr -n 50
|
|
```
|
|
|
|
### API Key Not Working
|
|
|
|
1. **Verify the key is correct** - Make sure you copied the entire key
|
|
2. **Check for extra spaces** - API keys shouldn't have spaces
|
|
3. **Regenerate the key** - Settings → General → Security → Regenerate API Key
|
|
|
|
### Connection Test Fails in beStream
|
|
|
|
1. **Verify the URL** - Make sure it's `http://` not `https://` (unless you configured SSL)
|
|
2. **Check server IP** - Use the correct IP address of your Ubuntu server
|
|
3. **Check network** - Make sure your device can reach the server
|
|
4. **Check firewall** - Ensure ports are open on the server
|
|
|