gabehf/Fladder
1
0
Fork 0
mirror of https://github.com/gabehf/Fladder.git synced 2026-03-07 21:48:14 -08:00
Code Issues Projects Releases Packages Wiki Activity Actions

chore(documentation): Add installation and usage instructions (#141)

Browse source
This commit is contained in:
Bailey 2024-11-15 00:17:07 +10:30 • committed by GitHub
parent 6ec0b31c16
commit cc09203dfd
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 135 additions and 14 deletions
Download patch file Download diff file Expand all files Collapse all files

133
INSTALL.md Normal file
View file

@ -0,0 +1,133 @@
# Installation instructions
Platform-specific installation instructions can be found in this document.
*Use the links below to jump to your platform.*
- [Windows](#windows)
- [macOS](#macos)
- [Linux](#linux)
- [Ubuntu/Debian](#ubuntudebian)
- [Arch](#arch)
- [Fedora](#fedora)
- [Android](#android)
- [Play Store](#play-store)
- [Manual installation](#manual)
- [iOS](#iosipados)
- [Sideloadly](#sideloadly)
- [Docker](#docker)
## Windows
Download the latest `.zip` file from the [Releases](https://github.com/DonutWare/Fladder/releases) page and extract it somewhere on your PC.
Run `fladder.exe` to start the application.
## macOS
1. Download the latest `*.dmg` file from the [Releases](https://github.com/DonutWare/Fladder/releases) page.
2. Open it and copy the Fladder application file into your `Applications` folder, or another place on your Mac.
3. Right-click the application and click Open while holding `Control`. This will bypass the unidentified developer warning.
> [!TIP]
> Alternatively, to allow the app to run, open `System Settings > Privacy & Security > Scroll down to Security > Open Anyway`.
## Linux
> [!NOTE]
> You can install Fladder using Flatpak if you prefer an easier installation method. Download the latest `.flatpak` file from the [Releases](https://github.com/DonutWare/Fladder/releases) page to get started.
### Ubuntu/Debian
> [!TIP]
> If you experience issues attempting to run Fladder with the process exiting with `libmpv` shared library errors, you may need to install `libmpv-dev` by running `sudo apt install libmpv-dev`.
Download the latest Linux `.zip` file from the [Releases](https://github.com/DonutWare/Fladder/releases) page and extract it somewhere on your computer.
Open a terminal and `cd` to the directory where you extracted Fladder to. Run `./Fladder` to open the application.
### Arch
An AUR package is available for download (thanks to @tam1m).
You can download it using your favourite AUR helper.
[Yay](https://github.com/Jguer/yay): `yay -S fladder-git`<br>
[Paru](https://github.com/Morganamilo/paru): `paru -S fladder-git`
### Fedora
> [!TIP]
> If you experience issues attempting to run Fladder with the process exiting with `libmpv` shared library errors, you may need to install `mpvlibs` by running `yum install mpvlibs`.
Download the latest Linux `.zip` file from the [Releases](https://github.com/DonutWare/Fladder/releases) page and extract it somewhere on your computer.
Open a terminal and `cd` to the directory where you extracted Fladder to. Run `./Fladder` to open the application.
## Android
> [!IMPORTANT]
> This app is currently not compatible with Android TV, however contributions to add support are always appreciated.
### Play Store
This is the recommended way to install Fladder on Android.
<a href='https://play.google.com/store/apps/details?id=nl.jknaapen.fladder&pcampaignid=pcampaignidMKT-Other-global-all-co-prtnr-py-PartBadge-Mar2515-1'><img alt='Get it on Google Play' src='https://play.google.com/intl/en_us/badges/static/images/badges/en_badge_web_generic.png' width=250/></a>
### Manual
If your device can't access the Play Store, you can install Fladder manually.
1. Download the latest `.apk` file from the [Releases](https://github.com/DonutWare/Fladder/releases) page and save it to your device.
2. Open it to start the installation. You may need to allow unknown apps to be installed on your device, as this will be disallowed by default.
## iOS/iPadOS
### Sideloadly
> [!NOTE]
> Installing using Sideloadly is the only method of using Fladder on iOS or iPadOS at this time. See [this issue](https://github.com/DonutWare/Fladder/issues/40) for more information.
> [!IMPORTANT]
> If you are using Windows, you must install the web versions of iTunes and iCloud (**not the Microsoft Store versions**) before installing Sideloadly. You can download them [here](https://www.apple.com/itunes/download/win64) and [here](https://updates.cdn-apple.com/2020/windows/001-39935-20200911-1A70AA56-F448-11EA-8CC0-99D41950005E/iCloudSetup.exe).
1. Download and install Sideloadly from their [downloads page](https://sideloadly.io/#download).
2. Download the latest iOS IPA file from the [Releases](https://github.com/DonutWare/Fladder/releases) page and save it to your computer.
3. Plug your device into your computer and open iTunes.
4. Click the device icon in the top left next to the navigation buttons.
5. Ensure **Sync with this device over Wi-Fi** is checked.
6. Click Apply, then Done, then close iTunes.
7. Open Sideloadly and click the Open IPA button in the top left. Select the IPA you downloaded earlier.
8. Make sure your device is listed under **iDevice**. It will usually look like this: `<device name> (<iOS version>) <UDID> @USB`.
9. Enter your Apple ID in the **Apple ID** box. Creating a second Apple ID is recommended, but not required.
10. Click Start. You will be prompted to enter your Apple ID password. Enter it and allow any two-factor authentication, if required.
11. The installation process will take a while. Once it's finished, you will see the Fladder icon on your home screen or in your App Library.
> [!NOTE]
> Your password is only used for authentication to Apple's servers. It is not sent to any third parties.
> [!IMPORTANT]
> Once installed, Fladder will only be valid for 7 days. Enabling auto refresh will keep the app from expiring (this should already be enabled). Your computer needs to be on for this to occur.
## Docker
You can install Fladder on your server to provide an alternate Jellyfin dashboard.
Copy the contents of the [docker-compose.yml](https://raw.githubusercontent.com/DonutWare/Fladder/refs/heads/develop/docker-compose.yml) file and save it to your server.
Run `docker-compose up -d` to start the container. It will be available on `http://<server-ip>`.
> [!TIP]
> We recommend changing the `BASE_URL` environment variable to the URL you use to access Jellyfin, as this will skip entering it when you load the web UI.

16
README.md
View file

@ -84,26 +84,14 @@ Web/Desktop [try out the web build!](https://DonutWare.github.io/Fladder)
The latest executables for Windows, macOS, Linux, iOS, Android and Web can be found on the [releases page](https://github.com/DonutWare/Fladder/releases).
You can pull the Docker version using the following tag: ```ghcr.io/donutware/fladder:latest```
You can pull the Docker version using the following tag: ```ghcr.io/donutware/fladder:latest```.
<!-- ### Linux
*Platform-specific installation and usage instructions can be found [here](https://github.com/DonutWare/Fladder/blob/develop/INSTALL.md).*
An AUR package is available (thanks @tam1m). Install it using your favourite AUR helper.
Yay: `yay -S fladder-git`
Paru: `paru -S fladder-git`
-->
### Play Store (Android)
<a href='https://play.google.com/store/apps/details?id=nl.jknaapen.fladder&pcampaignid=pcampaignidMKT-Other-global-all-co-prtnr-py-PartBadge-Mar2515-1'><img alt='Get it on Google Play' src='https://play.google.com/intl/en_us/badges/static/images/badges/en_badge_web_generic.png' width=250/></a>
<!--
### AltStore (iOS)
The iOS app can be installed through AltStore by adding this repo
<a href='https://shorturl.at/Pj7Z7'><img alt='Get it on AltStore' src='https://camo.githubusercontent.com/d09e24361b730206b40f7c3a5950a17ba3341e67c533e27c155ddb34f0440b44/68747470733a2f2f692e696d6775722e636f6d2f343671684541762e706e67' width=250/></a> -->
## How to Contribute
Interest in contributing? Here are a couple of ways you can help: