View .md

Windows (Docker Desktop)

Install FeatherPanel on Windows with the PowerShell installer and Docker Desktop. Covers the menu, the C:\featherpanel folder, port 4831, updates, backups and FeatherCli.

On this page

The PowerShell installer (install.ps1) runs the panel in Docker Desktop with the same docker-compose.yml as the Linux Docker install. It is meant for testing and small setups. Game servers still need a Linux node running FeatherWings.

Requirements

  • PowerShell 5.1 or newer. The backup tools use the tar command that ships with Windows 10 and later.
  • Docker Desktop, started and fully running. The installer stops with an error if docker info fails.
  • Administrator rights. The script asks for elevation through UAC if you did not start it as administrator.

Install

Open PowerShell and run:

irm https://get.featherpanel.com/stable.ps1 | iex

Then choose [0] Panel and [0] Install Panel, and pick a release type: Stable, Development (the develop branch) or a custom branch or commit. The installer:

  1. Creates C:\featherpanel with backups and migrations folders and an install.log.
  2. Downloads docker-compose.yml from the main branch.
  3. Pulls the images and runs docker compose up -d.
  4. Installs a featherpanel command in C:\Program Files\FeatherPanel and adds it to the system PATH. It runs php cli inside the featherpanel_backend container, so featherpanel help works like on Linux. See Panel CLI.

Open http://localhost:4831 and register. The first account becomes the administrator.

MenuOptions
PanelInstall, Uninstall (removes containers, volumes and C:\featherpanel), Update (pulls new images and restarts), Backup Manager
Backup ManagerCreate, list, restore and delete backups of the Docker volumes; export a migration package (featherpanel_migration_<time>.tar.gz) and import one on another machine
CLIInstall, uninstall or update FeatherCli (feathercli.exe from the latest GitHub release)

Backing up and migrating FeatherWings is only available in the Linux installer.

Options

ParameterEffect
-DevUse a development build without asking.
-DevBranch, -DevShaPick the branch or commit for a development build.

To pass parameters, save the script first, for example irm https://get.featherpanel.com/stable.ps1 -OutFile install.ps1, then run .\install.ps1 -Dev.

Frequently asked questions

Can I run FeatherWings on Windows?

No. The Windows installer only sets up the panel and FeatherCli. FeatherWings and FeatherQuilld need a Linux host.

Which URL opens the panel after install?

http://localhost:4831 on the same machine. From elsewhere use the machine's IP on port 4831 and allow that port in Windows Firewall.

Who becomes the administrator?

The first account that registers. Register right after the install finishes.