majjo/lunasea
1
0
Fork 0
mirror of https://github.com/jagandeepbrar/lunasea.git synced 2026-08-31 04:32:32 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: style adjustments [skip ci]

Browse Source
This commit is contained in:
Jagandeep Brar
2022-02-21 10:47:37 -05:00
parent 41df7fe5c5
commit 3e8aebd0e7
5 changed files with 32 additions and 37 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
docs/SUMMARY.md
View File

@@ -43,8 +43,7 @@
## Resources
* [Discord](https://www.lunasea.app/discord)
* [Feedback Board](http://www.lunasea.app/feedback)
* [Feedback Board](https://www.lunasea.app/feedback)
* [Reddit](https://www.lunasea.app/reddit)
* [System Status](https://www.lunasea.app/status)
* [Translate](https://www.lunasea.app/translate)
* [Website](https://www.lunasea.app)

3
docs/lunasea/local-backup-and-restore.md
View File

@@ -14,11 +14,10 @@ Because all encryption and decryption occurs on-device, it is fully end-to-end e
Creating a backup in LunaSea is simple and painless! Simply head to the Settings and enter the "System" menu. Simply hit "Backup to Device" to start the backup process.
The backup will use the system-level sharesheet to allow you to save the backup \(a `.lunasea` file\). Please ensure to keep the `.lunasea` extension when saving the file, as backups without a .lunasea extension will not be selectable.
The backup will use the system-level sharesheet to allow you to save the backup (a `.lunasea` file). Please ensure to keep the `.lunasea` extension when saving the file, as backups without a `.lunasea` extension will not be selectable.
## Restoring a Backup
Restoring a backup in LunaSea is as simple as creating the backup! Simply head to the Settings and enter the "System" menu. Simply hit "Restore from Device" to start the restore process.
The restoration process will request the password used to encrypt the original backup.

21
docs/modules/lidarr.md
View File

@@ -7,7 +7,7 @@ description: How to configure and add Lidarr to LunaSea
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.
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
@@ -16,11 +16,11 @@ This documentation only covers adding Lidarr to LunaSea via local network \(LAN\
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)
* [**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.
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.
@@ -30,19 +30,19 @@ It is recommended to set your host machine's IP address to be statically assigne
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 -&gt; General and note the value entered into "Port Number".
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 -&gt; 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.
* 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.
* **(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 -&gt; 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.
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
@@ -60,9 +60,8 @@ For example, if Lidarr is running on port 8686 on a machine that has the IP addr
### API Key
The API key is copied from Lidarr's web GUI, by going to Settings -&gt; General and finding the API key value.
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.

21
docs/modules/radarr.md
View File

@@ -7,7 +7,7 @@ description: How to configure and add Radarr to LunaSea
Adding your Radarr instance to LunaSea only requires a few steps to get going!
{% hint style="warning" %}
This documentation only covers adding Radarr to LunaSea via local network \(LAN\) connections, and does not cover exposing Radarr externally and connecting remotely.
This documentation only covers adding Radarr to LunaSea via local network (LAN) connections, and does not cover exposing Radarr externally and connecting remotely.
{% endhint %}
## Preparing Radarr
@@ -16,11 +16,11 @@ This documentation only covers adding Radarr to LunaSea via local network \(LAN\
Finding your local network IP address of the machine running Radarr 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)
* [**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 &lt;your operating system&gt;" to typically find tons of guides for any platform.
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.
@@ -30,19 +30,19 @@ It is recommended to set your host machine's IP address to be statically assigne
If using the default installation, Radarr runs on port **7878**. In most cases, this port is not changed and does not need to be changed.
The simplest way to check is to go to Radarr's web GUI, go to Settings -&gt; General and note the value entered into "Port Number".
The simplest way to check is to go to Radarr's web GUI, go to Settings -> General and note the value entered into "Port Number".
### Ensure Radarr is Accessible Across Your Network
To ensure that Radarr is accessible across your local network, check the following:
* In Radarr's web GUI, go to Settings -&gt; General and enable advanced settings. Ensure that the "Bind Address" is set to `*`, as this makes Radarr bind to all network interfaces on the host machine.
* In Radarr's web GUI, go to Settings -> General and enable advanced settings. Ensure that the "Bind Address" is set to `*`, as this makes Radarr bind to all network interfaces on the host machine.
* Check any enabled firewalls to confirm that the port running Radarr is not being blocked.
* **\(Windows\)**: Ensure that Radarr has been run as administrator at least once.
* **(Windows)**: Ensure that Radarr has been run as administrator at least once.
### Check If You Are Using a URL Base
In Radarr's web GUI, go to Settings -&gt; 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.
In Radarr'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
@@ -60,9 +60,8 @@ For example, if Radarr is running on port 7878 on a machine that has the IP addr
### API Key
The API key is copied from Radarr's web GUI, by going to Settings -&gt; General and finding the API key value.
The API key is copied from Radarr'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.

21
docs/modules/sonarr.md
View File

@@ -7,7 +7,7 @@ description: How to configure and add Sonarr to LunaSea
Adding your Sonarr instance to LunaSea only requires a few steps to get going!
{% hint style="warning" %}
This documentation only covers adding Sonarr to LunaSea via local network \(LAN\) connections, and does not cover exposing Sonarr externally and connecting remotely.
This documentation only covers adding Sonarr to LunaSea via local network (LAN) connections, and does not cover exposing Sonarr externally and connecting remotely.
{% endhint %}
## Preparing Sonarr
@@ -16,11 +16,11 @@ This documentation only covers adding Sonarr to LunaSea via local network \(LAN\
Finding your local network IP address of the machine running Sonarr 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)
* [**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 &lt;your operating system&gt;" to typically find tons of guides for any platform.
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.
@@ -30,19 +30,19 @@ It is recommended to set your host machine's IP address to be statically assigne
If using the default installation, Sonarr runs on port **8989**. In most cases, this port is not changed and does not need to be changed.
The simplest way to check is to go to Sonarr's web GUI, go to Settings -&gt; General and note the value entered into "Port Number".
The simplest way to check is to go to Sonarr's web GUI, go to Settings -> General and note the value entered into "Port Number".
### Ensure Sonarr is Accessible Across Your Network
To ensure that Sonarr is accessible across your local network, check the following:
* In Sonarr's web GUI, go to Settings -&gt; General and enable advanced settings. Ensure that the "Bind Address" is set to `*`, as this makes Sonarr bind to all network interfaces on the host machine.
* In Sonarr's web GUI, go to Settings -> General and enable advanced settings. Ensure that the "Bind Address" is set to `*`, as this makes Sonarr bind to all network interfaces on the host machine.
* Check any enabled firewalls to confirm that the port running Sonarr is not being blocked.
* **\(Windows\)**: Ensure that Sonarr has been run as administrator at least once.
* **(Windows)**: Ensure that Sonarr has been run as administrator at least once.
### Check If You Are Using a URL Base
In Sonarr's web GUI, go to Settings -&gt; 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.
In Sonarr'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
@@ -60,9 +60,8 @@ For example, if Sonarr is running on port 8989 on a machine that has the IP addr
### API Key
The API key is copied from Sonarr's web GUI, by going to Settings -&gt; General and finding the API key value.
The API key is copied from Sonarr'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.