|
|
| (60 intermediate revisions by the same user not shown) |
| Line 1: |
Line 1: |
| == Introduction == | | == Introduction == |
|
| |
|
| According to the [], {{quotation|The Open edX platform is a free--and open source--course management system (CMS) that was originally developed by edX. The Open edX platform is used all over the world to host Massive Open Online Courses (MOOCs) as well as smaller classes and training modules.}}
| | In 2019, the [https://open.edx.org/ Open edX homepage] stated that {{quotation|edX is the online learning destination co-founded by Harvard and MIT. Open edX is the learner-centric, massively scalable learning platform behind it. Originally envisioned as a MOOC platform, Open edX has evolved into one of the leading learning platforms catering to Higher Ed, enterprise, and government organizations alike.}} |
|
| |
|
| == Installation ==
| | In 2017, [https://open.edx.org/ the same homepage] had a more focused vision, {{quotation|The Open edX platform is a free--and open source--course management system (CMS) that was originally developed by edX. The Open edX platform is used all over the world to host Massive Open Online Courses (MOOCs) as well as smaller classes and training modules.}} |
|
| |
|
| As of March 31 2017, the installation works.
| | See also: |
| | * [[Open edX installation and configuration]] |
|
| |
|
| See https://community.bitnami.com/t/studios-having-trouble-saving-your-work/48279/2 for a "Studio's having trouble saving your work" problem that was easy to fix with an Apache configuration detail. Also, see older versions of this wiki page.
| | == Administering Open EdX == |
|
| |
|
| === Installation of a test system under Ubuntu 16 ===
| | The administration interface is available only through the localhost (server machine) |
| | * http://localhost:81/admin |
|
| |
|
| There are [https://openedx.atlassian.net/wiki/display/OpenOPS/Open+edX+Installation+Options many different ways to install and run an edX server].
| | This means that you either have to create a tunnel to run a navigator or else launch a firefox on the server and use X windows to display, e.g. if you got your own Linux machine: |
| | ssh server.machine -XY |
| | firefox --new-instance |
|
| |
|
| ==== Overview ====
| | It can be configured to be available here (same port as edx-studio) |
| | * http://yoursite:18010/admin/ |
|
| |
|
| If you have free access to a server machine, the easiest method is probably installing the "bitnami" stack ([https://bitnami.com/stack/edx/README.txt README.txt] file. It will install a complete software pack in a separate directory including web servers, database servers, several programming languages, etc. The version we tried included:
| | Read more in: |
| - Open edX eucalyptus.3
| | * [[Open edX installation and configuration]] |
| - Apache 2.4.25
| |
| - Elasticsearch 0.90.11
| |
| - Erlang 17.4
| |
| - Java 1.8.0_121
| |
| - Memcached 1.4.35
| |
| - MongoDB 2.6.12
| |
| - Mysql 5.6.35
| |
| - Node.js 6.10.0
| |
| - Python 2.7.13
| |
| - RabbitMQ 3.6.8
| |
| - Rails 4.2.8
| |
| - Ruby 2.1.10
| |
| - RubyGems 1.8.12
| |
|
| |
|
| If your machine already runs web servers, data base servers, etc. it will use other ports. From the README file: {{quotation|The default listening port for Apache is 8080, for Elasticsearch 9300, for Memcached 11211, for MongoDB 27017, for MySQL is 3306, for RabbitMQ 5672, for Open edX XQueue 18040 and 18010 for Open edX CMS. If those ports are already in use by other applications, you will be prompted for alternate ports to use.}} This does of course require that you allow that...
| | == Creating a course == |
|
| |
|
| Summary of ports that must be openend or can remain local (user installation for a system with an existing LAMP/Java stack, changed apache default from 8080 to 8000)
| | By default, any registered user can create a course. We find that really strange given all these annoying security features that otherwise imposed. However, in a production system, the administrator may have disabled course creating for non staff members (see [[Open edX installation and configuration]] |
|
| |
|
| {| class="wikitable sortable"
| | For creating courses one is supposed to use studio, but someone will have to tell you where to find it. I will, but you also can read [http://docs.edx.org/ the official documentation] |
| |+PORTS used by edX standard and custom installations
| |
| |-
| |
| ! Service
| |
| !system default ports|| default user install
| |
| ports
| |
| || our user install || our root install
| |
| (machine already had a LAMP stack)
| |
| |requires open firewall
| |
| |-
| |
| |mysql_port
| |
| |3306|| 3307 || 3307 || 3307 ||
| |
| |-
| |
| |smtp_port
| |
| |587|| 587 || 587 || 587
| |
| |
| |
| |-
| |
| |apache_server_port
| |
| |80|| 8080 || 8000 || 81
| |
| |x
| |
| |-
| |
| |apache_server_ssl_port
| |
| |443|| 8443 || 8443 || 443
| |
| |x
| |
| |-
| |
| |mongodb_port
| |
| ||| 27017 || 27017 || 27017
| |
| |-
| |
| |elasticsearch_port
| |
| ||| 9200 || 9200 || 9200
| |
| |-
| |
| |elasticsearch_node_port
| |
| ||| 9300 || 9300 || 9300
| |
| |-
| |
| |rabbitmq_server_port
| |
| ||| 5672 || 5672 || 5672
| |
| |-
| |
| |rabbitmq_management_port
| |
| ||| 15672 || 15672 || 15672
| |
| |-
| |
| |Open edX XQueue
| |
| ||| 18040 || 18040 || 18040
| |
| |x
| |
| |-
| |
| |Open edX CMS
| |
| ||| 18010 || 18010 || 18010
| |
| |x
| |
| |}
| |
|
| |
|
| ==== Installation summary for a simple user ====
| | If you configured your firewall as suggested above, then it is here: |
| | * <code>http://yoursite:edx_port/edx-studio</code> (this will then redirect) |
|
| |
|
| [[file:bitnami-console.png|thumb|300px|right|Bitnami console (after a succesful install)]]
| | * http://yoursite:18010/ (the EdX-Studio website) |
| | | : Yes it runs by default on port 18010 ! |
| Firstly, have a look at [https://docs.bitnami.com/installer/apps/edx/ this bitnami doc] which is not really advertized.
| |
| | |
| Here are the steps:
| |
| * Get the <code>LOCAL INSTALL</code> OpenEx installer from https://bitnami.com/stack/edx
| |
| * Make the file executable:
| |
| chmod a+x bitnami-edx-eucalyptus.3-0-linux-x64-installer.run
| |
| * Create an empty directory somewhere
| |
| mkdir /path_yours/edx
| |
| * Run the installer (and wait for a very long time)
| |
| ./bitnami-edx-eucalyptus.3-0-linux-x64-installer.run
| |
| : In the beginning it will ask your for an admin login, mail and password. It also requires SMTP information (anonymous is not allowed, so need an account). Alternatively you can use a gmail address.
| |
| : '''Important'''. You won't have to wait for a few minutes, but for a very long time, e.g. about 30 minutes on an older but idle Ubuntu 16 box.
| |
| * Launch it once the installer is done. You will get a little console (see picture to the right). This console is fairly useless if you are connected through an terminal. Instead you could run the following:
| |
| cd your_installation_directory
| |
| ./ctlscript.sh status
| |
| : This will not mean that you actually can use the server, since you very likely may have a firewall that blocks outside access to your server.
| |
| : To test in the terminal if the server is actually working your could just type <code>wget localhost:8000</code> (adapt the port number).
| |
| * Adapt the firewall (of course you also can restrict to a local network)
| |
| # show open ports
| |
| sudo ufw status
| |
| <nowiki>#</nowiki> add port 8000 (adapt to yours)
| |
| sudo ufw allow 8000/tcp
| |
| <nowiki>#</nowiki> Open for the Studio (else you cannot create courses)
| |
| sudo ufw allow 18010/tcp
| |
| <nowiki>#</nowiki> add port 8000 to a restricted area
| |
| sudo ufw allow 8000/tcp from ip_number_here
| |
| <nowiki>#</nowiki> Reload the firewall
| |
| sudo ufw reload
| |
| | |
| Now if you plan to use this as a little production environment
| |
| * Open the firewall (see above)
| |
| * you should tell your system to launch this script at boot time. E.g. [http://askubuntu.com/questions/814/how-to-run-scripts-on-start-up read this]. | |
| | |
| '''Bugs''' (April 27 2017)
| |
| | |
| * The installation script will run and install under your login. It can not figure out your group name and some configuration files will be wrong. Fix group names in:
| |
| properties.ini
| |
| apps/edx/conf/httpd-cms.conf
| |
| apps/edx/conf/httpd-lms.conf
| |
| apps/xqueue/conf/httpd-xqueue.conf
| |
| | |
| * The start up page will display an empty URL (see above). Somehow, Apache will start despite wrong group names, but then something goes wrong. Fix the group name problem, shut down everything and restart.
| |
| | |
| * In Eucalyptos versions prior to March 21 2017, Studio will not allow saving an edited block '''Problem not solved so far'''. The problem is fixed. Else in an older install eidt /opt/bitnami/apps/edx/conf/httpd-vhosts.conf:
| |
| Replace
| |
| <source lang="XML">
| |
| <VirtualHost *:18010>
| |
| Include "/opt/bitnami/apps/edx/conf/httpd-cms.conf"
| |
| </VirtualHost>
| |
| by:
| |
| | |
| <VirtualHost *:18010>
| |
| AllowEncodedSlashes On
| |
| Include "/opt/bitnami/apps/edx/conf/httpd-cms.conf"
| |
| </VirtualHost>
| |
| </source>
| |
| | |
| === installation under root ===
| |
| | |
| Since saving a studio edit did not work, I tried reinstalling the whole thing under root. The problem was fixed in a new release, but I keep the root install anyhow. It does seem to be more reliable (processes will run under daemon by default).
| |
| | |
| sudo su
| |
| ufw allow 81/tcp
| |
| ufw allow 443/tcp
| |
| ufw reload
| |
| ./bitnami-edx-eucalyptus.3-0-linux-x64-installer.run
| |
| | |
| // kill temp file from user installation
| |
| rm -r /tmp/mako_lms
| |
|
| |
| Below is a slightly censored transcript of the installation dialog. I basically used default values.
| |
| | |
| <source lang="bash">
| |
| ./bitnami-edx-eucalyptus.3-0-linux-x64-installer.run
| |
| X11 connection rejected because of wrong authentication.
| |
| ----------------------------------------------------------------------------
| |
| Welcome to the Open edX powered by Bitnami Setup Wizard.
| |
| ----------------------------------------------------------------------------
| |
| Select the components you want to install; clear the components you do not want
| |
| to install. Click Next when you are ready to continue.
| |
| | |
| Open edX : Y (Cannot be edited)
| |
| Demo course for Open edX [Y/n] :Y
| |
| Is the selection above correct? [Y/n]: y
| |
| ----------------------------------------------------------------------------
| |
| Installation folder
| |
| Please, choose a folder to install Open edX powered by Bitnami
| |
| Select a folder [/opt/edx-eucalyptus.3-0]:
| |
| ----------------------------------------------------------------------------
| |
| Create Admin account
| |
| Open edX powered by Bitnami admin user creation
| |
| Your real name [User Name]: Daniel K. Schneider
| |
| Email Address [user@example.com]:
| |
| Login [user]: admin
| |
| Password :
| |
| Please confirm your password :
| |
| ----------------------------------------------------------------------------
| |
| Web Server Port
| |
| Choose a port that is not currently in use, such as port 81.
| |
| Apache Web Server Port [81]:
| |
| ----------------------------------------------------------------------------
| |
| MySQL Information
| |
| Please enter your MySQL database information:
| |
| Choose a port that is not currently in use, such as port 3307.
| |
| MySQL Server port [3307]:
| |
| ----------------------------------------------------------------------------
| |
| The hostname that will be used to create internal URLs. If this value is
| |
| incorrect, you may be unable to access your Open edX installation from other
| |
| computers.
| |
| Hostname [127.0.1.1]: XXXX.unige.ch
| |
| Do you want to configure mail support? [y/N]: y
| |
| ----------------------------------------------------------------------------
| |
| Configure SMTP Settings
| |
| This is required so your application can send notifications via email.
| |
| Default email provider:
| |
| [1] GMail
| |
| [2] Custom
| |
| Please choose an option [1] : 2
| |
| ----------------------------------------------------------------------------
| |
| Configure SMTP Settings
| |
| | |
| This data is stored in the application configuration files and may be visible to
| |
| others. For this reason, it is recommended that you do not use your personal
| |
| account credentials.
| |
| Username []: XXXX-tecfa
| |
| Password :
| |
| Re-enter :
| |
| SMTP Host []: XXXX.unige.ch
| |
| SMTP Port [587]:
| |
| Secure connection
| |
| [1] None
| |
| [2] SSL
| |
| [3] TLS
| |
| Please choose an option [3] : 1
| |
| ----------------------------------------------------------------------------
| |
| Setup is now ready to begin installing Open edX powered by Bitnami on your
| |
| computer.
| |
| Do you want to continue? [Y/n]: y
| |
| ----------------------------------------------------------------------------
| |
| Please wait while Setup installs Open edX powered by Bitnami on your computer.
| |
| Installing
| |
| 0% ______________ 50% ______________ 100%
| |
| ########################################
| |
| </source>
| |
| | |
| ==== To start/stop the server ====
| |
| | |
| You can use the included ctlscript.sh utility:
| |
| ctlscript.sh start|stop|restart
| |
| | |
| EdX will be available on the selected port, e.g.
| |
| http://yourserver_ip_or_name:8080
| |
| | |
| Again, if this does not work from your client machine, adapt the firewall settings (see above)
| |
| | |
| [[file:edx-admin-panel.png|200px|right|thumb|edX administration panel]]
| |
| ==== Configuration ====
| |
|
| |
|
| By default, anyone now can require an account and will get it. This may attract spammers.
| | Creating a course is very simple: |
| | * Hit the big green button and fill in the form |
| | * Add instructors as needed (you need to know their email address and they must have signed up with edX with that email). |
|
| |
|
| After login into the system you cannot do anything, except signing up for the demo class and configuring the admin profile. You can configure edX through the http://youredx:port/admin URL. However I didn't see anything obvious to do yet.
| | [[File:Edx-studio-1.png|600px|thumb|none|edX studio - Creating a course]] |
|
| |
|
| Log into the admin console:
| | == Authoring a course == |
| http://yoursite/admin
| |
| : It only will be available on the localhost, which is really bad news if you cannot run an Xserver on your client machine. If you do happen to have a client linux machine (I do) then you can run firefox on the server machine. Connect to the server with the <code>-XY</code> option !!
| |
| ssh your_server -XY
| |
| sudo apt-get install firefox
| |
|
| |
|
| Now your freaky Ubuntu will not run the firefox you just installed, but a copy of the one you already may have running on your local machine. Type:
| | [[File:Edx-studio-3.png|600px|thumb|none|edX studio - Organizing the course]] |
| firefox --new-instance
| |
| Open http://localhost:8000/admin and enjoy the difficult editing over a remote X connection.
| |
|
| |
|
| * Read [http://edx.readthedocs.io/projects/edx-installing-configuring-and-running/en/latest/configuration/ 4. Configuring the Open edX Platform] & enjoy for now.
| | [[File:Edx-studio-2.png|600px|thumb|none|edX studio - Adding content to a unit]] |
|
| |
|
| Instead of running a web browser over an X connection, you also can use a terminal browser, E.g.
| | == Links == |
| sudo apt-get install lynx
| |
| lynx http://localhost:81/admin
| |
|
| |
|
| You will see many configuration items grouped into categories. Each item can be edited in three ways:
| | === Official documentation === |
| * Clicking on the item
| |
| * Add
| |
| * Change (same as clicking on item)
| |
|
| |
|
| ==== Alternatives ====
| | The documentation is spread over several places. |
|
| |
|
| The same company also provides solutions for Virtual Machines compatible with Oracle VirtualBox and VMware vSphere, Workstation, and Fusion
| | * http://docs.edx.org/ |
|
| |
|
| === Security ===
| | * [https://open.edx.org/getting-help Getting help]. Provides a list of online resources. |
|
| |
|
| Read [https://docs.bitnami.com/installer/apps/edx/#how-to-install-codejail How to install CodeJail Sandbox?]
| | * [http://edx.readthedocs.io/projects/edx-installing-configuring-and-running/en/latest/index.html Installing, Configuring, and Running the Open edX Platform]. As we described in [[Open edX installation and configuration]], for testing purposes, it is much easier to start with the Bitnami stack. However, this document still includes important documentation on configuration that one should read. |
|
| |
|
| * Add SSL certificates | | * [http://docs.edx.org/ Documentation for edx.org and the Open edX Community] |
| * Harden the system according to instructions | | ** [http://edx.readthedocs.io/projects/edx-partner-course-staff/en/latest/ Building and Running an edX Course Instructions for course teams that are creating courses to run on the edx.org website.] |
| | ** [http://edx.readthedocs.io/projects/edx-guide-for-students/en/latest/ EdX Learner's Guide Help for learners taking a course on edx.org.] |
|
| |
|
| === Creating a course ===
| | * [https://openedx.atlassian.net/wiki/display/OpenOPS/Managing+OpenEdX+Tips+and+Tricks Managing OpenEdX Tips and Tricks] |
|
| |
|
| For creating courses one is supposed to use studio. Of course, none of the obvious documentation will tell where to find it. I will. If you configured your firewall as suggested above, then it is here:
| | * [https://openedx.slackarchive.io/general/ Slack archive] (even if you do not believe that knowledge should be conversational ...) |
|
| |
|
| * http://yoursite:18010/
| |
| : Yes it runs by default on port 18010 !
| |
| * <code>http://yoursite:edx_port/edx-studio</code> also works and will redirect to the above.
| |
|
| |
|
| Read http://docs.edx.org/
| | [[category: open education]] |
