From cc09203dfdac34dd37eb5af5f5a04cc4eb929ee5 Mon Sep 17 00:00:00 2001 From: Bailey <39453825+bazzadazza72@users.noreply.github.com> Date: Fri, 15 Nov 2024 00:17:07 +1030 Subject: [PATCH] chore(documentation): Add installation and usage instructions (#141) --- INSTALL.md | 133 +++++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 16 +------ 2 files changed, 135 insertions(+), 14 deletions(-) create mode 100644 INSTALL.md diff --git a/INSTALL.md b/INSTALL.md new file mode 100644 index 0000000..6e33c13 --- /dev/null +++ b/INSTALL.md @@ -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`
+[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. + +Get it on Google Play +### 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: ` () @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://`. + +> [!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. + diff --git a/README.md b/README.md index 9628f50..fb91ee0 100644 --- a/README.md +++ b/README.md @@ -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```. - -### Play Store (Android) Get it on Google Play - - ## How to Contribute Interest in contributing? Here are a couple of ways you can help: