PufferPanel

https://docs.pufferpanel.com/en/3.x/
Admin
PufferPanel is an open-source game server management platform that allows users to install,...
Tokens:53,266
Snippets:201
Trust Score:8.4
Update:1 year ago
Show doc for...
Tokens:
Raw
### Start PufferPanel Service

Source: https://docs.pufferpanel.com/en/3.x/installing

Enables and starts the PufferPanel service using systemctl.

```bash
sudo systemctl enable --now pufferpanel
```

--------------------------------

### Start and Enable PufferPanel Service

Source: https://docs.pufferpanel.com/en/3.x/_sources/installing

Enables the PufferPanel service to start automatically on boot and starts the service immediately using systemctl.

```bash
sudo systemctl enable --now pufferpanel
```

--------------------------------

### PufferPanel Email Configuration Example

Source: https://docs.pufferpanel.com/en/3.x/_sources/guides/email

This JSON snippet demonstrates the structure for configuring email settings within PufferPanel, including options for SMTP and Mailgun providers.

```json
{
  "panel": {
    "email": {
      "provider": "smtp",
      "from": "someone@gmail.com",
      "host": "smtp.gmail.com:587",
      "username": "someone@gmail.com",
      "password": "*******",
      "provider": "mailgun",
      "key": "your_api_key",
      "domain": "your_api_key"
    }
  }
}
```

--------------------------------

### Install PufferPanel (Ubuntu/Debian Manual Repo)

Source: https://docs.pufferpanel.com/en/3.x/installing

Manually adds the PufferPanel repository to Ubuntu/Debian systems and installs the package using apt.

```bash
echo "deb https://packagecloud.io/pufferpanel/pufferpanel/any/ any main" > sudo tee /etc/apt/sources.list.d/pufferpanel.list
sudo apt update
sudo apt-get install pufferpanel
```

--------------------------------

### Install PufferPanel (Red Hat Manual Repo)

Source: https://docs.pufferpanel.com/en/3.x/installing

Manually adds the PufferPanel repository to Red Hat-based systems and installs the package using yum.

```bash
echo "   [pufferpanel]
name=pufferpanel
baseurl=https://packagecloud.io/pufferpanel/pufferpanel/rpm_any/rpm_any/$basearch
repo_gpgcheck=1
gpgcheck=0
enabled=1
gpgkey=https://packagecloud.io/pufferpanel/pufferpanel/gpgkey
sslverify=1
sslcacert=/etc/pki/tls/certs/ca-bundle.crt
metadata_expire=300" > sudo tee /etc/yum.repos.d/pufferpanel.repo
  sudo yum install pufferpanel
```

--------------------------------

### Install Nginx on Ubuntu/Debian

Source: https://docs.pufferpanel.com/en/3.x/_sources/guides/ssl-setup-nginx

Installs the Nginx web server on Ubuntu or Debian-based systems using apt-get.

```bash
sudo apt-get update
sudo apt-get install nginx
```

--------------------------------

### Install nginx on Ubuntu/Debian

Source: https://docs.pufferpanel.com/en/3.x/guides/ssl-setup-nginx

Installs the nginx web server on Ubuntu or Debian-based systems using apt-get.

```bash
sudo apt-get update
sudo apt-get install nginx
```

--------------------------------

### Install PufferPanel (DEB-based)

Source: https://docs.pufferpanel.com/en/3.x/installing

Installs PufferPanel on Debian-based systems by adding the PufferPanel repository and then installing the package using apt.

```bash
curl -s https://packagecloud.io/install/repositories/pufferpanel/pufferpanel/script.deb.sh?any=true | sudo bash
sudo apt update
sudo apt-get install pufferpanel
```

--------------------------------

### Start PufferPanel Node Service

Source: https://docs.pufferpanel.com/en/3.x/guides/create-node

Enables and starts the PufferPanel service on the node using systemctl. This command ensures the service runs on boot and starts it immediately.

```bash
sudo systemctl enable --now pufferpanel
```

--------------------------------

### Install PufferPanel Repository (RPM-based)

Source: https://docs.pufferpanel.com/en/3.x/_sources/migrate

Installs the PufferPanel repository for RPM-based systems using a script from packagecloud.io.

