PalDash - Palworld Server Dashboard & Control Panel

Palworld Dashboard and Control Panel for Self-Hosted Dedicated Palworld Servers

Admin Mode

An admin account currently has to be set up manually. run npm run password <yourpassword> in ./pw-back/ to create a hashed password, then copy it into the build process, whether you use .env files or the ./setup.sh script

Setup

There's a build script available in the ./bin folder of the project root.

1. Install Dependencies

1.1 Docker & Docker-Compose

• Install Docker if not installed yet
• Install Docker-Compose
• Important: Even if you are not running Palworld via Docker Image, this is still needed for the Paldex API that will be run alongside PalDash

1.1.1 CouchDB

• Warning: The newest version requires CouchDB. please re-run the setup.sh to ensure it's working.

1.2 Packages

sudo apt install wget unzip openssl 

• wget and unzip: used for downloading parts of the project
• openssl: used to generate random secrets

2. Install PalDash

chmod a+x ./setup.sh

This starts a semi-interactive installer. You will be prompted to set environment variables and supply the right folders used for sourcing the data. It's important to point the environment to the right folders, but since the frontend uses sveltekit, the env variables have to be declared at runtime. This is done by running the build.sh, which contains environment variables as argument overloads.

Manual Build Steps

Building the Projects

chmod a+x ./bin/build-all.sh
bin/build-all.sh

This will install the backend and frontend as runnable services:

• pw-back
• pw-front

Installing Services

chmod a+x ./bin/install-services.sh
bin/install-services.sh

This will install the backend and frontend as runnable services:

• pw-back
• pw-front

These will run in the background and are manageable via systemd.

Service Commands

sudo service pw-back [start|stop|status|reload]
sudo service pw-front [start|stop|status|reload]

use

• start to start the background services
• status to get information and see if start has succeeded
• stop to stop the service
• reload to stop and start again

Note

I've tried to make this work as a docker container but there's still some problems with the environment variables

and accessing storage & docker ps command. I'll fix this later on, if I find the time.

Compatibility

This Control Panel makes a few assumptions about your Setup:

• Docker installed and running jammsen/docker-palworld-dedicated-server

• Python 3 for running convert.py, the mvp for palworld data handling

• node ~> 21 installed (because why not)

You can also just run this inside the provided docker container by running docker-compose.

I'm automatically deploying this to my server with a bitbucket pipeline so I can't provide help with this.

Configuration (Docker config not yet working)

Edit the ENV files in the .docker-compose to change the configuration. This is still WIP so I won't provide a config list just yet.

Attributions

• Palsphere Icon shamelessly ripped from the internet, I'll replace this as soon as I get better at illustrator.
• Uses Palworld-Paldex-API to grab Images and Informations
• Google Material Icons
• write an issue if I forgot to attribute you. Thanks and love in advance.