Getting Started

Prerequisites

Before you start, make sure you have the following installed:

📧 You will also need a Mailserver to send emails. If you don't have one, you need to manually verify users in the database.

mkdir LicenseAPI && cd LicenseAPI
wget https://raw.githubusercontent.com/gnmyt/LicenseAPI/main/docker-compose.yml

Open the .env file and update the following environment variables:

MAIL_SERVER: The SMTP server to send emails.
MAIL_PORT: The SMTP server port.
MAIL_USER: The SMTP server username.
MAIL_PASS: The SMTP server password.
APP_URL: The URL of your LicenseAPI instance.
DISABLE_SIGNUPS: Set to true to disable user signups (after the first user is created).

docker compose up -d

✨ Well done! You have successfully installed LicenseAPI. Now you can access the LicenseAPI at http://localhost:8025.