```bash
curl -s https://packagecloud.io/install/repositories/pufferpanel/pufferpanel/script.rpm.sh?any=true | sudo bash
```

--------------------------------

### Get PufferPanel Version

Source: https://docs.pufferpanel.com/en/3.x/guides/getting-help

This command is used to retrieve the currently installed version of PufferPanel. It's a crucial piece of information to include when seeking support.

```bash
# pufferpanel version
```

--------------------------------

### Install PufferPanel (RPM-based)

Source: https://docs.pufferpanel.com/en/3.x/installing

Installs PufferPanel on RPM-based systems by adding the PufferPanel repository and then installing the package using yum.

```bash
curl -s https://packagecloud.io/install/repositories/pufferpanel/pufferpanel/script.rpm.sh?any=true | sudo bash
sudo yum install pufferpanel
```

--------------------------------

### Install PufferPanel Repository (RPM)

Source: https://docs.pufferpanel.com/en/3.x/_sources/installing

Installs the PufferPanel package repository for RPM-based systems using a curl script and then installs PufferPanel using yum.

```bash
curl -s https://packagecloud.io/install/repositories/pufferpanel/pufferpanel/script.rpm.sh?any=true | sudo bash
sudo yum install pufferpanel
```

--------------------------------

### Install PufferPanel on DEB-based Systems

Source: https://docs.pufferpanel.com/en/3.x/guides/create-node

Installs PufferPanel on Debian or Ubuntu systems. It first adds the PufferPanel repository using a curl script and then installs the pufferpanel package using apt-get.

```bash
curl -s https://packagecloud.io/install/repositories/pufferpanel/pufferpanel/script.deb.sh?any=true | sudo bash
sudo apt update
sudo apt-get install pufferpanel
```

--------------------------------

### Install nginx on CentOS

Source: https://docs.pufferpanel.com/en/3.x/guides/ssl-setup-nginx

Installs the nginx web server on CentOS systems using dnf after enabling the EPEL repository.

```bash
sudo dnf install epel-release
sudo dnf install nginx
```

--------------------------------

### Install Nginx on CentOS

Source: https://docs.pufferpanel.com/en/3.x/_sources/guides/ssl-setup-nginx

Installs the Nginx web server on CentOS systems using dnf, after enabling the EPEL repository.

```bash
sudo dnf install epel-release
sudo dnf install nginx
```

--------------------------------

### Install PufferPanel Theme

Source: https://docs.pufferpanel.com/en/3.x/guides/themes/installing

This snippet outlines the steps to install a custom theme for PufferPanel 3.x. It involves creating specific directories, placing the theme files, and setting correct file ownership for PufferPanel to access them.

```bash
sudo chown -R pufferpanel:pufferpanel /path/to/web/files
```

--------------------------------

### Install New Repository (RPM-based)

Source: https://docs.pufferpanel.com/en/3.x/migrate

Installs the PufferPanel repository for RPM-based systems (like CentOS/Fedora) using a script.

```bash
curl -s https://packagecloud.io/install/repositories/pufferpanel/pufferpanel/script.rpm.sh?any=true | sudo bash
```

--------------------------------

### Get PufferPanel Version

Source: https://docs.pufferpanel.com/en/3.x/_sources/guides/getting-help

This command retrieves the currently installed version of PufferPanel. It's a crucial piece of information when reporting issues or seeking support.

```console
# pufferpanel version
```

--------------------------------

### Install PufferPanel (RPM-based)

Source: https://docs.pufferpanel.com/en/3.x/_sources/guides/create-node

Installs the PufferPanel package on RPM-based systems using a script from packagecloud.io, followed by installing the package using yum.

```bash
curl -s https://packagecloud.io/install/repositories/pufferpanel/pufferpanel/script.rpm.sh?any=true | sudo bash
sudo yum install pufferpanel
```

--------------------------------

### Install PufferPanel Repository (DEB)

Source: https://docs.pufferpanel.com/en/3.x/_sources/installing

Installs the PufferPanel package repository for Debian-based systems using a curl script and then updates the package list and installs PufferPanel.

```bash
curl -s https://packagecloud.io/install/repositories/pufferpanel/pufferpanel/script.deb.sh?any=true | sudo bash
sudo apt update
sudo apt-get install pufferpanel
```

