Quick Start Guide - Self-Hosted

Cloud Version Available

The fastest way to get started with Hi.Events is to use our cloud version. No setup required - just register and start creating events immediately. Continue reading if you specifically would like to self-host Hi.Events.

Try Cloud Version

The easiest and recommended way to try Hi.Events is to use Docker. Docker will run the entire application in a series of containers, so you don’t have to worry about installing any dependencies (other than Docker).

Deploying to a Cloud Provider

For information on deploying to a Cloud Provider, see here.

Quick Start with Docker

If you want to get Hi.Events up and running quickly without focusing on local development, use the following commands in your terminal:

git clone https://github.com/HiEventsDev/hi.events.git
cd hi.events/docker/all-in-one
cp .env.example .env
# Follow the instructions in the README in ./docker/all-in-one to generate the APP_KEY and JWT_SECRET,
# then add them to the .env file you just created
docker compose up -d

⚠️

Don’t skip cp .env.example .env. The docker-compose.yml file reads roughly 35 variables from that .env file. Without it, they are all substituted as empty values and the application will not work.

This will set up the entire application using Docker Compose.

Once the containers are running, open http://localhost:8123/auth/register to create your first account.

Local Development Environment

For those interested in local development, follow these steps to quickly get Hi.Events up and running:

Clone the repository:

git clone https://github.com/HiEventsDev/hi.events.git

Change directory to the Docker setup folder for development:

cd hi.events/docker/development

Start the services with Docker Compose:

./start-dev.sh

ℹ️

By default, the local environment uses unsigned keys. This means your browser will show a warning saying the site is unsecure. This can safely be ignored. There are instructions on how to generate signed keys in the local development guide.

For a more detailed setup, including configuration of environment variables and external services, continue with the installation guide.

Quick Start (Cloud)Deploying