update installation instructions

I've tested these instructions with a fresh Ubuntu 24.04 machine.

Author: christianp

docs/server-installation/ubuntu-web.rst

@@ -11,23 +11,16 @@ For more information, consult `the Django documentation <https://docs.djangoproj
 
 .. note::
 
-    The following instructions are for a server running Ubuntu Xenial (16.04) or newer.
+    The following instructions are for a server running Ubuntu 24.04 or newer.
 
 Essential package installation
 ------------------------------
 
-Packages that would be installed as part of a standard Ubuntu install
-are not listed.
+#.  Install required packages using the ``apt`` packaging system::
 
-#.  Install Apache, Git, Apache WSGI module, MySQL and Python 3 using the ``apt`` packaging system::
-
-        apt-get install apache2 apache2-dev git-core mysql-server \
-        mysql-common python3 acl libmysqlclient-dev python-dev \
-        libapache2-mod-wsgi-py3 python-tk tcl-dev tk-dev
-
-#.  Enable ``mod_wsgi``, if it's not already:: 
-    
-        a2enmod wsgi
+    apt install nginx git-core mysql-server \
+    mysql-common python3 acl libmysqlclient-dev python3-dev \
+    supervisor python3-pip python3-virtualenv pkg-config
 
 Virtualenv
 ----------
@@ -43,23 +36,15 @@ approach is to use `virtualenv <https://virtualenv.pypa.io>`_, which is a tool t
         
     You might need to start a new terminal, or log out and back in, for the group change to take effect.
 
-#.  Install Pip:: 
-    
-        apt-get install python3-pip
-
-#.  Install virtualenv:: 
-    
-        pip3 install virtualenv
-
 #.  Create the virtualenv in a suitable location::
   
-        mkdir /opt/python
-        setfacl -dR -m g:numbas:rwx /opt/python
-        virtualenv /opt/python/numbas-editor
+        mkdir /opt/numbas_python
+        setfacl -dR -m g:numbas:rwx /opt/numbas_python
+        virtualenv -p python3 /opt/numbas_python
 
 #.  Activate the virtualenv::
 
-        source /opt/python/numbas-editor/bin/activate
+        source /opt/numbas_python/bin/activate
         
     (This ensures that subsequent python packages are installed in this isolated environment, and not in the system environment.)
 
@@ -77,7 +62,8 @@ Database
 #.  Create a database user and grant privileges on ``numbas_editor``
     database, with a password of your choice::
 
-        grant all privileges on numbas_editor.* to 'numbas_editor'@'localhost' identified by 'password';
+        create user 'numbas_editor'@'localhost' identified by 'password';
+        grant all privileges on numbas_editor.* to 'numbas_editor'@'localhost';
 
 Create directories and set permissions
 --------------------------------------
@@ -87,6 +73,7 @@ Create directories and set permissions
   
         mkdir /srv/numbas
         mkdir /srv/numbas/compiler
+        mkdir /srv/numbas/editor
         mkdir /srv/numbas/media
         mkdir /srv/numbas/previews
         mkdir /srv/numbas/static
@@ -105,17 +92,17 @@ Clone the editor and compiler repositories
 
 #.  Clone the Numbas repository::
 
-        git clone git://github.com/numbas/Numbas /srv/numbas/compiler
+        git clone https://github.com/numbas/Numbas /srv/numbas/compiler
 
 #.  Clone the editor under the webroot directory::
 
-        git clone git://github.com/numbas/editor /srv/www/numbas_editor
+        git clone https://github.com/numbas/editor /srv/numbas/editor
 
 #.  Install the Python module dependencies of the editor (in the virtualenv)::
 
-        pip install -r /srv/www/numbas_editor/requirements.txt
+        pip install -r /srv/numbas/editor/requirements.txt
         pip install -r /srv/numbas/compiler/requirements.txt
-        pip install mysqlclient mod_wsgi
+        pip install mysqlclient gunicorn
 
 Configuration
 -------------
@@ -133,16 +120,71 @@ Configuration
     If you make any mistakes, you can run the script again, or edit
     ``numbas/settings.py`` directly.
 