--------------------------------

### Access System Service Logs

Source: https://docs.pufferpanel.com/en/3.x/guides/getting-help

This command shows how to access logs for system services, which is relevant for PufferPanel installations managed by systemd or similar init systems. Logs are vital for troubleshooting.

```bash
journalctl
```

--------------------------------

### Install PufferPanel on RPM-based Systems

Source: https://docs.pufferpanel.com/en/3.x/guides/create-node

Installs PufferPanel on RPM-based systems like CentOS or Fedora. It adds the PufferPanel repository via a curl script and then installs the pufferpanel package using yum.

```bash
curl -s https://packagecloud.io/install/repositories/pufferpanel/pufferpanel/script.rpm.sh?any=true | sudo bash
sudo yum install pufferpanel
```

--------------------------------

### Add PufferPanel Admin User

Source: https://docs.pufferpanel.com/en/3.x/installing

Creates the first administrative user for PufferPanel.

```bash
sudo pufferpanel user add
```

--------------------------------

### Edit PufferPanel Configuration File

Source: https://docs.pufferpanel.com/en/3.x/_sources/guides/email

This command opens the PufferPanel configuration file in the nano text editor for modification.

```bash
sudo nano /etc/pufferpanel/config.json
```

--------------------------------

### Start PufferPanel Service

Source: https://docs.pufferpanel.com/en/3.x/_sources/guides/create-node

Enables and starts the PufferPanel systemd service, ensuring it runs on boot and is immediately active.

```bash
sudo systemctl enable --now pufferpanel
```

--------------------------------

### Install PufferPanel (DEB-based)

Source: https://docs.pufferpanel.com/en/3.x/_sources/guides/create-node

Installs the PufferPanel package on Debian-based systems using a script from packagecloud.io, followed by updating the package list and installing the package.

```bash
curl -s https://packagecloud.io/install/repositories/pufferpanel/pufferpanel/script.deb.sh?any=true | sudo bash
sudo apt update
sudo apt-get install pufferpanel
```

--------------------------------

### Install Theme and Set Permissions

Source: https://docs.pufferpanel.com/en/3.x/_sources/guides/themes/installing

This snippet demonstrates the command-line operations required to install a theme in PufferPanel 3.x. It includes changing ownership of web files to ensure PufferPanel can read them.

```bash
chown -R pufferpanel:pufferpanel /path/to/web/files
```

--------------------------------

### Install New Repository (DEB-based)

Source: https://docs.pufferpanel.com/en/3.x/migrate

Installs the PufferPanel repository for DEB-based systems (like Ubuntu/Debian) using a script and updates the package list.

```bash
curl -s https://packagecloud.io/install/repositories/pufferpanel/pufferpanel/script.deb.sh?any=true | sudo bash
sudo apt update
```

--------------------------------

### Add PufferPanel Repository Manually (Red-Hat)

Source: https://docs.pufferpanel.com/en/3.x/_sources/installing

Manually adds the PufferPanel YUM repository configuration for Red Hat-based systems and installs PufferPanel.

```bash
echo "   [pufferpanel]
    name=pufferpanel
    baseurl=https://packagecloud.io/pufferpanel/pufferpanel/rpm_any/rpm_any/$basearch
    repo_gpgcheck=1
    gpgcheck=0
    enabled=1
    gpgkey=https://packagecloud.io/pufferpanel/pufferpanel/gpgkey
    sslverify=1
    sslcacert=/etc/pki/tls/certs/ca-bundle.crt
    metadata_expire=300" > sudo tee /etc/yum.repos.d/pufferpanel.repo
sudo yum install pufferpanel
```

--------------------------------

### Install PufferPanel Repository (DEB-based)

Source: https://docs.pufferpanel.com/en/3.x/_sources/migrate

Installs the PufferPanel repository for Debian-based systems using a script from packagecloud.io and updates the apt package list.

```bash
curl -s https://packagecloud.io/install/repositories/pufferpanel/pufferpanel/script.deb.sh?any=true | sudo bash
sudo apt update
```

--------------------------------

### Install Certbot and Nginx plugin (Ubuntu/Debian)

Source: https://docs.pufferpanel.com/en/3.x/guides/ssl-setup-nginx

