Installation and Configuration Quick-Start
As a general rule, catsoop is only ever really "officially" tested using Debian GNU/Linux, but others have tested these instructions on Mac OSX and on Windows (both WSL and Cygwin).
Table of Contents
- 1) Install Necessary Software
- 2) Download CAT-SOOP
- 3) Configure CAT-SOOP
- 4) Add Courses
- 5) Start CAT-SOOP
- 6) Additional Configuration for Public-Facing Servers
1) Install Necessary Software
CAT-SOOP depends on Python (version 3.7+, with pip).
You will need Python version 3.7+ on your system to run CAT-SOOP. Many distributions have Python 3.7+ in their package managers, though it may be necessary to download the source from the official Python site.
On Debian Bullseye, you will need the
python3-pip packages (or
a version of Python 3.7+ installed in some other way).
2) Download CAT-SOOP
There are several ways you can install CAT-SOOP.
2.1) Installation via pip
The easiest is pip, with a command like the following (for the most recent version):
$ pip3 install catsoop
or the following (for the LTS ("long-term stable") release):
$ pip3 install catsoop ~=2021.9
We recommend installing catsoop in a virtual environment. If you want
to install it to your system Python instead, you may need to run the above
commands as root or use
2.2) Manual Installation
Alternatively, you can clone the Git repository:
$ git clone git://catsoop.org/catsoop.git
After you have a local copy, you can then run:
$ sudo make install
from the source directory. You can also run the unit tests by running:
$ make test
3) Configure CAT-SOOP
To configure CAT-SOOP, run the following command:
and answer the questions it poses.
If you are running a public-facing CAT-SOOP instance, you are strongly
encouraged to enable encryption if the directory in which you are storing
the logs is not already encrypted in some way (e.g., via
4) Add Courses
The default location for CAT-SOOP courses is in
~/.local/share/catsoop/courses/. You should move (or symlink) your courses
to that location.
If you're not sure what to put there, a decent place to start is with the "sample course", which you can put in the appropriate place with a command like the following:
$ git clone git://catsoop.mit.edu/sample_course.git ~/.local/share/catsoop/courses/sample_course
5) Start CAT-SOOP
To start the server, you should run:
$ catsoop start
This will start the server listening on port 7667. You should then be able to
directy your browser to
http://localhost:7667 to see the CAT-SOOP instance.
6) Additional Configuration for Public-Facing Servers
If you are setting up a public-facing CAT-SOOP instance, see this page about additional server configuration as well.