Skip to content

INSTALL.md

Latest commit

 

History

History
173 lines (103 loc) · 6.81 KB

INSTALL.md

File metadata and controls

173 lines (103 loc) · 6.81 KB

Installation instructions

Platform-specific installation instructions can be found in this document.

Use the links below to jump to your platform.

Windows

Installer

Download the latest .exe installer from the Releases page and open it. Follow the on-screen instructions.

Portable

Download the latest .zip file from the 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 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 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 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: yay -S fladder-git
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 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

Alpha support added in v0.8.0 and contributions to add further 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 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 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 and here.

  1. Download and install Sideloadly from their downloads page.

  2. Download the latest iOS IPA file from the 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 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.

You can also preconfigure Seerr with this environment variable:

  • SEERR_BASE_URL: String URL for your Seerr/Jellyseerr instance.

Example:

BASE_URL=https://jellyfin.example.com
SEERR_BASE_URL=https://seerr.example.com

Web

You can also manually copy the web .zip build to any static file server such as Nginx, Caddy, or Apache

Tip

You can preconfigure Fladder by placing a config file in assets/config/config.json

config.json options:

{
	"baseUrl": "https://jellyfin.example.com",
	"seerrBaseUrl": "https://seerr.example.com"
}
  • baseUrl: String. Presets Jellyfin URL on login.
  • seerrBaseUrl: String. Presets Seerr URL in personal settings.