Installs Certbot and the Nginx plugin on Ubuntu/Debian systems for obtaining and managing SSL certificates.

```bash
sudo apt-get update
sudo apt-get install certbot python3-certbot-nginx
```

--------------------------------

### Install Certbot and Nginx plugin (CentOS)

Source: https://docs.pufferpanel.com/en/3.x/guides/ssl-setup-nginx

Installs Certbot and the Nginx plugin on CentOS systems for obtaining and managing SSL certificates.

```bash
sudo dnf install epel-release
sudo dnf install certbot python3-certbot-nginx
```

--------------------------------

### Add PufferPanel Repository Manually (Ubuntu/Debian)

Source: https://docs.pufferpanel.com/en/3.x/_sources/installing

Manually adds the PufferPanel APT repository to the sources list for Ubuntu and Debian systems, updates the package list, and installs PufferPanel.

```bash
echo "deb https://packagecloud.io/pufferpanel/pufferpanel/any/ any main" > sudo tee /etc/apt/sources.list.d/pufferpanel.list
sudo apt update
sudo apt-get install pufferpanel
```

--------------------------------

### Open PufferPanel Configuration File

Source: https://docs.pufferpanel.com/en/3.x/guides/email

This command opens the PufferPanel configuration file located at /etc/pufferpanel/config.json using the nano text editor for modification.

```bash
sudo nano /etc/pufferpanel/config.json
```

--------------------------------

### Add PufferPanel Repository (Red-Hat)

Source: https://docs.pufferpanel.com/en/3.x/_sources/guides/create-node

Configures the PufferPanel repository for Red Hat-based systems by creating a .repo file in the yum configuration directory, then installs the PufferPanel package.

```bash
echo "   [pufferpanel]
    name=pufferpanel
    baseurl=https://packagecloud.io/pufferpanel/pufferpanel/rpm_any/rpm_any/$basearch
    repo_gpgcheck=1
    gpgcheck=0
    enabled=1
    gpgkey=https://packagecloud.io/pufferpanel/pufferpanel/gpgkey
    sslverify=1
    sslcacert=/etc/pki/tls/certs/ca-bundle.crt
    metadata_expire=300" > sudo tee /etc/yum.repos.d/pufferpanel.repo
sudo yum install pufferpanel
```

--------------------------------

### Add PufferPanel Repository (Ubuntu/Debian)

Source: https://docs.pufferpanel.com/en/3.x/_sources/guides/create-node

Manually adds the PufferPanel repository to the apt sources list for Ubuntu and Debian systems, then updates the package list and installs the PufferPanel package.

```bash
echo "deb https://packagecloud.io/pufferpanel/pufferpanel/any/ any main" > sudo tee /etc/apt/sources.list.d/pufferpanel.list
sudo apt update
sudo apt-get install pufferpanel
```

--------------------------------

### Create Nginx Virtual Host Config (CentOS)

Source: https://docs.pufferpanel.com/en/3.x/_sources/guides/ssl-setup-nginx

Opens the Nginx configuration file for PufferPanel on CentOS systems using nano.

```bash
nano /etc/nginx/conf.d/pufferpanel.conf
```

--------------------------------

### Create Nginx Virtual Host Config (Ubuntu/Debian)

Source: https://docs.pufferpanel.com/en/3.x/_sources/guides/ssl-setup-nginx

Opens the Nginx configuration file for PufferPanel on Ubuntu/Debian systems using nano.

```bash
nano /etc/nginx/sites-enabled/pufferpanel.conf
```

--------------------------------

### Add PufferPanel Admin User

Source: https://docs.pufferpanel.com/en/3.x/_sources/installing

Creates a new user for PufferPanel and designates them as an administrator. It prompts the user to confirm if the new user should have admin privileges.

```bash
sudo pufferpanel user add
```

--------------------------------

### Install Certbot and Nginx Plugin (CentOS)

Source: https://docs.pufferpanel.com/en/3.x/_sources/guides/ssl-setup-nginx

Installs Certbot and its Nginx plugin on CentOS systems for obtaining and managing SSL certificates.

```bash
sudo dnf install epel-release
sudo dnf install certbot python3-certbot-nginx
```

--------------------------------

### PufferPanel Configuration Example

