LearnHouse

https://docs.learnhouse.app
Admin
LearnHouse is an open-source learning management system that enables anyone to create and deliver...
Tokens:4,492
Snippets:71
Trust Score:7.3
Update:7 months ago
Show doc for...
Tokens:
Raw
### Quick Start: Clone, Configure, and Run LearnHouse

Source: https://docs.learnhouse.app/self-hosting/hosting-guide

This snippet outlines the essential commands to quickly set up and run LearnHouse Community Edition. It involves cloning the repository, copying the environment example file, configuring environment variables, and starting the services using Docker Compose. Ensure Docker and Docker Compose are installed and meet the prerequisites.

```bash
git clone https://github.com/learnhouse/community-edition.git
cd community-edition
cp env.example .env
# Edit .env with your configuration
docker-compose -f docker-compose.yml up -d
```

--------------------------------

### Quick Start Self Hosting with Docker Compose

Source: https://docs.learnhouse.app/self-hosting/overview

This snippet provides the essential commands to quickly set up and run LearnHouse using Docker Compose. It requires Docker Engine and Docker Compose to be installed on the host machine. The commands copy an example environment file and then start the services in detached mode.

```bash
cp .env.example .env
docker-compose -f docker-compose.yml up -d
```

--------------------------------

### Install Frontend Dependencies

Source: https://docs.learnhouse.app/setup-dev-environment

Installs all necessary frontend dependencies using pnpm. This command ensures that all required Node.js packages are downloaded and installed for the frontend.

```bash
pnpm i
```

--------------------------------

### Run Frontend Development Server

Source: https://docs.learnhouse.app/setup-dev-environment

Starts the frontend development server using pnpm. This command builds and serves the frontend application, allowing you to view and interact with it locally.

```bash
pnpm run dev
```

--------------------------------

### Install Python Dependencies

Source: https://docs.learnhouse.app/setup-dev-environment

Installs all necessary Python dependencies for the backend using 'uv'. This command ensures that all required libraries are available for the backend to function correctly.

```bash
uv sync
```

--------------------------------

### Build and Run Backend Docker Images

Source: https://docs.learnhouse.app/setup-dev-environment

Builds and runs the backend and database Docker images using Docker Compose. Ensure your container runtime has at least 4GB of RAM allocated. This command starts a Postgres database, a Redis server, and a Collaboration nodejs server.

```bash
docker-compose up -d
```

--------------------------------

### Navigate to Frontend Folder

Source: https://docs.learnhouse.app/setup-dev-environment

Changes the current directory to the frontend folder within the LearnHouse project. This is necessary for frontend-specific setup and commands.

```bash
cd apps/web
```

--------------------------------

### Run Backend in Development Mode

Source: https://docs.learnhouse.app/setup-dev-environment

Starts the backend server in development mode using 'uv run'. This command is used to run the main Python application file for the backend.

```bash
uv run app.py
```

--------------------------------

### Configure Single Organization Mode (Frontend .env)

Source: https://docs.learnhouse.app/self-hosting/organization-hosting-modes

This configuration sets up LearnHouse for a single organization. It disables multi-organization mode and specifies a default organization slug. This is the default setup for new installations.

```env
NEXT_PUBLIC_LEARNHOUSE_MULTI_ORG=false
NEXT_PUBLIC_LEARNHOUSE_DEFAULT_ORG=defaultorg
```

--------------------------------

### Generate Secrets for LearnHouse Configuration

Source: https://docs.learnhouse.app/self-hosting/hosting-guide

This snippet demonstrates how to generate secure random keys required for LearnHouse configuration, specifically for JWT and authentication secrets. These commands should be executed in a terminal environment where OpenSSL is available. The generated keys are used in the `.env` file.

```bash
openssl rand -base64 32
```

--------------------------------

### Clone LearnHouse Repository

Source: https://docs.learnhouse.app/setup-dev-environment

Clones the LearnHouse repository from GitHub to your local machine. This is the first step in setting up the development environment.

