Skip to content

Automated setup for Linux‐API

Jump to bottom
Ivole32 edited this page Feb 22, 2026 · 3 revisions

Note: This automated installer is provided for convenience. It can be faster than manual setup but may be less flexible and may require adjustments on some systems. If you are comfortable configuring services manually, prefer the manual instructions.

Prerequisites

  • A machine running Ubuntu (24/25 recommended) with a user that has sudo privileges.
  • Internet access to download packages and container images.
  • Git installed. On Ubuntu install with:
sudo apt update
sudo apt install -y git wget curl

1. Download the setup script

Download the installer script from the repository. Review it before running if you prefer:

wget https://raw.githubusercontent.com/Ivole32/Linux-API/main/setup.sh -O setup.sh
# or view it first
less setup.sh

2. Make the script executable and run it

Make the script executable and run it. Run it inside a terminal you can monitor.

chmod +x ./setup.sh
sudo ./setup.sh

Notee: The script may prompt for confirmation. If you trust the script, accepting defaults is usually fine; otherwise inspect the script and re-run only the parts you need.

3. Configure environment and application settings

The installer will create a .env file in the repository root containing a generated API_KEY_SECRET and placeholders for other variables. Edit .env to add database credentials, hostnames, and any other settings shown in example.env.

Recommended steps:

cp example.env .env          # if the script didn't create .env
# open .env in your editor and paste the printed API_KEY_SECRET value
# then fill other variables (DB credentials, host, etc.)

After editing .env, verify application-specific settings in api/config/config.py and update values there if needed. Documentation about what those options mean is here.

Keep .env secret.

Support

Made with ❤️ by Ivole32 — https://github.com/Ivole32

Clone this wiki locally