Source: https://docs.pufferpanel.com/en/3.x/_sources/guides/contributing

This JSON configuration file sets up various aspects of the PufferPanel development environment, including log paths, web server host and port, token paths, database dialect and URL, email template location, and daemon data directories.

```json
{
  "logs": "../PufferPanelData/logs",
  "web": {
    "host": "0.0.0.0:8080"
  },
  "token": {
    "private": "../PufferPanelData/private.pem",
    "public": "../PufferPanelData/public.pem"
  },
  "panel": {
    "database": {
      "dialect": "sqlite3",
      "url": "file:../PufferPanelData/database.db?cache=shared",
      "log": "true"
    },
    "web": {
      "files": "client/dist"
    },
    "email": {
      "templates": "assets/email/emails.json",
      "provider": "debug"
    }
  },
  "daemon": {
    "data": {
      "servers": "../PufferPanelData/servers",
      "modules": "../PufferPanelData/modules",
      "cache": "../PufferPanelData/cache"
    }
  }
}
```

--------------------------------

### Install Certbot and Nginx Plugin (Ubuntu/Debian)

Source: https://docs.pufferpanel.com/en/3.x/_sources/guides/ssl-setup-nginx

Installs Certbot and its Nginx plugin on Ubuntu/Debian systems for obtaining and managing SSL certificates.

```bash
sudo apt-get update
sudo apt-get install certbot python3-certbot-nginx
```

--------------------------------

### Restart PufferPanel Service

Source: https://docs.pufferpanel.com/en/3.x/_sources/guides/email

This command restarts the PufferPanel service to apply the updated configuration changes.

```bash
sudo systemctl restart pufferpanel
```

--------------------------------

### PufferPanel Development Configuration

Source: https://docs.pufferpanel.com/en/3.x/guides/contributing

An example JSON configuration file for setting up a PufferPanel development environment. This configuration specifies paths for logs, web server settings, token storage, database connection, email templates, and daemon data directories.

```json
{
  "logs": "../PufferPanelData/logs",
  "web": {
    "host": "0.0.0.0:8080"
  },
  "token": {
    "private": "../PufferPanelData/private.pem",
    "public": "../PufferPanelData/public.pem"
  },
  "panel": {
    "database": {
      "dialect": "sqlite3",
      "url": "file:../PufferPanelData/database.db?cache=shared",
      "log": "true"
    },
    "web": {
      "files": "client/dist"
    },
    "email": {
      "templates": "assets/email/emails.json",
      "provider": "debug"
    }
  },
  "daemon": {
    "data": {
      "servers": "../PufferPanelData/servers",
      "modules": "../PufferPanelData/modules",
      "cache": "../PufferPanelData/cache"
    }
  }
}
```

--------------------------------

### Add PufferPanel Repository on Red-Hat (Manual)

Source: https://docs.pufferpanel.com/en/3.x/guides/create-node

Manually configures the PufferPanel repository for Red Hat-based systems. It creates a .repo file with the necessary configuration details and then installs the pufferpanel package using yum.

```bash
echo "   [pufferpanel]
name=pufferpanel
baseurl=https://packagecloud.io/pufferpanel/pufferpanel/rpm_any/rpm_any/$basearch
repo_gpgcheck=1
gpgcheck=0
enabled=1
gpgkey=https://packagecloud.io/pufferpanel/pufferpanel/gpgkey
sslverify=1
sslcacert=/etc/pki/tls/certs/ca-bundle.crt
metadata_expire=300" > sudo tee /etc/yum.repos.d/pufferpanel.repo
  sudo yum install pufferpanel
```

--------------------------------

### Create SteamCMD Autoupdate Script

Source: https://docs.pufferpanel.com/en/3.x/_sources/games/sourceds/autoupdate

This script, placed in the specified path, uses SteamCMD to download updates for a given application ID. It logs in anonymously, sets the installation directory, updates the app, and quits.

```steamcmd
login anonymous
force_install_dir ..
app_update <APP_ID>
quit
```

--------------------------------

### Execute System Command with PufferPanel Operator

Source: https://docs.pufferpanel.com/en/3.x/templates/templates

The 'command' operator executes a command directly on the system. It's recommended to use this only when necessary and to make commands generic to the host operating system. The example shows executing a Java command to install a server.

