Pufferpanel - ArchWiki

Jump to content

# Pufferpanel

From ArchWiki

Related articles

- Minecraft

From Pufferpanel:

  PufferPanel is an open source game server management panel designed to be easy to use and easy to install. PufferPanel supports Minecraft, Spigot, Sponge, Source Dedicated Servers, BungeeCord, PocketMine, Forge, and much more.

Note Although the panel itself is open source, Minecraft server software are EULA licensed, open source modifications such as Forge or Spigot still rely on the EULA licensed binary distributed by Mojang.

## Installation

Install the pufferpanel-binAUR package.

In order to be able to login to the web interface, and configure the installation you will need to create a user:

    # pufferpanel user add

This will bring up a command line interactive prompt.

Note Ensure to enter `Y` to the admin question, otherwise the user will not be able to configure the instance within #Configuration

After creating the admin user, you can Start/enable `pufferpanel.service`.

## Configuration

Pufferpanel configuration can be found under `/etc/pufferpanel`. Within this directory you will find a `config.json` file which contains all the configuration for the instance. Email templates can be found within `/etc/pufferpanel/email`, this allows for the configuration of the notification emails sent to users.

You can configure the panel through the web interface, by logging in as the administrator account which you created during #Installation and going to the `Settings`.

### Reverse proxy

By default, pufferpanel does not support TLS encryption, it relies on other web servers to reverse proxy to provide TLS support.

Note

- Upstream strongly recommends you to use TLS encryption (https) to prevent accounts credentials being leaked, pufferpanel should never be open to the internet unless reverse proxied.
- Regardless of the chosen HTTP server, ensure to Start/enable the service, otherwise pufferpanel will not be accessible over HTTPS.

#### Nginx

Ensure you have installed nginx, then follow the upstream guide [1].

#### Apache

Ensure you have installed Apache, then follow the upstream guide [2].

#### Caddy

Ensure you have installed Caddy, then follow the upstream guide [3].

### Database

By default, pufferpanel uses a sqlite3 database, located at `/var/lib/pufferpanel/database.db`.

Other, external databases, are also supported for scalability and redundancy, along with the ability to change the path of the embedded sqlite3 database.

#### MySQL/MariaDB

Ensure you have installed MariaDB and configured MariaDB, then follow the configuration provided by upstream [4].

#### PostgreSQL

Ensure you have installed PostgreSQL, followed initial configuration and created a user and database, then follow the configuration provided by upstream [5].

#### Microsoft SQL Server

Follow the configuration provided by upstream [6].

Note

- Microsoft SQL Server is proprietary unlike the other alternative databases provided above.
- Not supported by Arch Linux officially, must be installed using mssql-serverAUR AUR package.
- There is no ArchWiki page for the configuration of Microsoft SQL Server, thus you must follow the Microsoft Documentation.

## See also

- Official documentation

Categories:

- Servers
- Web admin interfaces

Pufferpanel
Add topic