Date: Thu, 28 Mar 2024 14:01:26 +0000 (UTC) Message-ID: <324124915.15.1711634486182@59fb111062a3> Subject: Exported From Confluence MIME-Version: 1.0 Content-Type: multipart/related; boundary="----=_Part_14_2046757846.1711634486182" ------=_Part_14_2046757846.1711634486182 Content-Type: text/html; charset=UTF-8 Content-Transfer-Encoding: quoted-printable Content-Location: file:///C:/exported.html
This page describes how to install Open edX software on a single Ubuntu = 16.04 64-bit server from scratch. This is for releases Ficus through Junipe= r.
Warning
Installing and running an Open edX instance is not simple. We
Only proceed with these installation steps if you are comfortable with i= nstalling and diagnosing complex Linux systems.
The following server requirements will be fine for supporting hundreds o= f registered students on a single server.
Note: This will run MySQL, Memcache, Mongo, nginx, and all of the Op= en edX services (LMS, Studio, Forums, ORA, etc) on a single server. In prod= uction configurations we recommend that these services run on different ser= vers and that a load balancer be used for redundancy. Setting up production= configurations is beyond the scope of this wiki page.
For hosting in Amazon we recommend an t2.large with at least a 50Gb EBS = volume, see https://aws.amazon.com/ec2/pricing. Commu= nity Ubuntu AMIs have 8GB on the root directory, make sure to expand it bef= ore installing.
WARNING:
These instructions will potentially destroy the server they are run on, you should only do them on a freshly installed v= irtual machine. But if you still want to have a try to re-install the Open = edX stack on the same server, please see this article for some issues you may fa= ce and how to fix them.
By default ssh will only allow key based authentication= . Please setup key based SSH logins or modify the configuration repo to all= ow for password based SSH logins before running Ansible.
NOTES:
Launch your Ubuntu 16.04 64-bit server and log in to it as a user that h= as full sudo privileges.
Update your Ubuntu package sources:
sudo = apt-get update -y sudo apt-get upgrade -y sudo reboot
You will run a few scripts to accomplish the installation. Please read t= he contents of the scripts before running this to ensure you are aware of e= verything they will do: they are quite extensive. The scripts require that = the running user can run commands as root via sudo.
Set the OPENEDX_RELEASE variabl= e. You choose the version of software by setting the OPEN= EDX_RELEASE variable before running the commands. See Open edX Named Releases = for the tags you can use.
expor= t OPENEDX_RELEASE=3Dthe-tag/you-want-to-install
Create a config.yml f=
ile. This file specifies the hostname (and port, if needed) of the LM=
S and Studio. Create a file in the current directory named config.yml
, like this:
# The= host names of LMS and Studio. Don't include the "https://" part: EDXAPP_LMS_BASE: "online.myeducation.org" EDXAPP_CMS_BASE: "studio.online.myeducation.org"
Your LMS host and Studio host must either b=
e the same hostname (on different ports), or Studio must be a subdomain of =
the LMS. If you need a different configuration, you may need to also =
set EDXAPP_SESSION_COOKIE_DOMAIN.
NOTE: Open edX and edX are registered trademarks=
. You may not use "openedx." or "edx." as subdomains=
when naming your site. For more details, see the edX Trademark Po=
licy. Here are some examples of unacceptable domain =
names:
Bootstrap the Ansible inst= allation:
wget = https://raw.githubusercontent.com/edx/configuration/$OPENEDX_RELEASE/util/i= nstall/ansible-bootstrap.sh -O - | sudo -E bash
Randomize passwords. = This step used to be optional, but as of Ironwood, it is required. I= f this is to replace an older installation, copy your my-passwords.yml file= from that installation. If this is a new installation:
wget = https://raw.githubusercontent.com/edx/configuration/$OPENEDX_RELEASE/util/i= nstall/generate-passwords.sh -O - | bash
IMPORTANT: Be sure to save the generated =
my-passwords.yml in a safe place. If you ever need to access your services =
directly, you'll need these credentials. More details of password generatio=
n and other security measures are here: How to Override Default Configuration Passwords and Verify Expos=
ed Services.
Install the Open edX = software. This can take some time, perhaps an hour. (Note: for Ginkgo= and earlier, this file was called sandbox.sh):
wget = https://raw.githubusercontent.com/edx/configuration/$OPENEDX_RELEASE/util/i= nstall/native.sh -O - | bash
Some Open edX components are outdated. If you see a message suggesting t= hat you update something manually, don't do it -= - something is probably relying on the outdated software remaining at that = older version. Specifically:
do-release-u=
pgrade
to upgrade to that newer version. Don't do =
it.pip install --upgrade pip
to=
install it. Don't do it.If you arbitrarily upgrade parts of Open edX software, things w= ill break. Instead, you should submit a pull request to change the lin= e in the Open edX project where that specific version of the software is de= fined. All pull requests need to be reviewed before they can be merged, and= part of the review process will consist of testing the full platform with = the updated software, identifying any breakages, and fixing them as part of= the pull request.