Reference: https://docs.tutor.edly.io/gettingstarted.html
Ubuntu Server 24.04
On NUC hardware, if there is a previous Windows install, use diskpart to clean the drive partitions.
Install Ubuntu Server 24.04 according to Ubuntu Server Installation.
Docker Engine
Reference: https://docs.docker.com/engine/install/ubuntu/
Install Docker Engine
Setup Docker’s apt repository.
# Add Docker's official GPG key: sudo apt-get update sudo apt-get install ca-certificates curl sudo install -m 0755 -d /etc/apt/keyrings sudo curl -fsSL https://download.docker.com/linux/ubuntu/gpg -o /etc/apt/keyrings/docker.asc sudo chmod a+r /etc/apt/keyrings/docker.asc # Add the repository to Apt sources: echo \ "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.asc] https://download.docker.com/linux/ubuntu \ $(. /etc/os-release && echo "$VERSION_CODENAME") stable" | \ sudo tee /etc/apt/sources.list.d/docker.list > /dev/null sudo apt-get update
Install the Docker packages.
sudo apt-get install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin
Verify Docker installation.
sudo docker run hello-world
Python pip
sudo apt install python3-pip libyaml-dev
DNS
Update IPAM so that subdomains point to server.
Add an alias for all sub-domains to the record for the server.
Open the record in IPAM.
Click on the EDIT button.
Click the NEXT button until reaching the ALIASES CONFIGURATION page.
Enter the
*.
sub-domain in the Name field, including the server name. For example,*.ece-openedx-01
.The Domain should be set to the same as for the server. For example,
eng.uwaterloo.ca
.The Type should be set to CNAME.
Click the ADD button. The new alias should appear in the list of aliases.
It may take about 5 minutes for the DNS changes to propagate and be accessible from your local computer.
Tutor
Install Tutor:
pip install "tutor[full]"
Add current user to docker group:
sudo usermod -aG docker $USER
Logout and log back in.
Start tutor:
tutor local launch
Enter parameters:
Are you configuring a production platform? Type 'n' if you are just testing Tutor on your local computer [Y/n] Your website domain name for students (LMS) [www.myopenedx.com] ece-openedx-01.eng.uwaterloo.ca Your website domain name for teachers (CMS) [studio.ece-openedx-01.eng.uwaterloo.ca] Your platform name/title [My Open edX] ECE Open edX dev1 Your public contact email address [contact@ece-openedx-03.eng.uwaterloo.ca] d24lau@uwaterloo.ca The default language code for the platform [en] Activate SSL/TLS certificates for HTTPS access? Important note: this will NOT work in a development environment. [y/N]
Test the OpenEdX LMS site.
Open a browser to the server address (e.g.,
http://ece-openedx-01.eng.uwaterloo.ca
).The OpenEdX welcome page should be displayed.
Test the OpenEdX CMS site.
Open a browser to the studio server address (e.g.,
http://studio.ece-openedx-01.eng.uwaterloo.ca
).The OpenEdX Studio welcome page should be displayed.
Admin user
In order to create an administrator account on the OpenEdX server:
tutor local do createuser --staff --superuser yourusername user@email.com
You will be asked to set the password interactively.
Creating first course
Go to the OpenEdX CMS site (e.g.
http://ece-openedx-01.eng.uwaterloo.ca
).Login with the administrator account previously created.