Running on Forge

Forge is a paid server management service, tailored to hosting Laravel apps on Server Providers like DigitalOcean, Linode, Vultr, Amazon, Hetzner and more.

If you have a Forge account and a connected server, you can easily set up an Umami installation. Umami requires a PostgreSQL database, so make sure your server runs PostgreSQL and has pnpm installed (npm install -g pnpm).

Prerequisites#

1. Configure the (sub) domain you would like to have Umami available on. Usually, you do this by configuring your DNS config with an A-Record that points to your server's IP address.

Setup#

1. Select your desired Server in Forge.

2. Go to Sites > New Site

   • Enter the domain name
   • Project Type: Static HTML
   • Check Create Database, enter a Database Name
   • Click Add

3. To install the Repository, fork the https://github.com/umami-software/umami project to your GitHub account or install from the official repository.

   • Enter the Repository path: umami-software/umami
   • Uncheck Install Composer Dependencies
   • Click Install Repository

4. Update the deployment script and add the following after the git pull origin $FORGE_SITE_BRANCH command.

   pnpm install
   pnpm build

   Remove these lines, since we don't have artisan or use PHP:

   ( flock -w 10 9 || exit 1
   echo 'Restarting FPM...'; sudo -S service $FORGE_PHP_FPM reload ) 9>/tmp/fpmlock
   
   if [ -f artisan ]; then
       $FORGE_PHP artisan migrate --force
   fi

5. In Forge, go to your Server page, click Database and add a user to the just created database.

6. Create the database connection string and add it to your .env file:

   DATABASE_URL=postgresql://username:mypassword@localhost:5432/mydb

7. Perform the initial project setup, via SSH:

   pnpm install
   pnpm build

   The first build creates the required database tables and a default login account with username admin and password umami. Change the password after your first login.

8. Go to your Umami site, click on SSL in the left menu, and add an SSL certificate.

9. Click Edit files > Edit Nginx Configuration and overwrite the following block:

   location / {
     proxy_pass http://localhost:3000;
     proxy_http_version 1.1;
     proxy_set_header Upgrade $http_upgrade;
     proxy_set_header Connection 'upgrade';
     proxy_set_header Host $host;
     proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
     proxy_cache_bypass $http_upgrade;
   }

   This configuration will route the traffic to the Node.js server that Umami runs on.

10. In Forge, go to your Server page, click Daemons and add New Daemon to keep the Umami Node.js server up and running.

    • Command: pnpm start
    • Directory: /home/forge/umami.yourdomain.tld
    • Click Create

You should now be able to reach your Umami project.