Getting started
Learn how to install CourseLit on your own server.
Introduction
CourseLit is designed to run on a single server (or a compute).
If you want to run it on something like Kubernetes, you can easily customize it to fit your needs as it is comprised of separate Docker containers for the database, the API and the front end app.
HELP WANTED: If you have set up CourseLit on Kubernetes successfully, please consider contributing it back to the project. Submit a PR.
Having said that, let's begin.
Installation Steps
Step 1. Run the installer
Fire up your terminal and issue the following command
When you run the script, you will be asked for the following inputs.
Enter your domain name (FQDN).
Provide the value of your domain name here. For example example.com.
Do you want to turn off SSL?
By default, CourseLit is served over HTTPS. If you have not pointed your domain name to the server yet or you don't want to use HTTPS for any other reason, type y. This will start CourseLit in non-HTTPS mode.
The installer script has been tested on Ubuntu 20.04 LTS.
After providing the inputs, the installer will bring up the application. Here are a few things you should know about your CourseLit installation.
~/.config/<your-domain.ext> directory will contain all the configuration files and a backup script.
Take a backup of .env file stored in this directory. It contains settings like database passwords etc. which you will need in-order to debug things later on.
~/<your-domain.ext> directory will contain all the app data including databases and user uploads.
Take regular backups of this directory using the backup script stored in ~/.config/<your-domain.ext> .
Step 2. Sign up for an account
You should immediately sign up for an account on your new site before sending any traffic to it, as the very first user who signs up automatically becomes an administrator.
Once you have signed up, you can control all aspects of your website by visiting https://your-domain.com/create route. For more, visit the administration section of this book.
Congratulations! You now have a fully functioning teaching portal at your disposal. Go figure. 🤩
Troubleshooting
Installer fails with the error "Can't find a suitable configuration file in this directory or any parent. Are you in the right directory?"
Delete ~/.config/<your-domain-name.ext> folder and re-run the script.
Something's Not Clear?
Come chat with us in our official Discord channel.
Last updated