These instructions will help guide you to installing Submitty onto a server (whether on a dedicated machine or a VM).
Note: We assume that you’re installing Submitty on a dedicated machine. If this machine is used for other things, you may need to adapt the instructions below and install_system.sh for your needs (as the script installs all of the dependencies that Submitty depends on).
Note: These instructions should be run under root/sudo.
Install Ubuntu 16.04 server edition
After installing the operating system, clone the git repository:
mkdir -p /usr/local/submitty/GIT_CHECKOUT git clone https://github.com/Submitty/Submitty.git /usr/local/submitty/GIT_CHECKOUT/Submitty
Run the automated portion of the install.
cd /usr/local/submitty/GIT_CHECKOUT/Submitty bash ./.setup/install_system.sh
You will be asked several questions by the CONFIGURE_SUBMITTY.sh script. These questions are:
- Database Host
- Database User
- Database Password
- Main Site URL
- Version Control System (VCS) URL
- Institution Name
- Authentication Method (PAM or Database)
Unless you have a database server already set up, you will most likely just specify
localhostfor the Database Host. You will need to create a DB user to use for the system as well. A basic way to do this would be (Note: change the password for the user):
su postgres -c "psql -c \"CREATE ROLE submitty_dbuser WITH SUPERUSER CREATEDB CREATEROLE LOGIN PASSWORD 'PASSWORD'\""
and then the DB User would be
submitty_dbuserand the DB Password would be whatever you set.
Do not enable debugging unless you are developing code on a non-production machine.
Edit PHP Settings
We recommend for security that you modify your PHP installation and disable certain PHP functions. To do this, edit
/etc/php/7.0/fpm/php.iniand find the entry for
disable_functionsand prepend the list of disabled functions with:
Note: If you don’t have a SSL certificate for your server, we recommend using Let’s Encrypt to get one. It’s recommended that you use certbot to do this (and to have an HTTP configuration up).
We provide a default apache configuration at .setup/apache/submitty.conf which you can just copy to
/etc/apache2/sites-available. You will need to replace all instances of
__your_domain__with your actual domain (don’t include the
https://part of it) and
/path/to/ssl/certificate/to the actual path for your SSL certificate.
Note: If you used Let’s Encrypt, your certificates will be at
/etc/letsencrypt/live/__your_domain__, otherwise the common place to look would be
The basic commands to do this are:
cp /usr/local/submitty/GIT_CHECKOUT/Submitty/.setup/apache/submitty.conf /etc/apache2/sites-available/submitty.conf a2ensite submitty
We also recommend that you Edit
/etc/apache2/conf-enabled/security.confto ensure these options below are set to limit the information the server gives to potential hackers:
ServerTokens Prod ServerSignature Off
You probably want to first disable or remove the default configurations to prevent unintended access to the web server (but don’t do this if the default site is already in use).
You may also want to comment out the directory specific portions of
/etc/apache2/apache2.confso that you do not risk configuration conflicts with your other configurations. (Things that begin with Directory and end with /Directory).
Alternately, we provide submitty_http.conf to run Submitty on just HTTP. We recommend only using this if you are planning on developing for Submitty. For production, we strongly recommend that you get a certificate and use HTTPS/SSL.
We recommend that you should leave the PostgreSQL setup unless you know what you’re doing. However, for the version of PostgreSQL that comes with Ubuntu (16.04), you can use UNIX sockets and disable the ability to connect to the DB via TCP. The socket improves query responses minorly while disabling TCP can better secure your DB if you don’t plan to connect to it via localhost, IP, etc. The socket by default is run at
/var/run/postgresql. To disable TCP, you will need to edit
/etc/postgresql/9.5/main/pg_hba.confand disable all the lines that start with
hostssl. You will also have to modify
DATABASE_HOSTto point to the socket, and then re-run the script.
Test apache config with:
If everything looks ok, restart apache with: `service apache2 restart’
- I cannot connect to PAM!
Submitty authenticates PAM through the python module
python-pam using the
submitty_cgi user. By default, we
assume you’re going to use local accounts for authentication and as such
submitty_cgi has been
added to the
shadow group so that it can read /etc/password which is necessary for PAM to work.
To test PAM, you can do:
$ sudo su submitty_cgi -c python3 Python 3.5.1 (default, Jun 29 2016, 13:08:31) [GCC 4.9.2] on linux2 Type "help", "copyright", "credits" or "license" for more information. >>> import pam >>> p = pam.pam() >>> p.authenticate('username', 'password') True
password match some account on the machine).
If you get an error about module pam not being found, that means that
submitty_cgi does not have the proper permissions to
the module and if you get False on authentication, then
submitty_cgi does not have the proper permissions to check the
right files via PAM.