Karma

Karma is a simple time tracking system.

Features

• projects
• categories
• project highscores
• command line interface

Installation

To install the python dependencies, install pipenv which is used for the dependency management in a virtual environment. Install the dependencies with

pipenv sync

Copy settings.py.example to settings.py in the karma folder:

cp karma/settings.py.example karma/settings.py

and customize the settings.py.

The following settings should probably be changed:

• The secret key
• The DEBUG setting
• The ALLOWED_HOSTS
• The database settings

For instructions on how to use other databases than sqlite, have a look at the Django Documentation.

To initialize the database, run pipenv run ./manage.py migrate

To create an administrator user, run pipenv run ./manage.py createsuperuser.

pipenv run ./manage.py runserver starts the server with the configuration given in the settings.py file.

On the website, you can use the Add Project or Add Category buttons to add projects and categories.

Since we use the karma system with LDAP, there is currently no registration interface. You can instead create users using pipenv run ./manage.py createsuperuser or in the django admin interface which is located at /admin. Navigate to Users -> Add user and insert the user data. If you also want to use LDAP for authentication, use django-auth-ldap. For configuration, have a look at their GitHub page or their documentation.

For production systems it is necessary to additionally run the command pipenv run ./manage.py collectstatic. For production, we recommend to use uwsgi.

Our uwsgi configuration and a Dockerfile can be found at https://github.com/fsinfuhh/dockerfiles/tree/master/karma.