```json
{
  "commands": [
    "java -jar installer.jar --installServer"
  ],
  "type": "command"
}
```

--------------------------------

### Add Manual Repo (Red-Hat)

Source: https://docs.pufferpanel.com/en/3.x/migrate

Manually configures the PufferPanel repository for Red-Hat based systems (like CentOS/Fedora) by creating a .repo file.

```bash
echo "   [pufferpanel]
name=pufferpanel
baseurl=https://packagecloud.io/pufferpanel/pufferpanel/rpm_any/rpm_any/$basearch
repo_gpgcheck=1
gpgcheck=0
enabled=1
gpgkey=https://packagecloud.io/pufferpanel/pufferpanel/gpgkey
sslverify=1
sslcacert=/etc/pki/tls/certs/ca-bundle.crt
metadata_expire=300" > sudo tee /etc/yum.repos.d/pufferpanel.repo
```

--------------------------------

### Run PufferPanel Backend

Source: https://docs.pufferpanel.com/en/3.x/guides/contributing

Executes the compiled PufferPanel backend binary.

```bash
./pufferpanel
```

--------------------------------

### Build PufferPanel Backend (Go)

Source: https://docs.pufferpanel.com/en/3.x/guides/contributing

Compiles the PufferPanel backend using Go. This command generates an executable binary for the application.

```go
go build -o pufferpanel github.com/pufferpanel/pufferpanel/v2/cmd
```

--------------------------------

### Configure Server Run Settings (JSON)

Source: https://docs.pufferpanel.com/en/3.x/_sources/templates/templates

Defines the commands and processes for starting and stopping a server. Includes settings for stop commands, pre- and post-start processors, the main server command, and environment variables.

```json
{
  "run": {
    "stop": "stop",
    "pre": [],
    "post": [],
    "command": "java -Xmx${memory} -jar server.jar"
  }
}
```

--------------------------------

### Configure PufferPanel Repository Manually (Red-Hat)

Source: https://docs.pufferpanel.com/en/3.x/_sources/migrate

Manually configures the PufferPanel repository for Red Hat-based systems by creating a .repo file.

```bash
echo "   [pufferpanel]
    name=pufferpanel
    baseurl=https://packagecloud.io/pufferpanel/pufferpanel/rpm_any/rpm_any/$basearch
    repo_gpgcheck=1
    gpgcheck=0
    enabled=1
    gpgkey=https://packagecloud.io/pufferpanel/pufferpanel/gpgkey
    sslverify=1
    sslcacert=/etc/pki/tls/certs/ca-bundle.crt
    metadata_expire=300" > sudo tee /etc/yum.repos.d/pufferpanel.repo
```

--------------------------------

### Install SRCDS Dependencies on Ubuntu

Source: https://docs.pufferpanel.com/en/3.x/games/srcds/dependencies

This snippet provides the commands to install the necessary lib32gcc1 dependency for SRCDS on Ubuntu. It includes adding the i386 architecture and updating the package list before installing the package.

```bash
dpkg --add-architecture i386
apt-get update
apt-get install lib32gcc1
```

--------------------------------

### Add Manual Repo (Ubuntu/Debian)

Source: https://docs.pufferpanel.com/en/3.x/migrate

Manually adds the PufferPanel repository to the APT sources list for Ubuntu/Debian systems and updates the package list.

```bash
echo "deb https://packagecloud.io/pufferpanel/pufferpanel/any/ any main" > sudo tee /etc/apt/sources.list.d/pufferpanel.list
sudo apt update
```

--------------------------------

### Restart PufferPanel Service

Source: https://docs.pufferpanel.com/en/3.x/guides/email

This command restarts the PufferPanel service to apply the updated configuration changes, including the email setup.

```bash
sudo systemctl restart pufferpanel
```

--------------------------------

### Install lib32gcc1 on Ubuntu

Source: https://docs.pufferpanel.com/en/3.x/_sources/games/srcds/dependencies

This snippet provides the bash commands to add the i386 architecture and install the lib32gcc1 dependency on Ubuntu systems, which is required for SRCDS.

```bash
dpkg --add-architecture i386
apt-get update
apt-get install lib32gcc1
```
Tokens:
Raw