diff --git a/docs/modules/lidarr.md b/docs/modules/lidarr.md index 5277c379..c95359a7 100644 --- a/docs/modules/lidarr.md +++ b/docs/modules/lidarr.md @@ -4,7 +4,65 @@ description: How to configure and add Lidarr to LunaSea # Lidarr -{% hint style="info" %} -Coming Soon! +Adding your Lidarr instance to LunaSea only requires a few steps to get going! + +{% hint style="warning" %} +This documentation only covers adding Lidarr to LunaSea via local network \(LAN\) connections, and does not cover exposing Lidarr externally and connecting remotely. {% endhint %} +## Preparing Lidarr + +### Find Your Local Network IP Address + +Finding your local network IP address of the machine running Lidarr is the first step to get setup. To find your local IP address, please look at the following guides: + +* \*\*\*\*[**macOS**](https://osxdaily.com/2010/11/21/find-ip-address-mac/)\*\*\*\* +* \*\*\*\*[**Ubuntu**](https://ubuntuhandbook.org/index.php/2020/07/find-ip-address-ubuntu-20-04/)\*\*\*\* +* \*\*\*\*[**Windows**](https://support.microsoft.com/en-us/windows/find-your-ip-address-f21a9bbc-c582-55cd-35e0-73431160a1b9) + +If you are running a different operating system, you can use any search engine to look up "Find local IP address on <your operating system>" to typically find tons of guides for any platform. + +{% hint style="info" %} +It is recommended to set your host machine's IP address to be statically assigned instead of dynamic/DHCP. This ensures that the IP address will not change through machine or network reboots. +{% endhint %} + +### Check What Port is Being Used + +If using the default installation, Lidarr runs on port **8686**. In most cases, this port is not changed and does not need to be changed. + +The simplest way to check is to go to Lidarr's web GUI, go to Settings -> General and note the value entered into "Port Number". + +### Ensure Lidarr is Accessible Across Your Network + +To ensure that Lidarr is accessible across your local network, check the following: + +* In Lidarr's web GUI, go to Settings -> General and enable advanced settings. Ensure that the "Bind Address" is set to `*`, as this makes Lidarr bind to all network interfaces on the host machine. +* Check any enabled firewalls to confirm that the port running Lidarr is not being blocked. +* **\(Windows\)**: Ensure that Lidarr has been run as administrator at least once. + +### Check If You Are Using a URL Base + +In Lidarr's web GUI, go to Settings -> General and check the value of "URL Base". If you have nothing set, you can move on. If you do have a value set, please remember the set value as it will be necessary when setting the host within LunaSea. + +## Connecting in LunaSea + +### Host + +The host is a combination of multiple values found above: + +* The local IP address +* The por +* If being used, the URL base + +Combine all the values into the following format: `:/` + +For example, if Lidarr is running on port 7878 on a machine that has the IP address 192.168.100.100, the host is: `http://192.168.100.100:7878`. + +### API Key + +The API key is copied from Lidarr's web GUI, by going to Settings -> General and finding the API key value. + +### Custom Headers + +Custom headers allows users to attach custom request headers to each API call that is made. This is typically an advanced feature, and is not necessary in most network configurations. +