pixies

::: tip Why use a reverse proxy? In this case we use a reverse proxy as an intermediate layer between you and Pixies. This has the advantage that you don't have to call Pixies via a port, but via a normal domain. :::

Installation

If you already have a reverse proxy installed, you can skip this step. Which of the two reverse proxies you want to use is up to you. However, we recommend nginx for this guide.

::: code-group

sudo apt-get install nginx -y

sudo apt-get install apache2 -y

:::

Configuring Pixies

This section explains how to connect Pixies to your reverse proxy. Again, select here which reverse proxy you used.

::: code-group

# Create a file named pixies.conf under /etc/nginx/sites-available. Here we use nano
sudo nano /etc/nginx/sites-available/pixies.conf

server {
    listen 80;
    listen [::]:80;

    server_name your-domain.com;

    location / {
        proxy_pass http://localhost:5216;
    }
}

# Activate the file and restart the reverse proxy
sudo ln -s /etc/nginx/sites-available/pixies.conf /etc/nginx/sites-enabled/pixies.conf
sudo systemctl restart nginx

# Create a file named pixies.conf under /etc/apache2/sites-available. Here we use nano
sudo nano /etc/apache2/sites-available/pixies.conf

<VirtualHost *:80>
    ServerName your-domain.com

    ProxyPreserveHost On
    ProxyPass / http://localhost:5216/
    ProxyPassReverse / http://localhost:5216/
</VirtualHost>

# Enable the mod_proxy and mod_proxy_http modules
sudo a2enmod proxy
sudo a2enmod proxy_http

# Activate the file and restart the reverse proxy
sudo a2ensite pixies.conf
sudo systemctl restart apache2

:::

Configuring an SSL certificate with Let's Encrypt

This section explains how to set up an SSL certificate from Let's Encrypt for Pixies.

::: tip Are you using Cloudflare? If you use Cloudflare and don't want to set up an SSL certificate from Let's Encrypt, you can just use the simply activate the Cloudflare proxy function. This is sufficient in most cases. If you decide to use the Cloudflare proxy, you can skip this section. :::

::: code-group

# Install certbot
sudo apt-get install certbot python3-certbot-nginx -y

# Run Certbot and specify the domain
sudo certbot --nginx -d your-domain.com

# Install certbot
sudo apt-get install certbot python3-certbot-apache -y

# Run Certbot and specify the domain
sudo certbot --apache -d your-domain.com