-#.  Create the apache config file and enable the site.
+#.  Create the supervisor, gunicorn and nginx config files and enable the site.
+
+    -  Copy the WSGI file::
+
+        mkdir /var/log/gunicorn
+        chown www-data:www-data /var/log/gunicorn
+        cd /srv/numbas/editor
+
+    -  Edit ``/srv/numbas/editor/web/gunicorn.conf.py`` with these contents::
+
+        # Serve on port 8001
+        bind = "0.0.0.0:8001"
+        # Number of worker processes to run. Increase when there is more traffic.
+        workers = 1
+        # Access log - records incoming HTTP requests
+        accesslog = "/var/log/gunicorn/numbas_editor_access.log"
+        # Error log - records Gunicorn server goings-on
+        errorlog = "/var/log/gunicorn/numbas_editor_error.log"
+        # Whether to send Django output to the error log 
+        capture_output = True
+        # How verbose the Gunicorn error logs should be 
+        loglevel = "info"
+
+    -  Edit ``/etc/supervisor/conf.d/numbas_editor.conf`` with these contents::
+
+        [program:numbas_editor]
+        command=/opt/numbas_python/bin/gunicorn -c /srv/numbas/editor/web/gunicorn.conf.py web.wsgi:application
+        directory=/srv/numbas/editor/
+        user=www-data
+        autostart=true
+        autorestart=true
+        stopasgroup=true
+        environment=DJANGO_SETTINGS_MODULE=numbas.settings
+        numprocs=1
+
+    -  Overwrite ``/etc/nginx/sites-enabled/default`` with these contents::
+
+        server {
+            listen 80; 
+
+            client_max_body_size 100M;
+
+            location = /favicon.ico { access_log off; log_not_found off; }
+            location /static/ {
+                alias /srv/numbas/static/;
+            }
+            location /media/ {
+                alias /srv/numbas/media/;
+            }
+            location /numbas-previews {
+                alias /srv/numbas/previews/;
+                add_header 'Access-Control-Allow-Origin' '*';
+            }
+
+            location / {
+                include proxy_params;
+                proxy_pass http://localhost:8001;
+                proxy_read_timeout 120s;
+            }
+        }
+
 
-    -  Edit ``/etc/apache2/sites-available/numbas_editor.conf`` with
-       contents similar to that in :download:`this prepared config file <apache2_ubuntu.conf>`.
-       If following these instructions exactly, then you only need to change the lines containing ``ServerName`` and ``ServerAdmin``.
+    -  Restart supervisor and nginx::
 
-    -  Enable the configuration::
-      
-            a2ensite numbas_editor.conf
-            service apache2 reload
+        systemctl restart nginx supervisor
 
 #.  Point a web browser at the server hosting the editor.
 
@@ -151,16 +193,16 @@ Ongoing maintenance
 
 To keep the editor up to date, run the following script::
 
-    source /opt/python/numbas-editor/bin/activate
+    source /opt/numbas_python/bin/activate
     cd /srv/numbas/compiler
     git pull origin master
     pip install -r requirements.txt
-    cd /srv/www/numbas_editor
+    cd /srv/numbas/editor
     git pull origin master
     python manage.py migrate
     python manage.py collectstatic --noinput
     pip install -r requirements.txt
-    touch web/django.wsgi
+    supervisorctl restart numbas_editor
 
 Note that if any changes are made to the editor code, including
 editing the settings files, then for the web server to recognise

first_setup.py

@@ -357,7 +357,7 @@ def write_files(self):
         self.sub_settings()
 
         if not self.values['DEBUG']:
-            self.sub_file(Path('web', 'django.wsgi'), [ (r"sys.path.append\('(.*?)'\)", 'PWD') ])
+            self.sub_file(Path('web', 'wsgi.py'), [ (r"sys.path.append\('(.*?)'\)", 'PWD') ])
 
         index_subs = [
             (r"Welcome to (the Numbas editor)", 'SITE_TITLE'),

requirements.txt

@@ -18,3 +18,4 @@ six==1.16.0
 mistune==2.0.3
 emoji==0.6.0
 pycryptodome==3.14.1
+setuptools==70.0.0

web/django.wsgi.dist web/wsgi.pyweb/django.wsgi.dist renamed to web/wsgi.py

@@ -1,5 +1,5 @@
 import os, sys
-sys.path.append('/srv/www/numbas_editor')
+sys.path.append('/srv/numbas/editor')
 os.environ['DJANGO_SETTINGS_MODULE'] = 'numbas.settings'
 
 from django.core.wsgi import get_wsgi_application