Set Up Playnite Web
Overview
Playnite Web consists of the following components:
Component | Deployment Mechanism | Purpose |
|---|---|---|
Playnite Web Plugin | Download and install to Playnite. | Sends and receives messages via MQTT when data in Playnite is changed. |
Playnite Web App | Docker image. | Syncs Playnite games to game database, web UI, and GraphQL API that may be used to power your own experiences. |
Sync Library Processor | Docker image. | Downloads asssets and updates database for library syncs. |
Postgres Database | Docker image or bring your own. | Stores synced data from Playnite and other Playnite Web settings/data. |
MQTT broker | Docker image or bring your own. | Communication bus between Playnite Web App and the Sync Library processor. |
Playnite Web MQTT Plugin (Optional) | Download and install to Playnite. | Send commands to Playnite via MQTT messages. |
Step 1 - Deployment
Recommended Deployment (Docker Compose)
For self-hosted users, we recommend you use Docker Compose.
See the Deploy Playnite Web with Docker Compose for more info.
Manual Deployment
For more advanced scenarios, you can deploy Playnite Web manually.
See the Deploy Playnite Web Manually for more info.
Step 2 - Load Playnite Web for the First Time
For security, do not expose your Playnite Web instance to the internet until you complete this process.
When you load Playnite Web for the first time, you will create an account with administrator permissions to configure your instance:
Navigate to your Playnite instance URL, e.g.,
http://$APP_HOST:$APP_PORT.Follow the prompts to register a new user account.
Step 3 - Install the Playnite Web Plugin
You can find Playnite Web by searching for it in Playnite’s extensions. It is a Generic extension type.
Alternatively, you can manually install it with below instructions.
Download the Playnite Web extension corresponding to the Playnite Web App image version. See releases, the extension asset is named "Playnite Web Plugin".
Open Playnite and drag downloaded file into Playnite. It should prompt to install the plugin.
Step 4 - Configure the Playnite Web Plugin
Open the plugin's settings and enter the connection information to your Playnite Web instance; including your registered username and password.
Provide a custom name for this Playnite instance. Playnite Web supports multiple Playnite instances per user.
If you re-install Windows or Playnite, ensure you use the same custom name value; otherwise you’ll end up with a new library and orphan the original one.
Ensure you map your library sources to the platforms you own.
Step 5 - Sync Your Games Library
New syncs can take some time before games appear. Note that game cover art are downloaded from IGN based on a match of the game’s name and IGN’s database. For mismatches, you can manually correct this after the library is fully synced.
You only need to sync your games library manually once. After you sync it, future updates in Playnite will automatically sync to Playnite Web.
To manually sync your Playnite games library with Playnite Web:
Open the Playnite Settings menu.
Select Extensions → Playnite Web → Sync Library.
Once you're done, you can access your games library by navigating to the web app (http://$APP_HOST:$APP_PORT) and logging in with your credentials.