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

docs: added page about platform restrictions [skip ci]

Browse Source
This commit is contained in:
Jagandeep Brar
2022-04-11 20:13:58 -04:00
parent 47a205aa08
commit 3fe23df542
12 changed files with 137 additions and 82 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@@ -1,9 +1,5 @@
# <img width="40px" src="./assets/images/branding_logo.png" alt="LunaSea"></img>&nbsp;&nbsp;LunaSea
[![App Store](https://img.shields.io/badge/%20download-iOS-red?logo=app-store&color=%232196F3&logoColor=white&style=flat)](https://www.lunasea.app/appstore)
[![Play Store](https://img.shields.io/badge/%20download-Android-red?logo=google-play&color=%234CAF50&logoColor=white&style=flat)](https://www.lunasea.app/playstore)
[![License](https://img.shields.io/github/license/JagandeepBrar/LunaSea?style=flat)](https://github.com/JagandeepBrar/LunaSea/blob/master/LICENSE.md)
LunaSea is a fully featured, open source self-hosted controller focused on giving you a seamless experience between all of your self-hosted media software remotely on your devices. LunaSea currently supports:
- [Lidarr](https://github.com/lidarr/lidarr)
@@ -22,7 +18,7 @@ LunaSea even comes with support for webhook-based push notifications, multiple i
## Releases
All releases for every build channel can be downloaded from the [build bucket](https://builds.lunasea.app), and all production releases for all platforms are also available on [GitHub](https://github.com/JagandeepBrar/LunaSea/releases).
All releases for every build channel can be downloaded from the [build bucket](https://builds.lunasea.app), and all stable releases for all platforms are also available on [GitHub](https://github.com/JagandeepBrar/LunaSea/releases).
- [Android](https://www.lunasea.app/playstore)
- [iOS](https://www.lunasea.app/appstore)
@@ -31,7 +27,7 @@ All releases for every build channel can be downloaded from the [build bucket](h
- [Web](https://web.lunasea.app)
- [Windows](https://builds.lunasea.app/#latest/stable/)
> Interested in using prerelease build channels of LunaSea? Learn the differences between all the channels and how to join one [here](https://www.lunasea.app/build-channels)!
Interested in using prerelease build channels of LunaSea? Learn the differences between all the build channels and how to join one [here](https://www.lunasea.app/build-channels)!
## Getting Started

12
docs.json
View File

@@ -17,12 +17,12 @@
"/getting-started/build-channels"
],
[
"Donations",
"/getting-started/donations"
"Frequently Asked Questions",
"/getting-started/frequently-asked-questions"
],
[
"FAQs",
"/getting-started/frequently-asked-questions"
"Platform Restrictions",
"/getting-started/platform-restrictions"
]
]
],
@@ -120,6 +120,10 @@
"/notifications/tautulli"
]
]
],
[
"Donations",
"/donations"
]
]
}

0
docs/getting-started/donations.mdx → docs/donations.mdx
View File

2
docs/getting-started/build-channels.mdx
View File

@@ -37,6 +37,8 @@ Stable releases can be downloaded from the [build bucket](https://builds.lunasea
1. [Download TestFlight for macOS](https://apps.apple.com/app/testflight/id899247664)
2. Join the [TestFlight stable channel](https://www.lunasea.app/testflight/stable)
3. Download LunaSea via the TestFlight application
LunaSea can also be downloaded from [Homebrew Cask](https://formulae.brew.sh/cask/lunasea)!
</TabItem>
<TabItem value="linux">
```bash

41
docs/getting-started/platform-restrictions.mdx Normal file
View File

@@ -0,0 +1,41 @@
---
title: Platform Restrictions
description: Breaking down what is and isn't supported on different platforms
---
# Platform Restrictions
The tables below showcases which modules or features may not be supported on each platform. If a module or feature is not listed, you can assume that every platform has full support for said module or feature!
> Work will continuously be down to try to achieve 100% feature parity between all platforms when possible!
## Module Support
| Module | Android | iOS | Linux | macOS | Windows | Web |
| :---------: | :-----: | :-: | :---: | :---: | :-----: | :-: |
| NZBGet | ✅ | ✅ | ✅ | ✅ | ✅ | ❌ |
| Overseerr | ✅ | ✅ | ✅ | ✅ | ✅ | ❌ |
| Tautulli | ✅ | ✅ | ✅ | ✅ | ✅ | ❌ |
| Wake on LAN | ✅ | ✅ | ✅ | ✅ | ✅ | ❌ |
## Feature Support
| Feature | Android | iOS | Linux | macOS | Windows | Web |
| :--------------------: | :-----: | :-: | :---: | :---: | :-----: | :-: |
| Local Backup & Restore | ✅ | ✅ | ✅ | ✅ | ✅ | ❌ |
| LunaSea Accounts | ✅ | ✅ | ❌ | ✅ | ❌ | ✅ |
| Notifications | ✅ | ✅ | ❌ | ✅ | ❌ | ❌ |
## Web-Specific Restrictions
#### HTTPS Requirement
LunaSea's web instances are hosted on [Netlify](https://www.netlify.com) and use [LetsEncrypt](https://letsencrypt.org/) TLS certificates to ensure that an encrypted connection is utilized when loading the LunaSea web application package.
One limitation this incurs is that most modern web browsers no longer support [mixed content](https://developer.mozilla.org/en-US/docs/Web/Security/Mixed_content), so it is required when using these browsers to utilize a reverse proxy (or something similar) to expose a secure (`HTTPS`) connection to your instances even when hosted on the same machine.
**All network communication occurs directly between your web browser and host machine**, but this is a limitation put forward by the web browsers.
#### Wake on LAN Support
Wake on LAN support will **never** be supported when using LunaSea on the web, because the Wake on LAN protocol relies on the [User Datagram Protocol (UDP)](https://en.wikipedia.org/wiki/User_Datagram_Protocol). UDP connections are not supported in the web browser because of underlying security constraints, and so it will not be possible to utilize wake on LAN now or at any point in the future when using LunaSea on the web.

14
docs/index.mdx
View File

@@ -3,7 +3,15 @@ title: LunaSea
description: Self-hosted software controller built using Flutter
---
# LunaSea
<Image
src="https://raw.githubusercontent.com/JagandeepBrar/LunaSea/master/assets/images/branding_logo.png"
width="250px"
alt="LunaSea"
zoom={false}
caption="Self-hosted software controller built using Flutter"
/>
## About
LunaSea is a fully featured, open source self-hosted controller focused on giving you a seamless experience between all of your self-hosted media software remotely on your devices. LunaSea currently supports:
@@ -20,3 +28,7 @@ LunaSea is a fully featured, open source self-hosted controller focused on givin
LunaSea even comes with support for webhook-based push notifications, multiple instances of applications using profiles, backup and restore functionality for your configuration, an AMOLED black theme, and more!
> LunaSea is purely a remote control application, it does not offer any functionality without software installed on a server/computer.
## License
See [LICENSE.md](https://github.com/JagandeepBrar/LunaSea/blob/master/LICENSE.md) for more information.

26
docs/lunasea/notifications.mdx
View File

@@ -13,12 +13,12 @@ Notifications are only supported on a limited set of platforms at this time. Pla
| Platform | Supported? |
| :------: | :--------: |
| Android | Yes ✅ |
| iOS | Yes ✅ |
| Linux | No ❌ |
| macOS | Yes ✅ |
| Windows | No ❌ |
| Web | No ❌ |
| Android | ✅ |
| iOS | ✅ |
| Linux | ❌ |
| macOS | ✅ |
| Windows | ❌ |
| Web | ❌ |
## Module Support
@@ -26,13 +26,13 @@ Not all modules are currently supported, below is a list of all supported module
| Module | Supported? | Deep Linking? |
| :-----------------------------------: | :--------: | :-----------: |
| [Lidarr](/notifications/lidarr) | Yes ✅ | No ❌ |
| NZBGet | No ❌ | No ❌ |
| [Overseerr](/notifications/overseerr) | Yes ✅ | No ❌ |
| [Radarr](/notifications/radarr) | Yes ✅ | Yes ✅ |
| SABnzbd | No ❌ | No ❌ |
| [Sonarr](/notifications/sonarr) | Yes ✅ | Yes ✅ |
| [Tautulli](/notifications/tautulli) | Yes ✅ | Yes ✅ |
| [Lidarr](/notifications/lidarr) | ✅ | ❌ |
| NZBGet | ❌ | ❌ |
| [Overseerr](/notifications/overseerr) | ✅ | ❌ |
| [Radarr](/notifications/radarr) | ✅ | ✅ |
| SABnzbd | ❌ | ❌ |
| [Sonarr](/notifications/sonarr) | ✅ | ✅ |
| [Tautulli](/notifications/tautulli) | ✅ | ✅ |
## Notification Types

20
docs/notifications/lidarr.mdx
View File

@@ -36,16 +36,16 @@ In Lidarr's web GUI, head to Settings -> Connect, hit the "+" button to add a ne
| Trigger | Supported? |
| :---------------------: | :--------: |
| On Grab | Yes ✅ |
| On Release Import | Yes ✅ |
| On Upgrade | Yes ✅ |
| On Download Failure | No ❌ |
| On Import Failure | No ❌ |
| On Rename | Yes ✅ |
| On Track Retag | Yes ✅ |
| On Application Update | No ❌ |
| On Health Issue | No ❌ |
| Include Health Warnings | No ❌ |
| On Grab | ✅ |
| On Release Import | ✅ |
| On Upgrade | ✅ |
| On Download Failure | ❌ |
| On Import Failure | ❌ |
| On Rename | ✅ |
| On Track Retag | ✅ |
| On Application Update | ❌ |
| On Health Issue | ❌ |
| Include Health Warnings | ❌ |
</TabItem>
<TabItem value="tags">

20
docs/notifications/overseerr.mdx
View File

@@ -42,16 +42,16 @@ In Overseerr's web GUI, head to Settings -> Notifications -> LunaSea. Ensure tha
| Trigger | Supported? |
| :----------------------------: | :--------: |
| Request Pending Approval | Yes ✅ |
| Request Automatically Approved | Yes ✅ |
| Request Approved | Yes ✅ |
| Request Declined | Yes ✅ |
| Request Available | Yes ✅ |
| Request Processing Failed | Yes ✅ |
| Issue Reported | Yes ✅ |
| Issue Comment | Yes ✅ |
| Issue Resolved | Yes ✅ |
| Issue Reopened | Yes ✅ |
| Request Pending Approval | ✅ |
| Request Automatically Approved | ✅ |
| Request Approved | ✅ |
| Request Declined | ✅ |
| Request Available | ✅ |
| Request Processing Failed | ✅ |
| Issue Reported | ✅ |
| Issue Comment | ✅ |
| Issue Resolved | ✅ |
| Issue Reopened | ✅ |
</TabItem>
</Tabs>

20
docs/notifications/radarr.mdx
View File

@@ -36,16 +36,16 @@ In Radarr's web GUI, head to Settings -> Connect, hit the "+" button to add a ne
| Trigger | Supported? |
| :------------------------------: | :--------: |
| On Grab | Yes ✅ |
| On Import | Yes ✅ |
| On Upgrade | Yes ✅ |
| On Rename | Yes ✅ |
| On Movie Delete | No ❌ |
| On Movie File Delete | No ❌ |
| On Movie File Delete For Upgrade | No ❌ |
| On Health Issue | Yes ✅ |
| Include Health Warnings | Yes ✅ |
| On Application Update | No ❌ |
| On Grab | ✅ |
| On Import | ✅ |
| On Upgrade | ✅ |
| On Rename | ✅ |
| On Movie Delete | ❌ |
| On Movie File Delete | ❌ |
| On Movie File Delete For Upgrade | ❌ |
| On Health Issue | ✅ |
| Include Health Warnings | ✅ |
| On Application Update | ❌ |
</TabItem>
<TabItem value="tags">

20
docs/notifications/sonarr.mdx
View File

@@ -36,16 +36,16 @@ In Sonarr's web GUI, head to Settings -> Connect, hit the "+" button to add a ne
| Trigger | Supported? |
| :--------------------------------: | :--------: |
| On Grab | Yes ✅ |
| On Import | Yes ✅ |
| On Upgrade | Yes ✅ |
| On Rename | Yes ✅ |
| On Series Delete | No ❌ |
| On Episode File Delete | No ❌ |
| On Episode File Delete For Upgrade | No ❌ |
| On Health Issue | Yes ✅ |
| Include Health Warnings | Yes ✅ |
| On Application Update | No ❌ |
| On Grab | ✅ |
| On Import | ✅ |
| On Upgrade | ✅ |
| On Rename | ✅ |
| On Series Delete | ❌ |
| On Episode File Delete | ❌ |
| On Episode File Delete For Upgrade | ❌ |
| On Health Issue | ✅ |
| Include Health Warnings | ✅ |
| On Application Update | ❌ |
</TabItem>
<TabItem value="tags">

36
docs/notifications/tautulli.mdx
View File

@@ -42,24 +42,24 @@ In Tautulli's web GUI, head to Settings -> Notification Agents, hit the "Add a n
| Trigger | Supported? |
| :--------------------------: | :--------: |
| Playback Start | Yes ✅ |
| Playback Stop | Yes ✅ |
| Playback Pause | Yes ✅ |
| Playback Resume | Yes ✅ |
| Playback Error | Yes ✅ |
| Transcode Decision Change | Yes ✅ |
| Watched | Yes ✅ |
| Buffer Warning | Yes ✅ |
| User Concurrent Streams | Yes ✅ |
| User New Device | Yes ✅ |
| Recently Added | Yes ✅ |
| Plex Server Down | Yes ✅ |
| Plex Server Back Up | Yes ✅ |
| Plex Remote Access Down | Yes ✅ |
| Plex Remote Access Back Up | Yes ✅ |
| Plex Update Available | Yes ✅ |
| Tautulli Update Available | Yes ✅ |
| Tautulli Database Corruption | Yes ✅ |
| Playback Start | ✅ |
| Playback Stop | ✅ |
| Playback Pause | ✅ |
| Playback Resume | ✅ |
| Playback Error | ✅ |
| Transcode Decision Change | ✅ |
| Watched | ✅ |
| Buffer Warning | ✅ |
| User Concurrent Streams | ✅ |
| User New Device | ✅ |
| Recently Added | ✅ |
| Plex Server Down | ✅ |
| Plex Server Back Up | ✅ |
| Plex Remote Access Down | ✅ |
| Plex Remote Access Back Up | ✅ |
| Plex Update Available | ✅ |
| Tautulli Update Available | ✅ |
| Tautulli Database Corruption | ✅ |
</TabItem>
<TabItem value="conditions">