Quick Install

Follow these steps to install and start a self-hosted LearnHouse instance using the LearnHouse CLI.

Step 1: Run the Setup Wizard

The quickest way to get started is to run the setup wizard directly using npx. No global installation is needed.

npx learnhouse@latest setup

curl -fsSL https://raw.githubusercontent.com/learnhouse/learnhouse/main/install.sh | bash

irm https://raw.githubusercontent.com/learnhouse/learnhouse/main/install.ps1 | iex

The wizard will prompt you for:

• Domain configuration — your domain name or localhost for local development
• Database settings — PostgreSQL configuration (defaults are provided)
• Admin credentials — email and password for the initial admin account
• Optional features — AI features, email delivery, and more

The wizard generates docker-compose.yml, .env, learnhouse.config.json, and an nginx or Caddy configuration based on your choices. Sensible defaults are provided for most options — you can press Enter to accept them and adjust settings later.

Step 2: Start LearnHouse

Once setup is complete, start all services:

learnhouse start

The CLI will pull the required Docker images (on first run), create the containers, and start all services. This typically takes one to two minutes on first launch.

Step 3: Access LearnHouse

Once all services are running, access LearnHouse at your configured domain or:

• http://localhost  (if using the default local configuration)

Log in with the admin credentials you provided during setup.

Verifying the Installation

Run the built-in diagnostics to check that everything is working:

learnhouse doctor

This command checks Docker, container health, port availability, DNS resolution, and disk space, then reports any issues it finds.

You can also verify the health endpoint directly:

curl http://localhost/api/v1/health

Next Steps

• CLI Reference — Learn all available CLI commands.
• Configuration — Customize your instance with environment variables, AI, email, and more.