Skip to content
73 changes: 57 additions & 16 deletions INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,24 @@ 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)
- [Web](#web)
- [Installation instructions](#installation-instructions)
- [Windows](#windows)
- [Installer](#installer)
- [Portable](#portable)
- [macOS](#macos)
- [Homebrew](#homebrew)
- [Manual](#manual)
- [Linux](#linux)
- [Ubuntu/Debian](#ubuntudebian)
- [Arch](#arch)
- [Fedora](#fedora)
- [Android](#android)
- [Play Store](#play-store)
- [Manual](#manual-1)
- [iOS/iPadOS](#iosipados)
- [Sideloadly](#sideloadly)
- [Docker](#docker)
- [Web](#web)


## Windows
Expand All @@ -33,6 +38,16 @@ Run `fladder.exe` to start the application.

## macOS

### Homebrew

You can install Fladder via the [vikingnope/fladder](https://github.com/vikingnope/homebrew-fladder) tap:

```bash
brew install --cask vikingnope/fladder/fladder
```

### Manual

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.
Expand Down Expand Up @@ -74,10 +89,33 @@ Download the latest Linux `.zip` file from the [Releases](https://github.com/Don

Open a terminal and `cd` to the directory where you extracted Fladder to. Run `./Fladder` to open the application.

### Nix

You can install Fladder by adding it to your system flake inputs:

```nix
inputs.fladder.url = "github:DonutWare/Fladder/develop";
```

Then, add it to your `environment.systemPackages`:

```nix
environment.systemPackages = [
inputs.fladder.packages.${pkgs.system}.default
];
```

Alternatively, you can run it directly without installing:

```bash
nix run github:DonutWare/Fladder/develop
```

## 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.
Expand Down Expand Up @@ -136,10 +174,13 @@ You can install Fladder on your server to provide an alternate Jellyfin dashboar

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.
> We recommend setting the `BASE_URL` environment variable to your Jellyfin URL. This skips the login URL step in the web UI.

> [!NOTE]
> If you prefer the rootless version, change the image in the file to: `ghcr.io/donutware/fladder-rootless:latest`

Run `docker-compose up -d` to start the container. It will be available on `http://<server-ip>`.

## Web

Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,9 +107,9 @@ 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 tags: ```ghcr.io/donutware/fladder:latest```. or ```ghcr.io/donutware/fladder-rootless:latest```
You can pull the Docker version using the following tags: ```ghcr.io/donutware/fladder:latest``` or ```ghcr.io/donutware/fladder-rootless:latest```.

*Platform-specific installation and usage instructions can be found [here](https://github.com/DonutWare/Fladder/blob/develop/INSTALL.md).*
*Platform-specific installation and usage instructions can be found [here](INSTALL.md).*

<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>

Expand Down