Installation

Frappe Learning can be installed in multiple ways, depending on your requirements. You can either use Frappe Cloud for a fully managed experience or install Learning on your own server.

The following sections explain each installation method in detail.

Managed Hosting (Frappe Cloud)

You can instal Frappe Learning with a single click using Frappe Cloud, the managed hosting platform for Frappe applications.

• Sign up here to get started
• Your Learning instance will be ready in a few minutes

If you already have a Frappe Cloud site, you can install Frappe Learning directly from the Frappe Cloud Marketplace.

Self Hosting

Production Setup

Follow these steps to set up Frappe Learning in production:

Step 1: Download the easy install script

wget https://frappe.io/easy-install.py

Step 2: Run the deployment command

python3 ./easy-install.py deploy \
    --project=learning_prod_setup \
    --email=your_email.example.com \
    --image=ghcr.io/frappe/lms \
    --version=stable \
    --app=lms \
    --sitename subdomain.domain.tld

Replace the following parameters with your values:

• your_email.example.com: Your email address
• subdomain.domain.tld: Your domain name where Learning will be hosted

The script will set up a production-ready instance of Frappe Learning with all the necessary configurations in about 5 minutes.

Development Setup

Docker Setup

To run Learning using Docker, ensure the following are installed:

• Docker
• Docker Compose
• Git

Refer to Docker documentation. After that, follow the steps below:

Step 1: Create a directory and download the required files

mkdir frappe-learning
cd frappe-learning

# Download the docker-compose file
wget -O docker-compose.yml https://raw.githubusercontent.com/frappe/lms/develop/docker/docker-compose.yml

# Download the setup script
wget -O init.sh https://raw.githubusercontent.com/frappe/lms/develop/docker/init.sh

Step 2: Start the containers

docker compose up -d

Step 3: Access the application.

The site http://lms.localhost:8000/lms should now be available. The default credentials are:

Username: Administrator
Password: admin

Local Setup (Bench)

To set up the repository locally, follow the steps mentioned below:

1. Install a bench and set up a frappe-bench directory by following the Installation Steps
2. Start the server by running bench start
3. In a separate terminal window, create a new site by running bench new-site learning.test
4. Map your site to localhost with the command bench --site learning.test add-to-hosts
5. Get the Learning app. Run bench get-app https://github.com/frappe/lms
6. Run bench --site learning.test install-app lms.
7. Now open the URL http://learning.test:8000/lms on your browser, you should see the app running