Home

Welcome to the Elfra wiki!

In this wiki, you'll find all of the related documentation of features and sections for getting started and configuring the framwork for your needs!

The documentation in german

ELFRA Abschlussdokumentation_032026.pdf

1. Install

⚠️ IMPORTANT ⚠️

Make sure you have supabase setup and created a ".env" file with the necessary environment variables. (The file needs to be created in the root directory) You can use the ".env.example" file as a reference/base.

---

We recommed to download the latest stable release and not use the main branch for your install!

---

Method 1: Build it for later re-use of the Image

To Build the current Version use the command:

🛑 Don't build the container if you haven't created the '.env' file with the correct variables yet!

docker compose build

This builds the container under the name "Elfra" with the current version as "tag".

To run the container now use this command:

docker compose up *This will start the latest Version used in docker compose

OR THIS

docker run -d
  --name elfra-app
  -p 3000:3000 
  -v courses:/app/content/courses
  -v config:/app/customconfig 
  -e NODE_ENV=production 
  --restart unless-stopped 
  elfra:1.0.0

Replace "x.x.x" with the version number of the tag you are installing. E.g.: 1.0.0
🚩 If you use this command you have to use docker stop <container_id_or_name> to stop it

Now you can stop/end the container by using

docker compose stop Keeps files and mounted volumes

OR

docker compose down !! If you use "down" the container will also get removed !!

---

Method 2: Build and start it

To Build the current Version use the command:

docker compose up --build

This builds the container under the name "Elfra" with the current version as "tag" and also starts it.

Now you can stop/end the container by using

docker compose stop Keeps files and mounted volumes

OR

docker compose down !! If you use "down" the container will also get removed !!

---

⚠️ With all methods the image and firsttime mounted volumes will always persist so you can use it later to build other instances!

---

2. Getting Started & Configure

Now since you have everything setup, you can start to configure your application and add courses. For now, courses have to be created manually. Down the road this should be done with the Elfra Config Tool.

If you want to know how to create a course click here

Configure

Its importand to know that you will get 2 folder bind into the docker container:

📂: elfra_courses
📂: elfra_config 📂: elfra_data

elfra_courses

This folder is generated in your Home directory (~/elfra/courses) on first start of the container. Here you can manage your WBTs and edit them. For now you have to make them by hand (Tutorial). Later they will be generated by the Elfra Config Tool

elfra_config

This folder is generated in your Home directory (~/elfra/config) on first start of the container. This folder is home to your config.ts file wich is beeing created and edited by the Elfra Config Tool

elfra_data

This folder is generated in your Home directory (~/elfra/data) on first start of the container. This folder is home to all the data wich is referenced inside Elfra. Images, Fonts and so on.

FAQ

How do I add courses ?

To add courses, you can just create one following the steps [here](https://github.com/Saftladen-Tech/Elfra/wiki/Creating-courses). After you have created on, you need to add it to the "elfra_course" volume inside docker!

How to Style the framework ?

If you want to style ELFRA pleas use the [Elfra Config Tool](https://github.com/Saftladen-Tech/Elfra-Config-Tool) to create the configfile with the styling you want!