octoleo/open-edx-setup
5
1
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Rewrite README file with updated information and usage instructions

Browse Source 
This change updates the README file to provide a clear and concise overview of the scripts and resources in the repository. The file includes information on the contents of the repository, usage instructions, and information on contributing to the repository. Additionally, a note has been added to emphasize the recommended use of the script on Ubuntu 22.04.
This commit is contained in:
Llewellyn van der Merwe 2023-02-13 13:27:13 +02:00
parent ec9f403479
commit 274f85947c
Signed by: Llewellyn
GPG Key ID: A9201372263741E7
1 changed files with 37 additions and 78 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

115
README.md
View File

@ -1,85 +1,44 @@
# how to setup a new server for our internal use
# OpenEdx Setup
This repository contains scripts and resources for setting up and deploying the OpenEdx platform. The scripts automate the process of installing and configuring OpenEdx, making it easier and faster to get up and running with the platform.
**Note:** This script has been tested and is designed to be used on Ubuntu 22.04. While it may work on other versions of Ubuntu or other Linux distributions, it is recommended to use the script on Ubuntu 22.04 for best results. If you plan to use the script on a different operating system, please ensure that you have the necessary dependencies and resources installed and configured before running the script.
## Contents
The repository contains the following scripts and resources:
1. Install script - A bash script (`install.sh`) that automates the process of installing and configuring OpenEdx.
2. Configuration files - A set of configuration files that are used by the install script to configure the OpenEdx platform.
## Usage
To use the scripts and resources in this repository, simply follow these steps:
1. Clone the repository to your local machine using the following command:
```
hostnamectl set-hostname pizza.method
git clone https://git.vdm.dev/octoleo/open-edx-setup.git
```
# Install dependancies for docker
2. Navigate to the directory containing the install script using the following command:
```
sudo apt-get install apt-transport-https ca-certificates curl gnupg lsb-release
cd open-edx-setup
```
# seth docker key
3. Run the install script using the following command:
```
curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /usr/share/keyrings/docker-archive-keyring.gpg
echo "deb [arch=amd64 signed-by=/usr/share/keyrings/docker-archive-keyring.gpg] https://download.docker.com/linux/ubuntu \
$(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
```
# update the repository listings
```
sudo apt-get update
```
# install docker
```
sudo apt-get install docker-ce docker-ce-cli containerd.io
```
# add the docker group
```
sudo groupadd docker
```
# add the current user to the docker group
```
sudo usermod -aG docker $USER
```
# enable the docker service
```
sudo systemctl enable docker.service
sudo systemctl enable containerd.service
```
# setup portrainer.... (we should use a docker-compose instead)
```
docker run -d -p 8000:8000 -p 9000:9000 --name=portainer --restart=always -v /var/run/docker.sock:/var/run/docker.sock -v portainer_data:/data portainer/portainer-ce
```
# setup tutor to install OPEN.EDX
```
sudo curl -L "https://github.com/overhangio/tutor/releases/download/v15.1.0/tutor-$(uname -s)_$(uname -m)" -o /usr/local/bin/tutor
```
# make tutor executable
```
sudo chmod 0755 /usr/local/bin/tutor
```
# install docker compose
```
sudo curl -L "https://github.com/docker/compose/releases/download/v2.14.2/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
```
# make docker compose executable
```
sudo chmod +x /usr/local/bin/docker-compose
```
# add it to my path
```
sudo ln -s /usr/local/bin/docker-compose /usr/bin/docker-compose
```
# lets start the install
```
tutor local quickstart
```
#
```
echo "git+https://github.com/open-craft/xblock-poll.git" >> "$(tutor config printroot)/env/build/openedx/requirements/private.txt"
```
#
```
tutor images build openedx
```
# create the superusers
```
tutor local createuser --staff --superuser Llewellyn demo@email.com
tutor local createuser --staff --superuser Roline demo2@email.com
```
# load the demo cource
```
tutor local importdemocourse
sudo chmod +x install.sh
./install.sh
```
# create staff
```
tutor local createuser --staff Sanri demo3@email.com
```
The script will then guide you through the process of installing and configuring OpenEdx.
## Contributing
If you have suggestions for improving the scripts or resources in this repository, feel free to contribute by creating a pull request or opening an issue. Your contributions are greatly appreciated and will help make this repository a valuable resource for other OpenEdx users.
## License
The scripts and resources in this repository are released under the [MIT License](LICENSE). You are free to use and modify the scripts and resources as needed, subject to the terms of the license.
## Contact
If you have any questions or comments about the scripts and resources in this repository, please feel free to reach out. You can contact me through the repository's issue tracker or by email.