```bash
git clone https://github.com/learnhouse/learnhouse
```

--------------------------------

### Navigate to LearnHouse Directory

Source: https://docs.learnhouse.app/setup-dev-environment

Changes the current directory to the root of the cloned LearnHouse repository. This is necessary to execute subsequent commands within the project.

```bash
cd learnhouse
```

--------------------------------

### Configure Frontend Environment Variables

Source: https://docs.learnhouse.app/setup-dev-environment

Sets up the .env file for the frontend with essential environment variables. Note that 'NEXT_PUBLIC_LEARNHOUSE_MULTI_ORG' should be set to 'false' for local development.

```dotenv
NEXT_PUBLIC_LEARNHOUSE_MULTI_ORG=false
NEXT_PUBLIC_LEARNHOUSE_DEFAULT_ORG=default
NEXT_PUBLIC_LEARNHOUSE_API_URL=http://localhost:1338/api/v1/
NEXT_PUBLIC_LEARNHOUSE_BACKEND_URL=http://localhost:1338/
NEXT_PUBLIC_LEARNHOUSE_DOMAIN=localhost:3000
NEXT_PUBLIC_LEARNHOUSE_TOP_DOMAIN=localhost
NEXT_PUBLIC_LEARNHOUSE_COLLABORATION_WS_URL=wss://localhost:1998
NEXTAUTH_SECRET="my-very-secret-key" 
NEXTAUTH_URL=http://localhost:3000/
```

--------------------------------

### Navigate to Backend API Folder

Source: https://docs.learnhouse.app/setup-dev-environment

Changes the current directory to the backend API folder within the LearnHouse project. This is required for backend-specific configurations and commands.

```bash
cd apps/api
```

--------------------------------

### Enable AI via Environment Variables

Source: https://docs.learnhouse.app/self-hosting/ai

Configure AI settings for LearnHouse by setting environment variables. `LEARNHOUSE_OPENAI_API_KEY` is required for authentication, and `LEARNHOUSE_IS_AI_ENABLED` controls the feature's activation.

```bash
export LEARNHOUSE_OPENAI_API_KEY="your-openai-api-key"
export LEARNHOUSE_IS_AI_ENABLED="true"
```

--------------------------------

### Configure AI in YAML Config File

Source: https://docs.learnhouse.app/self-hosting/ai

Set up AI integration for LearnHouse by modifying the `config.yaml` file. This includes providing your OpenAI API key and enabling the AI functionality.

```yaml
ai_config:
    openai_api_key: "your-openai-api-key"
    is_ai_enabled: true
```

--------------------------------

### Configure Multi Organization Mode (Frontend .env)

Source: https://docs.learnhouse.app/self-hosting/organization-hosting-modes

This configuration enables LearnHouse's multi-organization mode. Note that full multi-organization support for self-hosting is still in progress, and currently only single organizations are supported.

```env
NEXT_PUBLIC_LEARNHOUSE_MULTI_ORG=true
```

--------------------------------

### Organization AI Configuration JSON

Source: https://docs.learnhouse.app/self-hosting/ai

Defines the AI settings for a specific organization within LearnHouse. This JSON structure allows granular control over AI models, features, and usage limits on a per-organization basis.

```json
{
  "AIConfig": {
    "ai_model": "gpt-3.5-turbo",
    "embeddings": "text-embedding-ada-002",
    "enabled": true,
    "features": {
      "activity_ask": true,
      "course_ask": false,
      "editor": true,
      "global_ai_ask": false
    },
    "limits": {
      "limits_enabled": true,
      "max_asks": 200
    }
  },
  "GeneralConfig": {
    "active": true,
    "color": "#000000",
    "limits": {
      "limits_enabled": false,
      "max_staff": 0,
      "max_storage": 0,
      "max_users": 0
    },
    "users": {
      "signup_mechanism": "inviteOnly"
    }
  }
}
```
Tokens:
Raw