Skip to content
Jambo Docs

Installation

Requirements

  • PHP 8.4+ with extensions: ctype, iconv, sodium
  • Composer
  • MySQL 8+, PostgreSQL 14+, or SQLite
  • Node.js 18+ + npm (for frontend assets)
  • Optional: Meilisearch (full-text search), Symfony CLI
Terminal window
composer create-project jambostack/jambo-api my-project
cd my-project

This creates a fresh project with all dependencies installed. Skip to Configure.

Install via Git

Terminal window
git clone https://github.com/jambostack/jambo-api.git
cd jambo-api


composer install --no-dev --optimize-autoloader
npm install && npm run build

Configure

Terminal window
cp .env.example .env

Edit .env with your database credentials and application settings — see Environment Variables for the full reference. Then run:

Terminal window
php bin/console doctrine:database:create
php bin/console doctrine:migrations:migrate
php bin/console app:setup

The app:setup command creates the admin account and prints the credentials. Default values:

FieldDefault
Emailadmin@jambostack.site
Passwordadmin1234

You can override them:

Terminal window
php bin/console app:setup --email="you@example.com" --password="StrongPassword123"

Verify

Start the Symfony local server:

Terminal window
symfony serve -d

Open https://localhost:8000 and log in. Your API is ready at https://localhost:8000/api/{project-uuid}.

Next steps