Deploying Gemfast

This document covers the setup and options of theme feature described in the doc title

Table of Contents

Supported Platforms

Gemfast is built and tested on the following platforms.

Platform Architecture Version
Debian amd64, arm64 11, 12
Ubuntu amd64, arm64 22.04, 23.04

Gemfast has the following hardware requirements:

  • Minimum - 2 Core CPU, 2 GB RAM, 10 GB of free disk space in /var
  • Recommended Average/Typical - 2 Core CPU, 4 GB RAM, 10 GB of free disk space in /var
  • Recommended Large - 4 Core CPU, 8 GB RAM, 20 GB of free disk space in /var

Software Requirements

Gemfast comes pre-packaged with all requirements except systemd which is included by default on the supported platforms. Ruby is not required.

Automatic HTTPS

Gemfast is packaged with Caddy which acts as a reverse proxy and can manage HTTPS certificates automatically.

In order to leverage automatic HTTPS certificates via Caddy, the following is required:

  • Valid domain name
  • A/AAAA record pointing to the server that gemfast will be installed on
  • The caddy { host = "" } setting is set to the A/AAAA record in /etc/gemfast/gemfast.hcl
  • Port 443 is open
  • Port 80 is open to the world
    • Caddy will automatically re-route requests from port 80 to port 443 once a certificate has been granted by let’s encrypt

Caddy and let’s encypt also support other ways to generate a valid HTTPS cerificate without opening up port 80 to the world. If you require another method, please contact support.

Manual HTTPS

If providing your own HTTPS cerificate is required, make sure the certificate and key are in .pem format and placed somewhere on the server. Next set the following values in /etc/gemfast/gemfast.hcl:

caddy {
  tls_cert_file = "/path/to/cert.pem"
  tls_cert_key_file = "/path/to/key.pem"

Restart Gemfast:

sudo systemctl restart gemfast.service

Configuring Gemfast
Backup and Restore