Translate Toolkit
User and administrator documentation for AlekSIS, the Free School Information System
User and administrator documentation for AlekSIS, the Free School Information System
type: Hash Value - Key: subtitle
AlekSIS Handbook
AlekSIS Handbook
type: Hash Value - Key: title
# Introduction to AlekSIS
# Introduction to AlekSIS
type: Plain text
## Welcome
## Welcome
type: Plain text
Welcome to AlekSIS, the Free School Information System! This handbook is a comprehensive guide on how to install, administer, and use AlekSIS and all included official apps. Its target audience are system administrators seeking to install and maintain an AlekSIS installation, people supporting the use of AlekSIS in daily processes in educational organisations, and end users who work with the software on a daily basis.
Welcome to AlekSIS, the Free School Information System! This handbook is a comprehensive guide on how to install, administer, and use AlekSIS and all included official apps. Its target audience are system administrators seeking to install and maintain an AlekSIS installation, people supporting the use of AlekSIS in daily processes in educational organisations, and end users who work with the software on a daily basis.
type: Plain text
## On School Information Systems
## On School Information Systems
type: Plain text
School Information System, or for short, SIS, are software suites that help educational organisations with managing personal information about all members (e.g. students, teachers, parents and guardians) as well as organisational data like plans, pedagogic track records, and much more.
School Information System, or for short, SIS, are software suites that help educational organisations with managing personal information about all members (e.g. students, teachers, parents and guardians) as well as organisational data like plans, pedagogic track records, and much more.
type: Plain text
Generally, the goal of using School Information Systems is to help members of the school or other educational organisation to organise their work in learning and teaching, and to simplify digital processes, especially those that involve analytical evaluation, statistics, or information that is updated very frequently and should be made available to its recipients in a timely manner.
Generally, the goal of using School Information Systems is to help members of the school or other educational organisation to organise their work in learning and teaching, and to simplify digital processes, especially those that involve analytical evaluation, statistics, or information that is updated very frequently and should be made available to its recipients in a timely manner.
type: Plain text
Ideally, School Information Systems also promote transparency between teachers and students and improve sustainability by minimising the need for paperwork.
Ideally, School Information Systems also promote transparency between teachers and students and improve sustainability by minimising the need for paperwork.
type: Plain text
## AlekSIS, the Free School Information System
## AlekSIS, the Free School Information System
type: Plain text
School Information Systems have been on the rise ever since schools began digitising their management processes. Traditionally, the vendors of school management tools (like for timetabling, personal data management of teachers and students, etc.) also deliver wen applications that are tailored towards making the respective data available to those who need it.
School Information Systems have been on the rise ever since schools began digitising their management processes. Traditionally, the vendors of school management tools (like for timetabling, personal data management of teachers and students, etc.) also deliver wen applications that are tailored towards making the respective data available to those who need it.
type: Plain text
As most of these solutions are proprietary products, they tend to be limited to be used together with other software of their vendors, and do not integrate nicely with other software and with processes and data sets not in the focus of the developers.
As most of these solutions are proprietary products, they tend to be limited to be used together with other software of their vendors, and do not integrate nicely with other software and with processes and data sets not in the focus of the developers.
type: Plain text
AlekSIS, in contrast, is a generic School Information System that aims at being universally usable for all processes and data sets in any educational organisation, and at interacting closely with other software components employed in management and lessons. You can find information on the possibilities for interacting with other software in the chapter [@sec:Integrations].
AlekSIS, in contrast, is a generic School Information System that aims at being universally usable for all processes and data sets in any educational organisation, and at interacting closely with other software components employed in management and lessons. You can find information on the possibilities for interacting with other software in the chapter [@sec:Integrations].
type: Plain text
The development and product team has set the following goals for AlekSIS, in their dedication to support learning and teaching in the digital world:
The development and product team has set the following goals for AlekSIS, in their dedication to support learning and teaching in the digital world:
type: Plain text
Create a high-quality software product, adhering to high standards regarding data protection, data safety, security, and stability
Create a high-quality software product, adhering to high standards regarding data protection, data safety, security, and stability
type: Bullet: ' * '
Comply with as many national and regional data protection and school laws as possible (cf. [@sec:Legal])
Comply with as many national and regional data protection and school laws as possible (cf. [@sec:Legal])
type: Bullet: ' * '
Provide an extensible framework, allowing schools or their supporting IT companies to create their own apps (cf. [@sec:Development])
Provide an extensible framework, allowing schools or their supporting IT companies to create their own apps (cf. [@sec:Development])
type: Bullet: ' * '
Help coding clubs and classes to understand the development as deeply as necessary to use AlekSIS for learning and creating their own apps
Help coding clubs and classes to understand the development as deeply as necessary to use AlekSIS for learning and creating their own apps
type: Bullet: ' * '
Keep AlekSIS free, open, and transparent (cf. [@sec:FOSS])
Keep AlekSIS free, open, and transparent (cf. [@sec:FOSS])
type: Bullet: ' * '
# The AlekSIS core
# The AlekSIS core
type: Plain text
The AlekSIS core provides functionality and data models as a base for all apps.
The AlekSIS core provides functionality and data models as a base for all apps.
type: Plain text
## The concept of school terms {#sec:SchoolTerms}
## The concept of school terms {#sec:SchoolTerms}
type: Plain text
In AlekSIS, mostly everything is based on school terms. A school term is a defined time range which can be used to link data to it. Typically, such data are learning groups, timetables or class register records. Although their name suggests it, school terms don't have to be a half or a full year. They should depend on the way how you organise data in your institution.
In AlekSIS, mostly everything is based on school terms. A school term is a defined time range which can be used to link data to it. Typically, such data are learning groups, timetables or class register records. Although their name suggests it, school terms don't have to be a half or a full year. They should depend on the way how you organise data in your institution.
type: Plain text
For example, if you issue reports at the end of every half year, a half year would be a good time range for your school terms because the class register statistics are evaluated for school terms.
For example, if you issue reports at the end of every half year, a half year would be a good time range for your school terms because the class register statistics are evaluated for school terms.
type: Plain text
Anyway, you should create a school term before you start to import or create other data entries like persons or groups.
Anyway, you should create a school term before you start to import or create other data entries like persons or groups.
type: Plain text
### Manage school terms
### Manage school terms
type: Plain text
You can manage the school terms if you login with your admin account and open the menu entry `Admin → School terms`. There you can find a list of all school terms and buttons to create, edit or delete school terms. Please be aware that there can be only one school term at time and each school term needs a unique name.
You can manage the school terms if you login with your admin account and open the menu entry `Admin → School terms`. There you can find a list of all school terms and buttons to create, edit or delete school terms. Please be aware that there can be only one school term at time and each school term needs a unique name.
type: Plain text
## The concept of persons {#sec:Persons}
## The concept of persons {#sec:Persons}
type: Plain text
The person model is designed to save all the data of students, teachers, guardians and any other persons of the school society. It tracks information like the following:
The person model is designed to save all the data of students, teachers, guardians and any other persons of the school society. It tracks information like the following:
type: Plain text
- Full name - Short name - Sex - Date of birth - Contact details (phone numbers, email) - Address details - Photo - Relation to guardians - Primary group (e. g. a class or a tutor group, cf. [@sec:Groups])
- Full name - Short name - Sex - Date of birth - Contact details (phone numbers, email) - Address details - Photo - Relation to guardians - Primary group (e. g. a class or a tutor group, cf. [@sec:Groups])
type: Plain text
Except for the name, all data points are optional, so you can decide on your own (and on your local data protection laws) which data should be included in AlekSIS.
Except for the name, all data points are optional, so you can decide on your own (and on your local data protection laws) which data should be included in AlekSIS.
type: Plain text
There are two important things you should know about persons:
There are two important things you should know about persons:
type: Plain text
**Persons are not automatically users:** That means that persons can be linked to an user account including things like a password and the ability to login, but they don't have to be. For example, your AlekSIS instance could save the data about parents, but you don't want them to login: In this scenario, the guardians are available as persons **without** user accounts.
**Persons are not automatically users:** That means that persons can be linked to an user account including things like a password and the ability to login, but they don't have to be. For example, your AlekSIS instance could save the data about parents, but you don't want them to login: In this scenario, the guardians are available as persons **without** user accounts.
type: Bullet: '* '
**Persons are not linked to school terms:** As persons like students are not only at the school for one school term, persons are not linked to school terms.
**Persons are not linked to school terms:** As persons like students are not only at the school for one school term, persons are not linked to school terms.
type: Bullet: '* '
### Manage persons
### Manage persons
type: Plain text
The main method to manage persons is the view under `People → Persons`. To add person to groups, you have to open the respective group and set the person as a member or an owner.
The main method to manage persons is the view under `People → Persons`. To add person to groups, you have to open the respective group and set the person as a member or an owner.
type: Plain text
## The concept of groups {#sec:Groups}
## The concept of groups {#sec:Groups}
type: Plain text
The AlekSIS groups are a universal way to organise persons in collections like classes, courses, tutor groups, clubs, or any other division you could imagine. They track the following data:
The AlekSIS groups are a universal way to organise persons in collections like classes, courses, tutor groups, clubs, or any other division you could imagine. They track the following data:
type: Plain text
Group name and short name
Group name and short name
type: Bullet: '* '
Owners (e. g. class or course teacher(s))
Owners (e. g. class or course teacher(s))
type: Bullet: '* '
Members (e. g. students)
Members (e. g. students)
type: Bullet: '* '
Parent groups (e. g. a class could be a parent group for a course)
Parent groups (e. g. a class could be a parent group for a course)
type: Bullet: '* '
Group type (e. g. class, course, club, etc.)
Group type (e. g. class, course, club, etc.)
type: Bullet: '* '
In contrast to persons, groups are supposed to be **linked to school terms** (but they don't have to be). For example, the composition of a class or a course varies from school term to school term. In order to archive historical data according to local laws, these groups have to be separeted which is solved by linking them to a school term.
In contrast to persons, groups are supposed to be **linked to school terms** (but they don't have to be). For example, the composition of a class or a course varies from school term to school term. In order to archive historical data according to local laws, these groups have to be separeted which is solved by linking them to a school term.
type: Plain text
### Manage group types You can manage your local group types by opening the menu entry `People → Group types` as an admin user.
### Manage group types You can manage your local group types by opening the menu entry `People → Group types` as an admin user.
type: Plain text
### Manage groups Groups are managed on the page `People → Groups`. There you can search, view, create, change and delete groups.
### Manage groups Groups are managed on the page `People → Groups`. There you can search, view, create, change and delete groups.
type: Plain text
## Import school terms, persons and groups from other data sources
## Import school terms, persons and groups from other data sources
type: Plain text
When AlekSIS is not your single date source, all these data can be imported from other sources. You can find further information in [@sec:Integrations].
When AlekSIS is not your single date source, all these data can be imported from other sources. You can find further information in [@sec:Integrations].
type: Plain text
# Configuration and Administration {#sec:Administration}
# Configuration and Administration {#sec:Administration}
type: Plain text
## Install AlekSIS
## Install AlekSIS
type: Plain text
### From PyPI
### From PyPI
type: Plain text
In this section we will install AlekSIS with `uWSGI` and `NGINX` on Debian bullseye.
In this section we will install AlekSIS with `uWSGI` and `NGINX` on Debian bullseye.
type: Plain text
#### Filesystem locations
#### Filesystem locations
type: Plain text
AlekSIS will need and use the following paths by default:
AlekSIS will need and use the following paths by default:
type: Plain text
`/etc/aleksis` for configuration files
`/etc/aleksis` for configuration files
type: Bullet: ' * '
`/var/lib/aleksis/media` for file storage (Django media)
`/var/lib/aleksis/media` for file storage (Django media)
type: Bullet: ' * '
`/var/backups/aleksis` for backups of database and media files
`/var/backups/aleksis` for backups of database and media files
type: Bullet: ' * '
`/usr/local/share/aleksis/static` for static files
`/usr/local/share/aleksis/static` for static files
type: Bullet: ' * '
`/usr/local/share/aleksis/node_modules` for frontend dependencies
`/usr/local/share/aleksis/node_modules` for frontend dependencies
type: Bullet: ' * '
You can change any of the paths as you like.
You can change any of the paths as you like.
type: Plain text
#### Prerequisites
#### Prerequisites
type: Plain text
For an installation on a dedicated server, the following prerequisites are needed:
For an installation on a dedicated server, the following prerequisites are needed:
type: Plain text
Debian 11
Debian 11
type: Bullet: ' * '
PostgreSQL
PostgreSQL
type: Bullet: ' * '
Redis
Redis
type: Bullet: ' * '
uWSGI
uWSGI
type: Bullet: ' * '
nginx
nginx
type: Bullet: ' * '
Python 3.9
Python 3.9
type: Bullet: ' * '
Some system dependencies to build Python modules and manage frontend files
Some system dependencies to build Python modules and manage frontend files
type: Bullet: ' * '
The aforementioned paths
The aforementioned paths
type: Bullet: ' * '
#### Install system packages
#### Install system packages
type: Plain text
Install some packages from the Debian package system.
Install some packages from the Debian package system.
type: Plain text
```shell
apt install uwsgi \
uwsgi-plugin-python3 \
nginx-full \
python3 \
python3-dev \
libldap2-dev \
libsasl2-dev \
yarnpkg \
python3-virtualenv \
chromium \
redis-server \
postgresql
```
```shell
apt install uwsgi \
uwsgi-plugin-python3 \
nginx-full \
python3 \
python3-dev \
libldap2-dev \
libsasl2-dev \
yarnpkg \
python3-virtualenv \
chromium \
redis-server \
postgresql
```
type: Plain text
#### Create PostgreSQL user and database
#### Create PostgreSQL user and database
type: Plain text
Generate a secure password for the database, then create the user and database.
Generate a secure password for the database, then create the user and database.
type: Plain text
```shell
sudo -u postgres createuser -D -P -R -S aleksis
sudo -u postgres createdb -E UTF-8 -O aleksis -T template0 -l C.UTF-8 aleksis
```
```shell
sudo -u postgres createuser -D -P -R -S aleksis
sudo -u postgres createdb -E UTF-8 -O aleksis -T template0 -l C.UTF-8 aleksis
```
type: Plain text
When asked, use the password generated above.
When asked, use the password generated above.
type: Plain text
#### Create the directories for storage
#### Create the directories for storage
type: Plain text
```shell
mkdir -p /etc/aleksis \
/usr/share/aleksis/{static,node_modules} \
/var/lib/aleksis/media \
/var/backups/aleksis
chown -R www-data:www-data /var/lib/aleksis
```
```shell
mkdir -p /etc/aleksis \
/usr/share/aleksis/{static,node_modules} \
/var/lib/aleksis/media \
/var/backups/aleksis
chown -R www-data:www-data /var/lib/aleksis
```
type: Plain text
#### Create AlekSIS configuration file
#### Create AlekSIS configuration file
type: Plain text
AlekSIS is configured in files in `/etc/aleksis`. Create a basic configuration file for the environment defined above by opening `/etc/aleksis/aleksis.toml` with your favourite text editor and adding the following configuration.
AlekSIS is configured in files in `/etc/aleksis`. Create a basic configuration file for the environment defined above by opening `/etc/aleksis/aleksis.toml` with your favourite text editor and adding the following configuration.
type: Plain text
```toml
static = { root = "/usr/local/share/aleksis/static", url = "/static/" }
media = { root = "/var/lib/aleksis/media", url = "/media/" }
node_modules = { root = "/usr/local/share/aleksis/node_modules" }
secret_key = "SomeRandomValue"
```toml
static = { root = "/usr/local/share/aleksis/static", url = "/static/" }
media = { root = "/var/lib/aleksis/media", url = "/media/" }
node_modules = { root = "/usr/local/share/aleksis/node_modules" }
secret_key = "SomeRandomValue"
type: Plain text
[http]
allowed_hosts = ["aleksis.example.com"]
[http]
allowed_hosts = ["aleksis.example.com"]
type: Plain text
[database]
host = "localhost"
name = "aleksis"
username = "aleksis"
password = "password_generated_above"
[database]
host = "localhost"
name = "aleksis"
username = "aleksis"
password = "password_generated_above"
type: Plain text
[backup]
location = "/var/backups/aleksis"
[backup]
location = "/var/backups/aleksis"
type: Plain text
[auth.superuser]
username = "admin"
password = "admin"
email = "root@localhost"
```
[auth.superuser]
username = "admin"
password = "admin"
email = "root@localhost"
```
type: Plain text
#### Install AlekSIS itself
#### Install AlekSIS itself
type: Plain text
To install AlekSIS now, and run all post-install tasks, run the following commands. They will pull the AlekSIS standard distribution from `PyPI`_ and install it to the system-wide `dist-packages` of Python. Afterwards, it will download frontend dependencies from `yarnpkg`, collect static files, and migrate the database to the final schema.
To install AlekSIS now, and run all post-install tasks, run the following commands. They will pull the AlekSIS standard distribution from `PyPI`_ and install it to the system-wide `dist-packages` of Python. Afterwards, it will download frontend dependencies from `yarnpkg`, collect static files, and migrate the database to the final schema.
type: Plain text
```shell
pip3 install aleksis
aleksis-admin yarn install
aleksis-admin collectstatic
aleksis-admin migrate
aleksis-admin createinitialrevisions
```
```shell
pip3 install aleksis
aleksis-admin yarn install
aleksis-admin collectstatic
aleksis-admin migrate
aleksis-admin createinitialrevisions
```
type: Plain text
#### Configure uWSGI
#### Configure uWSGI
type: Plain text
uWSGI is an application server that will manage the server processes and requests. It will also run the Celery broker and scheduler for you.
uWSGI is an application server that will manage the server processes and requests. It will also run the Celery broker and scheduler for you.
type: Plain text
Configure a uWSGI app by opening `/etc/uwsgi/apps-available/aleksis.ini` in an editor and inserting:
Configure a uWSGI app by opening `/etc/uwsgi/apps-available/aleksis.ini` in an editor and inserting:
type: Plain text
```shell
[uwsgi]
vhost = true
plugins = python3
master = true
enable-threads = true
processes = 20
wsgi-file = /usr/local/lib/python3.9/dist-packages/aleksis/core/wsgi.py
chdir = /var/lib/aleksis
lazy = true
lazy-apps = true
attach-daemon = celery -A aleksis.core worker --concurrency=4
attach-daemon = celery -A aleksis.core beat
```
```shell
[uwsgi]
vhost = true
plugins = python3
master = true
enable-threads = true
processes = 20
wsgi-file = /usr/local/lib/python3.9/dist-packages/aleksis/core/wsgi.py
chdir = /var/lib/aleksis
lazy = true
lazy-apps = true
attach-daemon = celery -A aleksis.core worker --concurrency=4
attach-daemon = celery -A aleksis.core beat
```
type: Plain text
Afterwards, enable the app using:
Afterwards, enable the app using:
type: Plain text
```shell
```shell
type: Plain text
ln -s /etc/uwsgi/apps-available/aleksis.ini /etc/uwsgi/apps-enabled/aleksis.ini
service uwsgi restart
```
ln -s /etc/uwsgi/apps-available/aleksis.ini /etc/uwsgi/apps-enabled/aleksis.ini
service uwsgi restart
```
type: Plain text
#### Configure the nginx webserver
#### Configure the nginx webserver
type: Plain text
First, you should get a TLS certificate, e.g. by using `Let's Encrypt`_.
First, you should get a TLS certificate, e.g. by using `Let's Encrypt`_.
type: Plain text
Then, create a virtual host in nginx, by editing `/etc/nginx/sites-available/aleksis.example.com`.
Then, create a virtual host in nginx, by editing `/etc/nginx/sites-available/aleksis.example.com`.
type: Plain text
```nginx
upstream aleksis {
server unix:///run/uwsgi/app/aleksis/socket;
}
```nginx
upstream aleksis {
server unix:///run/uwsgi/app/aleksis/socket;
}
type: Plain text
server {
listen 80;
listen [::]:80;
server {
listen 80;
listen [::]:80;
type: Plain text
server_name aleksis.example.com;
server_name aleksis.example.com;
type: Plain text
return 301 https://$server_name$request_uri;
}
return 301 https://$server_name$request_uri;
}
type: Plain text
server {
listen 443 ssl http2;
listen [::]:443 ssl http2;
server {
listen 443 ssl http2;
listen [::]:443 ssl http2;
type: Plain text
ssl_certificate /etc/letsencrypt/certs/aleksis.example.com/fullchain.pem;
ssl_certificate_key /etc/letsencrypt/certs/aleksis.example.com/privkey.pem;
ssl_trusted_certificate /etc/letsencrypt/certs/aleksis.example.com/chain.pem;
ssl_certificate /etc/letsencrypt/certs/aleksis.example.com/fullchain.pem;
ssl_certificate_key /etc/letsencrypt/certs/aleksis.example.com/privkey.pem;
ssl_trusted_certificate /etc/letsencrypt/certs/aleksis.example.com/chain.pem;
type: Plain text
access_log /var/log/nginx/access.log;
access_log /var/log/nginx/access.log;
type: Plain text
location /static {
alias /usr/local/share/aleksis/static;
}
location /static {
alias /usr/local/share/aleksis/static;
}
type: Plain text
location / {
uwsgi_pass aleksis;
include uwsgi_params;
proxy_redirect off;
proxy_pass_header Authorization;
}
}
```
location / {
uwsgi_pass aleksis;
include uwsgi_params;
proxy_redirect off;
proxy_pass_header Authorization;
}
}
```
type: Plain text
Enable the virtual host:
Enable the virtual host:
type: Plain text
ln -s /etc/nginx/sites-available/aleksis.example.com /etc/nginx/sites-enabled/aleksis.example.com
service nginx restart
```
ln -s /etc/nginx/sites-available/aleksis.example.com /etc/nginx/sites-enabled/aleksis.example.com
service nginx restart
```
type: Plain text
#### Finalisation
#### Finalisation
type: Plain text
Your AlekSIS installation should now be reachable and you can login with the administration account configured above.
Your AlekSIS installation should now be reachable and you can login with the administration account configured above.
type: Plain text
### With Docker
### With Docker
type: Plain text
AlekSIS can also be installed using Docker, either only AlekSIS itself, or the full stack, including Redis, using docker-compose
AlekSIS can also be installed using Docker, either only AlekSIS itself, or the full stack, including Redis, using docker-compose
type: Plain text
#### Full stack using docker-compose
#### Full stack using docker-compose
type: Plain text
First, install Docker and docker-compose on your system. Also install git to get the docker-compose file and image definition.
First, install Docker and docker-compose on your system. Also install git to get the docker-compose file and image definition.
type: Plain text
apt install docker.io docker-compose git
```
apt install docker.io docker-compose git
```
type: Plain text
Now, clone the distribution repository, which contains the docker-compose file.
Now, clone the distribution repository, which contains the docker-compose file.
type: Plain text
git clone https://edugit.org/AlekSIS/official/AlekSIS
```
git clone https://edugit.org/AlekSIS/official/AlekSIS
```
type: Plain text
You should review the file `docker-compose.yaml` for any environment variables you want to change.
You should review the file `docker-compose.yaml` for any environment variables you want to change.
type: Plain text
Finally, bring the stack up using:
Finally, bring the stack up using:
type: Plain text
```shell
docker-compose up -d
```
```shell
docker-compose up -d
```
type: Plain text
AlekSIS will be reachable on port 80 if you forgot to configure the environment. You are responsible for adding a reverse proxy like nginx providing TLS, etc.
AlekSIS will be reachable on port 80 if you forgot to configure the environment. You are responsible for adding a reverse proxy like nginx providing TLS, etc.
type: Plain text
## Configuration files and format
## Configuration files and format
type: Plain text
### File locations and order
### File locations and order
type: Plain text
AlekSIS is configured through text files in the directory `/etc/aleksis/`. You can place any file types there that are supported by the `Dynaconf`_ configuration system (INI, YAML and TOML).
AlekSIS is configured through text files in the directory `/etc/aleksis/`. You can place any file types there that are supported by the `Dynaconf`_ configuration system (INI, YAML and TOML).
type: Plain text
Files are evaluated in alphabetical order, with later definitions overwriting earlier ones. Normally, there will be only one configuration file, but you can make up any structure you like. If you use multiple files, it might be a good idea to number them, e.g. `00_main.toml`, `01_myschool.toml`, `99_temporary.toml`.
Files are evaluated in alphabetical order, with later definitions overwriting earlier ones. Normally, there will be only one configuration file, but you can make up any structure you like. If you use multiple files, it might be a good idea to number them, e.g. `00_main.toml`, `01_myschool.toml`, `99_temporary.toml`.
type: Plain text
The TOML format is recommended and is the only format described in detail in AlekSIS’ documentation. For all other formats, refer to the `Dynaconf`_ documentation.
The TOML format is recommended and is the only format described in detail in AlekSIS’ documentation. For all other formats, refer to the `Dynaconf`_ documentation.
type: Plain text
### Configuration file format (TOML)
### Configuration file format (TOML)
type: Plain text
TOML file are simple text files that define variables, much like in Python (i.e. there are scalars, lists and dictionaries). AlekSIS structures its configuration by topic.
TOML file are simple text files that define variables, much like in Python (i.e. there are scalars, lists and dictionaries). AlekSIS structures its configuration by topic.
type: Plain text
A configuration file might look like this:
A configuration file might look like this:
type: Plain text
```toml
secret_key = "VerySecretKeyForSessionSecurity"
```toml
secret_key = "VerySecretKeyForSessionSecurity"
type: Plain text
[http]
allowed_hosts = [ "aleksis.myschool.example.com", "localhost" ]
[http]
allowed_hosts = [ "aleksis.myschool.example.com", "localhost" ]
type: Plain text
[database]
name = "aleksis"
user = "aleksis"
password = "SuperSecretPassword"
[database]
name = "aleksis"
user = "aleksis"
password = "SuperSecretPassword"
type: Plain text
[caching]
redis = { enabled = true, address = "127.0.0.1" }
```
[caching]
redis = { enabled = true, address = "127.0.0.1" }
```
type: Plain text
The `secret_key` setting above defines a single value. The following `http` section defines a table (cf. a dictionary) in one way, and you can see the second form of such a table in the `redis` setting (we could as well have defined another section and placed `enabled` and `address` below it as scalars).
The `secret_key` setting above defines a single value. The following `http` section defines a table (cf. a dictionary) in one way, and you can see the second form of such a table in the `redis` setting (we could as well have defined another section and placed `enabled` and `address` below it as scalars).
type: Plain text
This can be a bit confusing, so this documentation will explain how to configure AlekSIS on a per-feature basis.
This can be a bit confusing, so this documentation will explain how to configure AlekSIS on a per-feature basis.
type: Plain text
## Authenticating against LDAP
## Authenticating against LDAP
type: Plain text
AlekSIS can authenticate users against an LDAP directory (like OpenLDAP or Active Directory). The AlekSIS core can only authenticate and synchronise authenticated users to AlekSIS’ database. There are apps that help with tasks like mass-importing accounts and linking accounts to persons in the AlekSIS system (see below).
AlekSIS can authenticate users against an LDAP directory (like OpenLDAP or Active Directory). The AlekSIS core can only authenticate and synchronise authenticated users to AlekSIS’ database. There are apps that help with tasks like mass-importing accounts and linking accounts to persons in the AlekSIS system (see below).
type: Plain text
### Installing packages for LDAP support
### Installing packages for LDAP support
type: Plain text
Installing the necessary libraries for LDAP support unfortunately is not very straightforward under all circumstances. On Debian, install these packages:
Installing the necessary libraries for LDAP support unfortunately is not very straightforward under all circumstances. On Debian, install these packages:
type: Plain text
```bash
sudo apt install python3-ldap libldap2-dev libssl-dev libsasl2-dev python3-dev
```
```bash
sudo apt install python3-ldap libldap2-dev libssl-dev libsasl2-dev python3-dev
```
type: Plain text
### Configuration of LDAP support
### Configuration of LDAP support
type: Plain text
Configuration is done under the ``default.ldap`` section in AlekSIS’ configuration file. For example, add something like the following to your configuration (normally in ``/etc/aleksis``; you can either append to an existing file or add a new one).
Configuration is done under the ``default.ldap`` section in AlekSIS’ configuration file. For example, add something like the following to your configuration (normally in ``/etc/aleksis``; you can either append to an existing file or add a new one).
type: Plain text
```toml
[ldap]
uri = "ldaps://ldap.myschool.edu"
bind = { dn = "cn=reader,dc=myschool,dc=edu", password = "secret" }
```toml
[ldap]
uri = "ldaps://ldap.myschool.edu"
bind = { dn = "cn=reader,dc=myschool,dc=edu", password = "secret" }
type: Plain text
[ldap.users]
search = { base = "ou=people,dc=myschool,dc=edu", filter = "(uid=%(user)s)" }
map = { first_name = "givenName", last_name = "sn", email = "mail" }
[ldap.users]
search = { base = "ou=people,dc=myschool,dc=edu", filter = "(uid=%(user)s)" }
map = { first_name = "givenName", last_name = "sn", email = "mail" }
type: Plain text
[ldap.groups]
search = { base = "ou=groups,dc=myschool,dc=edu" }
type = "groupOfNames"
# Users in group "admins" are superusers
flags = { is_superuser = "cn=admins,ou=groups,dc=myschool,dc=edu" }
```
[ldap.groups]
search = { base = "ou=groups,dc=myschool,dc=edu" }
type = "groupOfNames"
# Users in group "admins" are superusers
flags = { is_superuser = "cn=admins,ou=groups,dc=myschool,dc=edu" }
```
type: Plain text
## Configuration options
## Configuration options
type: Plain text
AlekSIS provides lots of options to configure your instance.
AlekSIS provides lots of options to configure your instance.
type: Plain text
### Configuration file
### Configuration file
type: Plain text
All settings which are required for running an AlekSIS instance are stored in your configuration file ``/etc/aleksis/aleksis.toml``.
All settings which are required for running an AlekSIS instance are stored in your configuration file ``/etc/aleksis/aleksis.toml``.
type: Plain text
Example configuration file:
Example configuration file:
type: Plain text
```toml
# General config for static, media and secret key, required
static = { root = "/srv/www/aleksis/data/static", url = "/static/" }
media = { root = "/srv/www/aleksis/data/media", url = "/media/" }
secret_key = "Xoc8eiwah3neehid2Xi3oomoh4laem"
```toml
# General config for static, media and secret key, required
static = { root = "/srv/www/aleksis/data/static", url = "/static/" }
media = { root = "/srv/www/aleksis/data/media", url = "/media/" }
secret_key = "Xoc8eiwah3neehid2Xi3oomoh4laem"
type: Plain text
# Admin contact, optional
[contact]
admins = [["AlekSIS - Admins", "root@example.com"]]
from = 'aleksis@example.com'
# Admin contact, optional
[contact]
admins = [["AlekSIS - Admins", "root@example.com"]]
from = 'aleksis@example.com'
type: Plain text
# Allowed hosts, required
[http]
allowed_hosts = ["localhost"]
# Allowed hosts, required
[http]
allowed_hosts = ["localhost"]
type: Plain text
# Database for whole AlekSIS data, required
[database]
host = "localhost"
name = "aleksis"
username = "aleksis"
password = "aleksis"
# Database for whole AlekSIS data, required
[database]
host = "localhost"
name = "aleksis"
username = "aleksis"
password = "aleksis"
type: Plain text
# Maintenance mode and debug, optional
[maintenance]
debug = true
# Maintenance mode and debug, optional
[maintenance]
debug = true
type: Plain text
# Two factor authentication with yubikey enabled, optional
[2fa]
enabled = true
yubikey = { enabled = true }
# Two factor authentication with yubikey enabled, optional
[2fa]
enabled = true
yubikey = { enabled = true }
type: Plain text
# Authentication via LDAP, optional
[ldap]
uri = "ldaps://ldap.myschool.edu"
bind = { dn = "cn=reader,dc=myschool,dc=edu", password = "secret" }
map = { first_name = "givenName", last_name = "sn", email = "mail" }
# Authentication via LDAP, optional
[ldap]
uri = "ldaps://ldap.myschool.edu"
bind = { dn = "cn=reader,dc=myschool,dc=edu", password = "secret" }
map = { first_name = "givenName", last_name = "sn", email = "mail" }
type: Plain text
[ldap.users]
search = { base = "ou=people,dc=myschool,dc=edu", filter = "(uid=%(user)s)" }
[ldap.users]
search = { base = "ou=people,dc=myschool,dc=edu", filter = "(uid=%(user)s)" }
type: Plain text
[ldap.groups]
search = { base = "ou=groups,dc=myschool,dc=edu" }
type = "groupOfNames"
# Users in group "admins" are superusers
flags = { is_superuser = "cn=admins,ou=groups,dc=myschool,dc=edu" }
[ldap.groups]
search = { base = "ou=groups,dc=myschool,dc=edu" }
type = "groupOfNames"
# Users in group "admins" are superusers
flags = { is_superuser = "cn=admins,ou=groups,dc=myschool,dc=edu" }
type: Plain text
# Search index, optional
[search]
backend = "whoosh"
index = "/srv/www/aleksis/data/whoosh_index"
```
# Search index, optional
[search]
backend = "whoosh"
index = "/srv/www/aleksis/data/whoosh_index"
```
type: Plain text
### Configuration in frontend
### Configuration in frontend
type: Plain text
Everything that must not be configured before the AlekSIS instance fully starts can be configured in frontend, such as site title and logo.
Everything that must not be configured before the AlekSIS instance fully starts can be configured in frontend, such as site title and logo.
type: Plain text
You can find the configuration options in your AlekSIS instance under ``Admin → Configuration``.
You can find the configuration options in your AlekSIS instance under ``Admin → Configuration``.
type: Plain text
## Storage
## Storage
type: Plain text
### Amazon S3
### Amazon S3
type: Plain text
AlekSIS allows you to configure an Amazon S3 endpoint for static and media files. This is useful e.g. for loadbalancing with multiple AlekSIS instances.
AlekSIS allows you to configure an Amazon S3 endpoint for static and media files. This is useful e.g. for loadbalancing with multiple AlekSIS instances.
type: Plain text
#### Configure an S3 endpoint
#### Configure an S3 endpoint
type: Plain text
If you want to use an S3 endpoint to store files you have to configure the endpoint in your configuration file (`/etc/aleksis/aleksis.toml`):
If you want to use an S3 endpoint to store files you have to configure the endpoint in your configuration file (`/etc/aleksis/aleksis.toml`):
type: Plain text
```
# Default values
[storage.s3]
enabled = true
endpoint_url = "https://minio.example.com"
bucket_name = "aleksis-test"
access_key_id = "XXXXXXXXXXXXXX"
secret_key = "XXXXXXXXXXXXXXXXXXXXXX"
```
```
# Default values
[storage.s3]
enabled = true
endpoint_url = "https://minio.example.com"
bucket_name = "aleksis-test"
access_key_id = "XXXXXXXXXXXXXX"
secret_key = "XXXXXXXXXXXXXXXXXXXXXX"
```
type: Plain text
## OAuth2/OpenID-Connect provider
## OAuth2/OpenID-Connect provider
type: Plain text
AlekSIS can provide OAuth2 and OpenID provider to allow other applications to authenticate users via AlekSIS.
AlekSIS can provide OAuth2 and OpenID provider to allow other applications to authenticate users via AlekSIS.
type: Plain text
### Enable provider
### Enable provider
type: Plain text
To enable the feature, you have to do the following steps
To enable the feature, you have to do the following steps
type: Plain text
#### Create RSA key to validate JWT tokens
#### Create RSA key to validate JWT tokens
type: Plain text
```shell openssl genrsa -out /etc/aleksis/oidc.pem 4096 ```
```shell openssl genrsa -out /etc/aleksis/oidc.pem 4096 ```
type: Plain text
#### Enable feature in settings
#### Enable feature in settings
type: Plain text
Enable the feature in your local AlekSIS configuration (e.g. `/etc/aleksis/aleksis.toml`:
Enable the feature in your local AlekSIS configuration (e.g. `/etc/aleksis/aleksis.toml`:
type: Plain text
```toml [oauth2.oidc] enabled = true ```
```toml [oauth2.oidc] enabled = true ```
type: Plain text
#### Register OAuth2 applications in frontend
#### Register OAuth2 applications in frontend
type: Plain text
In the AlekSIS frontend, OAuth2 applications can be registred per User at `Account → Third-party applications`.
In the AlekSIS frontend, OAuth2 applications can be registred per User at `Account → Third-party applications`.
type: Plain text
To authorize a new application, you have to click on "Login <Application Name>". Follow the instructions from your application.
To authorize a new application, you have to click on "Login <Application Name>". Follow the instructions from your application.
type: Plain text
To remove the application from your profile, use the "remove" button on the `Third-party applications` page.
To remove the application from your profile, use the "remove" button on the `Third-party applications` page.
type: Plain text
## Backups
## Backups
type: Plain text
### Configuration
### Configuration
type: Plain text
```toml # General backup configuration [backup] # GPG recipient of encrypted backups files. Public key must be in local keyring! gpg_recipient = "gpg@example.com" # Directory to store the backups location = "/var/backups/aleksis"
```toml # General backup configuration [backup] # GPG recipient of encrypted backups files. Public key must be in local keyring! gpg_recipient = "gpg@example.com" # Directory to store the backups location = "/var/backups/aleksis"
type: Plain text
# Configuration for media backups [backup.media] # Keep 10 backups keep = 10 # Compress backups to save disk space compress = True # Encrypt Backups with GPG key configured in [backup] section encrypt = True # Clean old backups clean = True
# Configuration for media backups [backup.media] # Keep 10 backups keep = 10 # Compress backups to save disk space compress = True # Encrypt Backups with GPG key configured in [backup] section encrypt = True # Clean old backups clean = True
type: Plain text
# Same options for [backup.database] ```
# Same options for [backup.database] ```
type: Plain text
### Restore
### Restore
type: Plain text
If you have to restore a backup, you can do this via management commands:
If you have to restore a backup, you can do this via management commands:
type: Plain text
```shell # List all backups $ aleksis-admin listbackups # Restore backup (uncompressed) # Use dbrestore for db backups and mediarestore for media backups $ aleksis-admin dbrestore -i backup.psql # Restore backup (compressed) $ aleksis-admin dbrestore -z -i backup.psql.gz ```
```shell # List all backups $ aleksis-admin listbackups # Restore backup (uncompressed) # Use dbrestore for db backups and mediarestore for media backups $ aleksis-admin dbrestore -i backup.psql # Restore backup (compressed) $ aleksis-admin dbrestore -z -i backup.psql.gz ```
type: Plain text
### Automatic backups
### Automatic backups
type: Plain text
Automatic backups are handled via celery tasks. The celery tasks can be configured via the django admin interface (Admin → Backend Admin).
Automatic backups are handled via celery tasks. The celery tasks can be configured via the django admin interface (Admin → Backend Admin).
type: Plain text
In the admin interface, visit `PERIODIC TASKS` → `Periodic tasks` and press `Add periodic task`. In this form you can choose one of the registred tasks and configure schedules. It is also possible to configure arguments and execution options such as priorities expiration dates.
In the admin interface, visit `PERIODIC TASKS` → `Periodic tasks` and press `Add periodic task`. In this form you can choose one of the registred tasks and configure schedules. It is also possible to configure arguments and execution options such as priorities expiration dates.
type: Plain text
## Impersonation
## Impersonation
type: Plain text
Impersonation is a very useful feature to debug configuration or permission issues.
Impersonation is a very useful feature to debug configuration or permission issues.
type: Plain text
You are able to impersonate another AlekSIS user. To do so, visit the impersonation page (Admin → Impersonation) and choose the user you want to impersonate.
You are able to impersonate another AlekSIS user. To do so, visit the impersonation page (Admin → Impersonation) and choose the user you want to impersonate.
type: Plain text
If you want to stop the impersonation, press Account → Stop impersonation in the navigation bar on the left.
If you want to stop the impersonation, press Account → Stop impersonation in the navigation bar on the left.
type: Plain text
## Configure Icons
## Configure Icons
type: Plain text
To configure your own site logo or favicon, visit Admin → Configuration and navigate to the "Theme" section. Now you can see three file fields.
To configure your own site logo or favicon, visit Admin → Configuration and navigate to the "Theme" section. Now you can see three file fields.
type: Plain text
Logo (Banner in left navigation bar)
Logo (Banner in left navigation bar)
type: Bullet: '* '
Favicon (Icon in browser tab)
Favicon (Icon in browser tab)
type: Bullet: '* '
PWA-Icon (Icon on mobile home screen)
PWA-Icon (Icon on mobile home screen)
type: Bullet: '* '
## Debug tools
## Debug tools
type: Plain text
AlekSIS provides tools to debug and manipulate data. Use them only if you know what you are doing!
AlekSIS provides tools to debug and manipulate data. Use them only if you know what you are doing!
type: Plain text
### django-extensions
### django-extensions
type: Plain text
django-extensions provides many small features to debug your AlekSIS instance from the command line. You can generate passwords and secret keys, get list of all urls, list models and signals and much more.
django-extensions provides many small features to debug your AlekSIS instance from the command line. You can generate passwords and secret keys, get list of all urls, list models and signals and much more.
type: Plain text
### ipython3
### ipython3
type: Plain text
iPython3 is a powerfull python shell. You can use it to manipulate and debug the data in your AlekSIS instance. Use it with caution and be sure to have backups of your data.
iPython3 is a powerfull python shell. You can use it to manipulate and debug the data in your AlekSIS instance. Use it with caution and be sure to have backups of your data.
type: Plain text
## Preferences
## Preferences
type: Plain text
### Site preferences
### Site preferences
type: Plain text
| Section | Purpose |
|-----------------------------|-----------------------------------------------------------------------------------------------------|
| General | General configuration (site title, site descirption,…) |
| Theme | Theming options, e.g. upload of logos, favicons and configuration of theme colours |
| Mail | Mail out name and address |
| Footer | Configure links legal information (privacy policy, imprint) in footer |
| Accounts | Configure primary group match regex and fields on person model that should be editable by themselves|
| School | Official and display name of your school |
| Authentication | Enable/disable sign up, allow users to change their password |
| Internationalisation | Configure available languages |
| Section | Purpose |
|-----------------------------|-----------------------------------------------------------------------------------------------------|
| General | General configuration (site title, site descirption,…) |
| Theme | Theming options, e.g. upload of logos, favicons and configuration of theme colours |
| Mail | Mail out name and address |
| Footer | Configure links legal information (privacy policy, imprint) in footer |
| Accounts | Configure primary group match regex and fields on person model that should be editable by themselves|
| School | Official and display name of your school |
| Authentication | Enable/disable sign up, allow users to change their password |
| Internationalisation | Configure available languages |
type: Plain text
### User preferences
### User preferences
type: Plain text
| Section | Purpose |
|---------------|--------------------------------------------------|
| Notifications | Configure notifications channels and name format |
| Section | Purpose |
|---------------|--------------------------------------------------|
| Notifications | Configure notifications channels and name format |
type: Plain text
## Caching
## Caching
type: Plain text
### Redis
### Redis
type: Plain text
Redis cache can be managed via `redis-cli` on the command line:
Redis cache can be managed via `redis-cli` on the command line:
type: Plain text
```shell # Flush all objects from cache 127.0.0.1:6379> FLUSHALL ```
```shell # Flush all objects from cache 127.0.0.1:6379> FLUSHALL ```
type: Plain text
## Global search
## Global search
type: Plain text
AlekSIS provides a global search in the left navigation bar. You are able to search through former indexed persons and groups.
AlekSIS provides a global search in the left navigation bar. You are able to search through former indexed persons and groups.
type: Plain text
Other apps can also add their models to the index.
Other apps can also add their models to the index.
type: Plain text
### Manage indexes
### Manage indexes
type: Plain text
Items in indexes are updated automatically by their save-hooks.
Items in indexes are updated automatically by their save-hooks.
type: Plain text
Indexes can also be managed via `aleksis-admin` on the command line:
Indexes can also be managed via `aleksis-admin` on the command line:
type: Plain text
```shell # Clear all objects from the index $ aleksis-admin clear_index # Show indexes $ aleksis-admin haystack_info # Rebuild all indexes $ aleksis-admin rebuild_index # Update item on index $ aleksis-admin update_index <App label> ```
```shell # Clear all objects from the index $ aleksis-admin clear_index # Show indexes $ aleksis-admin haystack_info # Rebuild all indexes $ aleksis-admin rebuild_index # Update item on index $ aleksis-admin update_index <App label> ```
type: Plain text
# Monitoring and health checks {#sec:Monitoring}
# Monitoring and health checks {#sec:Monitoring}
type: Plain text
## Configuration
## Configuration
type: Plain text
### Thresholds
### Thresholds
type: Plain text
Thresholds for health checks can be configured via config file (`/etc/aleksis`).
Thresholds for health checks can be configured via config file (`/etc/aleksis`).
type: Plain text
```toml [health] disk_usage_max_percent = 90 memory_min_mb = 500
```toml [health] disk_usage_max_percent = 90 memory_min_mb = 500
type: Plain text
[backup.database] check_seconds = 7200
[backup.database] check_seconds = 7200
type: Plain text
[backup.media] check_seconds = 7200 ```
[backup.media] check_seconds = 7200 ```
type: Plain text
## Status page
## Status page
type: Plain text
AlekSIS status page show information about the health of your AlekSIS instance. You can visit it via the left navigation bar (Admin → Status).
AlekSIS status page show information about the health of your AlekSIS instance. You can visit it via the left navigation bar (Admin → Status).
type: Plain text
The page show information about debug and maintenance mode, a summary of your health checks and the last exit status of your celery tasks. This page can not be used as a health check, it will always return HTTP 200 if the site is reachable.
The page show information about debug and maintenance mode, a summary of your health checks and the last exit status of your celery tasks. This page can not be used as a health check, it will always return HTTP 200 if the site is reachable.
type: Plain text
## Health check
## Health check
type: Plain text
The health check can be used to verify the health of your AlekSIS instance. You can access it via the browser (https://aleksis.example.com/health/) and it will show you a summary of your health checks. If something is wrong it will return HTTP 500.
The health check can be used to verify the health of your AlekSIS instance. You can access it via the browser (https://aleksis.example.com/health/) and it will show you a summary of your health checks. If something is wrong it will return HTTP 500.
type: Plain text
It is also possible to get a JSON response from the health check, for example via `curl`. You only have to pass a valid `Accept: application/json` header to your request.
It is also possible to get a JSON response from the health check, for example via `curl`. You only have to pass a valid `Accept: application/json` header to your request.
type: Plain text
The health check can also be executed via `aleksis-admin`:
The health check can also be executed via `aleksis-admin`:
type: Plain text
```shell $ aleksis-admin health_check ```
```shell $ aleksis-admin health_check ```
type: Plain text
## Monitoring with Icinga2
## Monitoring with Icinga2
type: Plain text
As already mentioned, there is a JSON endpoint at https://aleksis.example.com/health/. You can use an json check plugin to check seperate health checks or just use a HTTP check to check if the site returns HTTP 200.
As already mentioned, there is a JSON endpoint at https://aleksis.example.com/health/. You can use an json check plugin to check seperate health checks or just use a HTTP check to check if the site returns HTTP 200.
type: Plain text
## Performance monitoring with Prometheus
## Performance monitoring with Prometheus
type: Plain text
AlekSIS provides a Prometheus exporter. The exporter provides metrics about responses and requests, e.g. s about response codes, request latency and requests per view. It al provides data about database operations.
AlekSIS provides a Prometheus exporter. The exporter provides metrics about responses and requests, e.g. s about response codes, request latency and requests per view. It al provides data about database operations.
type: Plain text
### Metrics endpoint
### Metrics endpoint
type: Plain text
The metrics endpoint can be found at https://aleksis.example.com/metrics. In the default configuration it can be scraped from everywhere. You might want to add some webserver configuration to restrict access to this url.
The metrics endpoint can be found at https://aleksis.example.com/metrics. In the default configuration it can be scraped from everywhere. You might want to add some webserver configuration to restrict access to this url.
type: Plain text
To get metrics of your AlekSIS instance, just add the following to `prometheus.yml`
To get metrics of your AlekSIS instance, just add the following to `prometheus.yml`
type: Plain text
```yaml
- job_name: aleksis
static_configs:
- targets: ['my.aleksis-instance.com']
metrics_path: /metrics
```
```yaml
- job_name: aleksis
static_configs:
- targets: ['my.aleksis-instance.com']
metrics_path: /metrics
```
type: Plain text
### Rules for prometheus alertmanager
### Rules for prometheus alertmanager
type: Plain text
If you are using the prometheus alertmanager, it is possible to create some alerting rules so that an alert is fired when your AlekSIS instance is slow or something.
If you are using the prometheus alertmanager, it is possible to create some alerting rules so that an alert is fired when your AlekSIS instance is slow or something.
type: Plain text
```yaml
groups:
- name: aleksis
rules:
- alert: HighRequestLatency
expr: histogram_quantile(0.999, sum(rate(django_http_requests_latency_seconds_by_view_method_bucket{instance="YOUR-INSTANCE",view!~"prometheus-django-metrics|healthcheck"}[15m])) by (job, le)) < 30
for: 15m
labels:
severity: page
annotations:
summary: High request latency for 15 minutes
```
```yaml
groups:
- name: aleksis
rules:
- alert: HighRequestLatency
expr: histogram_quantile(0.999, sum(rate(django_http_requests_latency_seconds_by_view_method_bucket{instance="YOUR-INSTANCE",view!~"prometheus-django-metrics|healthcheck"}[15m])) by (job, le)) < 30
for: 15m
labels:
severity: page
annotations:
summary: High request latency for 15 minutes
```
type: Plain text
### Grafana dashboard
### Grafana dashboard
type: Plain text
There is a Grafana dashboard available to visualize the metrics.
There is a Grafana dashboard available to visualize the metrics.
type: Plain text
The dashboard is available at https://grafana.com/grafana/dashboards/9528.
The dashboard is available at https://grafana.com/grafana/dashboards/9528.
type: Plain text
## Managing your personal account
## Managing your personal account
type: Plain text
Each logged in user has several options to provided through the AlekSIS core. Which of these items are display depends on whether the user has a person and what your system administrator has configured.
Each logged in user has several options to provided through the AlekSIS core. Which of these items are display depends on whether the user has a person and what your system administrator has configured.
type: Plain text
### Notifications {#sec:Notifications} The AlekSIS core has a built-in notification system which can be used by apps to send urgent information to specific persons (e. g. timetable changes). Notifications are shown on the dashboard and the notifications page reachable over the menu entry `Notifications`. In addition to that, notifications can be sent to users through several communication channels. These channels can be switched on or off in your personal preferences (cf. [@sec:PersonalPreferences]).
### Notifications {#sec:Notifications} The AlekSIS core has a built-in notification system which can be used by apps to send urgent information to specific persons (e. g. timetable changes). Notifications are shown on the dashboard and the notifications page reachable over the menu entry `Notifications`. In addition to that, notifications can be sent to users through several communication channels. These channels can be switched on or off in your personal preferences (cf. [@sec:PersonalPreferences]).
type: Plain text
### Setup two-factor authentication TBA.
### Setup two-factor authentication TBA.
type: Plain text
### Change password
### Change password
type: Plain text
If your system administrator has activated this function, you can change your password via `Account → Change password`. If you forgot your password, there is a link `Password forgotten?` on this page which helps with resetting your password. The system then will send you a password reset link via email.
If your system administrator has activated this function, you can change your password via `Account → Change password`. If you forgot your password, there is a link `Password forgotten?` on this page which helps with resetting your password. The system then will send you a password reset link via email.
type: Plain text
### Me page
### Me page
type: Plain text
Reachable under `Account → Me`, this page shows the personal information saved about you in the system. If activated, you can upload a picture of yourself or edit some information.
Reachable under `Account → Me`, this page shows the personal information saved about you in the system. If activated, you can upload a picture of yourself or edit some information.
type: Plain text
### Personal preferences {#sec:PersonalPreferences}
### Personal preferences {#sec:PersonalPreferences}
type: Plain text
You can configure some behavior using the preferences under `Account → Preferences`. By default, the Core only provides some preferences, but apps can extend this list. You can find further information about such preferences in the chapter of the respective apps.
You can configure some behavior using the preferences under `Account → Preferences`. By default, the Core only provides some preferences, but apps can extend this list. You can find further information about such preferences in the chapter of the respective apps.
type: Plain text
**Notifications**
**Notifications**
type: Bullet: '- '
**Name format for addressing**: Here you can select how AlekSIS should address you.
**Name format for addressing**: Here you can select how AlekSIS should address you.
type: Bullet: ' + '
**Channels to use for notifications:** This channel is used to sent notifications to you (cf. [@sec:Notifications]).
**Channels to use for notifications:** This channel is used to sent notifications to you (cf. [@sec:Notifications]).
type: Bullet: ' + '
### Third-party accounts If you logged in using a third-party account (e. g. a Google or Microsoft account), you can manage the connections to these accounts on the page `Account → Third-party accounts`.
### Third-party accounts If you logged in using a third-party account (e. g. a Google or Microsoft account), you can manage the connections to these accounts on the page `Account → Third-party accounts`.
type: Plain text
### Authorized applications On the page `Account → Authorized applications` you can see all external applications you authorized to retreive data about you from AlekSIS. That can be services provided by your local institution like a chat platform, for example.
### Authorized applications On the page `Account → Authorized applications` you can see all external applications you authorized to retreive data about you from AlekSIS. That can be services provided by your local institution like a chat platform, for example.
type: Plain text
# Integrations with other software {#sec:Integrations}
# Integrations with other software {#sec:Integrations}
type: Plain text
TBA.
TBA.
type: Plain text
# Developing apps and extending AlekSIS
# Developing apps and extending AlekSIS
type: Plain text
# Appendices
# Appendices
type: Plain text
## Free Software and Open Source {#sec:FOSS}
## Free Software and Open Source {#sec:FOSS}
type: Plain text
## Legal information {#sec:Leagl}
## Legal information {#sec:Leagl}
type: Plain text
## Copyright Notes
## Copyright Notes
type: Plain text
### AlekSIS Core and official apps
### AlekSIS Core and official apps
type: Plain text
The AlekSIS Core and all official apps are copyright by the respective developers, as listed in the text files accompanying each source tree. They are licensed under the terms of the European Union Public License (EUPL), version 1.2 or later.
The AlekSIS Core and all official apps are copyright by the respective developers, as listed in the text files accompanying each source tree. They are licensed under the terms of the European Union Public License (EUPL), version 1.2 or later.
type: Plain text
### The AlekSIS Handbook
### The AlekSIS Handbook
type: Plain text
This handbook itself, with the exception of the cover artwork, is copyright 2021 by the authors listed on the cover, and licensed under the EUPL, version 1.2 or later.
This handbook itself, with the exception of the cover artwork, is copyright 2021 by the authors listed on the cover, and licensed under the EUPL, version 1.2 or later.
type: Plain text
### Cover artwork
### Cover artwork
type: Plain text
The cover artwork remix is copyright 2021 by Dominik George.
The cover artwork remix is copyright 2021 by Dominik George.
type: Plain text
The following cover artwork photos are copyright 2021 by Max Knopp of Katharineum zu Lübeck:
The following cover artwork photos are copyright 2021 by Max Knopp of Katharineum zu Lübeck:
type: Plain text
Children in front of digital signage monitor
Children in front of digital signage monitor
type: Bullet: ' * '
Child's hand with smartphone
Child's hand with smartphone
type: Bullet: ' * '
Teachers in front of computer screen
Teachers in front of computer screen
type: Bullet: ' * '
The following cover artwork photo is copyright 2020 Martin Gummi of Teckids e.V.:
The following cover artwork photo is copyright 2020 Martin Gummi of Teckids e.V.:
type: Plain text
People in computer lab with laptops
People in computer lab with laptops
type: Bullet: ' * '
All artwork is licensed under EUPL 1.2 or later or, optionally, under CC-BY-SA 4.0 or later.
All artwork is licensed under EUPL 1.2 or later or, optionally, under CC-BY-SA 4.0 or later.
type: Plain text
## EUROPEAN UNION PUBLIC LICENCE v. 1.2
## EUROPEAN UNION PUBLIC LICENCE v. 1.2
type: Plain text
EUPL © the European Union 2007, 2016
EUPL © the European Union 2007, 2016
type: Plain text
This European Union Public Licence (the 'EUPL') applies to the Work (as defined below) which is provided under the terms of this Licence. Any use of the Work, other than as authorised under this Licence is prohibited (to the extent such use is covered by a right of the copyright holder of the Work).
This European Union Public Licence (the 'EUPL') applies to the Work (as defined below) which is provided under the terms of this Licence. Any use of the Work, other than as authorised under this Licence is prohibited (to the extent such use is covered by a right of the copyright holder of the Work).
type: Plain text
The Work is provided under the terms of this Licence when the Licensor (as defined below) has placed the following notice immediately following the copyright notice for the Work:
The Work is provided under the terms of this Licence when the Licensor (as defined below) has placed the following notice immediately following the copyright notice for the Work:
type: Plain text
> Licensed under the EUPL
> Licensed under the EUPL
type: Plain text
or has expressed by any other means his willingness to license under the EUPL.
or has expressed by any other means his willingness to license under the EUPL.
type: Plain text
### Definitions
### Definitions
type: Plain text
### 1. Definitions
### 1. Definitions
type: Plain text
In this Licence, the following terms have the following meaning:
In this Licence, the following terms have the following meaning:
type: Plain text
'The Licence': this Licence.
'The Licence': this Licence.
type: Bullet: '- '
'The Original Work': the work or software distributed or communicated by the Licensor under this Licence, available as Source Code and also as Executable Code as the case may be.
'The Original Work': the work or software distributed or communicated by the Licensor under this Licence, available as Source Code and also as Executable Code as the case may be.
type: Bullet: '- '
'Derivative Works': the works or software that could be created by the Licensee, based upon the Original Work or modifications thereof. This Licence does not define the extent of modification or dependence on the Original Work required in order to classify a work as a Derivative Work; this extent is determined by copyright law applicable in the country mentioned in Article 15.
'Derivative Works': the works or software that could be created by the Licensee, based upon the Original Work or modifications thereof. This Licence does not define the extent of modification or dependence on the Original Work required in order to classify a work as a Derivative Work; this extent is determined by copyright law applicable in the country mentioned in Article 15.
type: Bullet: '- '
'The Work': the Original Work or its Derivative Works.
'The Work': the Original Work or its Derivative Works.
type: Bullet: '- '
'The Source Code': the human-readable form of the Work which is the most convenient for people to study and modify.
'The Source Code': the human-readable form of the Work which is the most convenient for people to study and modify.
type: Bullet: '- '
'The Executable Code': any code which has generally been compiled and which is meant to be interpreted by a computer as a program.
'The Executable Code': any code which has generally been compiled and which is meant to be interpreted by a computer as a program.
type: Bullet: '- '
'The Licensor': the natural or legal person that distributes or communicates the Work under the Licence.
'The Licensor': the natural or legal person that distributes or communicates the Work under the Licence.
type: Bullet: '- '
'Contributor(s)': any natural or legal person who modifies the Work under the Licence, or otherwise contributes to the creation of a Derivative Work.
'Contributor(s)': any natural or legal person who modifies the Work under the Licence, or otherwise contributes to the creation of a Derivative Work.
type: Bullet: '- '
'The Licensee' or 'You': any natural or legal person who makes any usage of the Work under the terms of the Licence.
'The Licensee' or 'You': any natural or legal person who makes any usage of the Work under the terms of the Licence.
type: Bullet: '- '
'Distribution' or 'Communication': any act of selling, giving, lending, renting, distributing, communicating, transmitting, or otherwise making available, online or offline, copies of the Work or providing access to its essential functionalities at the disposal of any other natural or legal person.
'Distribution' or 'Communication': any act of selling, giving, lending, renting, distributing, communicating, transmitting, or otherwise making available, online or offline, copies of the Work or providing access to its essential functionalities at the disposal of any other natural or legal person.
type: Bullet: '- '
### Scope of the rights granted by the Licence
### Scope of the rights granted by the Licence
type: Plain text
The Licensor hereby grants You a worldwide, royalty-free, non-exclusive, sublicensable licence to do the following, for the duration of copyright vested in the Original Work:
The Licensor hereby grants You a worldwide, royalty-free, non-exclusive, sublicensable licence to do the following, for the duration of copyright vested in the Original Work:
type: Plain text
use the Work in any circumstance and for all usage,
use the Work in any circumstance and for all usage,
type: Bullet: '- '
reproduce the Work,
reproduce the Work,
type: Bullet: '- '
modify the Work, and make Derivative Works based upon the Work,
modify the Work, and make Derivative Works based upon the Work,
type: Bullet: '- '
communicate to the public, including the right to make available or display the Work or copies thereof to the public and perform publicly, as the case may be, the Work,
communicate to the public, including the right to make available or display the Work or copies thereof to the public and perform publicly, as the case may be, the Work,
type: Bullet: '- '
distribute the Work or copies thereof,
distribute the Work or copies thereof,
type: Bullet: '- '
lend and rent the Work or copies thereof,
lend and rent the Work or copies thereof,
type: Bullet: '- '
sublicense rights in the Work or copies thereof.
sublicense rights in the Work or copies thereof.
type: Bullet: '- '
Those rights can be exercised on any media, supports and formats, whether now known or later invented, as far as the applicable law permits so.
Those rights can be exercised on any media, supports and formats, whether now known or later invented, as far as the applicable law permits so.
type: Plain text
In the countries where moral rights apply, the Licensor waives his right to exercise his moral right to the extent allowed by law in order to make effective the licence of the economic rights here above listed.
In the countries where moral rights apply, the Licensor waives his right to exercise his moral right to the extent allowed by law in order to make effective the licence of the economic rights here above listed.
type: Plain text
The Licensor grants to the Licensee royalty-free, non-exclusive usage rights to any patents held by the Licensor, to the extent necessary to make use of the rights granted on the Work under this Licence.
The Licensor grants to the Licensee royalty-free, non-exclusive usage rights to any patents held by the Licensor, to the extent necessary to make use of the rights granted on the Work under this Licence.
type: Plain text
### Communication of the Source Code
### Communication of the Source Code
type: Plain text
The Licensor may provide the Work either in its Source Code form, or as Executable Code. If the Work is provided as Executable Code, the Licensor provides in addition a machine-readable copy of the Source Code of the Work along with each copy of the Work that the Licensor distributes or indicates, in a notice following the copyright notice attached to the Work, a repository where the Source Code is easily and freely accessible for as long as the Licensor continues to distribute or communicate the Work.
The Licensor may provide the Work either in its Source Code form, or as Executable Code. If the Work is provided as Executable Code, the Licensor provides in addition a machine-readable copy of the Source Code of the Work along with each copy of the Work that the Licensor distributes or indicates, in a notice following the copyright notice attached to the Work, a repository where the Source Code is easily and freely accessible for as long as the Licensor continues to distribute or communicate the Work.
type: Plain text
### Limitations on copyright
### Limitations on copyright
type: Plain text
Nothing in this Licence is intended to deprive the Licensee of the benefits from any exception or limitation to the exclusive rights of the rights owners in the Work, of the exhaustion of those rights or of other applicable limitations thereto.
Nothing in this Licence is intended to deprive the Licensee of the benefits from any exception or limitation to the exclusive rights of the rights owners in the Work, of the exhaustion of those rights or of other applicable limitations thereto.
type: Plain text
### Obligations of the Licensee
### Obligations of the Licensee
type: Plain text
The grant of the rights mentioned above is subject to some restrictions and obligations imposed on the Licensee. Those obligations are the following:
The grant of the rights mentioned above is subject to some restrictions and obligations imposed on the Licensee. Those obligations are the following:
type: Plain text
*Attribution right*: The Licensee shall keep intact all copyright,
patent or trademarks notices and all notices that refer to the Licence
and to the disclaimer of warranties. The Licensee must include a copy of
such notices and a copy of the Licence with every copy of the Work
he/she distributes or communicates. The Licensee must cause any
Derivative Work to carry prominent notices stating that the Work has
been modified and the date of modification.
*Attribution right*: The Licensee shall keep intact all copyright,
patent or trademarks notices and all notices that refer to the Licence
and to the disclaimer of warranties. The Licensee must include a copy of
such notices and a copy of the Licence with every copy of the Work
he/she distributes or communicates. The Licensee must cause any
Derivative Work to carry prominent notices stating that the Work has
been modified and the date of modification.
type: Plain text
*Copyleft clause*: If the Licensee distributes or communicates copies of
the Original Works or Derivative Works, this Distribution or
Communication will be done under the terms of this Licence or of a later
version of this Licence unless the Original Work is expressly
distributed only under this version of the Licence --- for example by
communicating 'EUPL v. 1.2 only'. The Licensee (becoming Licensor)
cannot offer or impose any additional terms or conditions on the Work or
Derivative Work that alter or restrict the terms of the Licence.
*Copyleft clause*: If the Licensee distributes or communicates copies of
the Original Works or Derivative Works, this Distribution or
Communication will be done under the terms of this Licence or of a later
version of this Licence unless the Original Work is expressly
distributed only under this version of the Licence --- for example by
communicating 'EUPL v. 1.2 only'. The Licensee (becoming Licensor)
cannot offer or impose any additional terms or conditions on the Work or
Derivative Work that alter or restrict the terms of the Licence.
type: Plain text
*Compatibility clause*: If the Licensee Distributes or Communicates
Derivative Works or copies thereof based upon both the Work and another
work licensed under a Compatible Licence, this Distribution or
Communication can be done under the terms of this Compatible Licence.
For the sake of this clause, 'Compatible Licence' refers to the licences
listed in the appendix attached to this Licence. Should the Licensee's
obligations under the Compatible Licence conflict with his/her
obligations under this Licence, the obligations of the Compatible
Licence shall prevail.
*Compatibility clause*: If the Licensee Distributes or Communicates
Derivative Works or copies thereof based upon both the Work and another
work licensed under a Compatible Licence, this Distribution or
Communication can be done under the terms of this Compatible Licence.
For the sake of this clause, 'Compatible Licence' refers to the licences
listed in the appendix attached to this Licence. Should the Licensee's
obligations under the Compatible Licence conflict with his/her
obligations under this Licence, the obligations of the Compatible
Licence shall prevail.
type: Plain text
*Provision of Source Code*: When distributing or communicating copies of
the Work, the Licensee will provide a machine-readable copy of the
Source Code or indicate a repository where this Source will be easily
and freely available for as long as the Licensee continues to distribute
or communicate the Work. Legal Protection: This Licence does not grant
permission to use the trade names, trademarks, service marks, or names
of the Licensor, except as required for reasonable and customary use in
describing the origin of the Work and reproducing the content of the
copyright notice.
*Provision of Source Code*: When distributing or communicating copies of
the Work, the Licensee will provide a machine-readable copy of the
Source Code or indicate a repository where this Source will be easily
and freely available for as long as the Licensee continues to distribute
or communicate the Work. Legal Protection: This Licence does not grant
permission to use the trade names, trademarks, service marks, or names
of the Licensor, except as required for reasonable and customary use in
describing the origin of the Work and reproducing the content of the
copyright notice.
type: Plain text
### Chain of Authorship
### Chain of Authorship
type: Plain text
The original Licensor warrants that the copyright in the Original Work granted hereunder is owned by him/her or licensed to him/her and that he/she has the power and authority to grant the Licence.
The original Licensor warrants that the copyright in the Original Work granted hereunder is owned by him/her or licensed to him/her and that he/she has the power and authority to grant the Licence.
type: Plain text
Each Contributor warrants that the copyright in the modifications he/she brings to the Work are owned by him/her or licensed to him/her and that he/she has the power and authority to grant the Licence.
Each Contributor warrants that the copyright in the modifications he/she brings to the Work are owned by him/her or licensed to him/her and that he/she has the power and authority to grant the Licence.
type: Plain text
Each time You accept the Licence, the original Licensor and subsequent Contributors grant You a licence to their contributions to the Work, under the terms of this Licence.
Each time You accept the Licence, the original Licensor and subsequent Contributors grant You a licence to their contributions to the Work, under the terms of this Licence.
type: Plain text
### Disclaimer of Warranty
### Disclaimer of Warranty
type: Plain text
The Work is a work in progress, which is continuously improved by numerous Contributors. It is not a finished work and may therefore contain defects or 'bugs' inherent to this type of development. For the above reason, the Work is provided under the Licence on an 'as is' basis and without warranties of any kind concerning the Work, including without limitation merchantability, fitness for a particular purpose, absence of defects or errors, accuracy, non-infringement of intellectual property rights other than copyright as stated in Article 6 of this Licence.
The Work is a work in progress, which is continuously improved by numerous Contributors. It is not a finished work and may therefore contain defects or 'bugs' inherent to this type of development. For the above reason, the Work is provided under the Licence on an 'as is' basis and without warranties of any kind concerning the Work, including without limitation merchantability, fitness for a particular purpose, absence of defects or errors, accuracy, non-infringement of intellectual property rights other than copyright as stated in Article 6 of this Licence.
type: Plain text
This disclaimer of warranty is an essential part of the Licence and a condition for the grant of any rights to the Work.
This disclaimer of warranty is an essential part of the Licence and a condition for the grant of any rights to the Work.
type: Plain text
### Disclaimer of Liability
### Disclaimer of Liability
type: Plain text
Except in the cases of wilful misconduct or damages directly caused to natural persons, the Licensor will in no event be liable for any direct or indirect, material or moral, damages of any kind, arising out of the Licence or of the use of the Work, including without limitation, damages for loss of goodwill, work stoppage, computer failure or malfunction, loss of data or any commercial damage, even if the Licensor has been advised of the possibility of such damage. However, the Licensor will be liable under statutory product liability laws as far such laws apply to the Work.
Except in the cases of wilful misconduct or damages directly caused to natural persons, the Licensor will in no event be liable for any direct or indirect, material or moral, damages of any kind, arising out of the Licence or of the use of the Work, including without limitation, damages for loss of goodwill, work stoppage, computer failure or malfunction, loss of data or any commercial damage, even if the Licensor has been advised of the possibility of such damage. However, the Licensor will be liable under statutory product liability laws as far such laws apply to the Work.
type: Plain text
### 9. Additional agreements
### 9. Additional agreements
type: Plain text
While distributing the Work, You may choose to conclude an additional agreement, defining obligations or services consistent with this Licence. However, if accepting obligations, You may act only on your own behalf and on your sole responsibility, not on behalf of the original Licensor or any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against such Contributor by the fact You have accepted any warranty or additional liability.
While distributing the Work, You may choose to conclude an additional agreement, defining obligations or services consistent with this Licence. However, if accepting obligations, You may act only on your own behalf and on your sole responsibility, not on behalf of the original Licensor or any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against such Contributor by the fact You have accepted any warranty or additional liability.
type: Plain text
### Acceptance of the Licence
### Acceptance of the Licence
type: Plain text
The provisions of this Licence can be accepted by clicking on an icon 'I agree' placed under the bottom of a window displaying the text of this Licence or by affirming consent in any other similar way, in accordance with the rules of applicable law. Clicking on that icon indicates your clear and irrevocable acceptance of this Licence and all of its terms and conditions.
The provisions of this Licence can be accepted by clicking on an icon 'I agree' placed under the bottom of a window displaying the text of this Licence or by affirming consent in any other similar way, in accordance with the rules of applicable law. Clicking on that icon indicates your clear and irrevocable acceptance of this Licence and all of its terms and conditions.
type: Plain text
Similarly, you irrevocably accept this Licence and all of its terms and conditions by exercising any rights granted to You by Article 2 of this Licence, such as the use of the Work, the creation by You of a Derivative Work or the Distribution or Communication by You of the Work or copies thereof.
Similarly, you irrevocably accept this Licence and all of its terms and conditions by exercising any rights granted to You by Article 2 of this Licence, such as the use of the Work, the creation by You of a Derivative Work or the Distribution or Communication by You of the Work or copies thereof.
type: Plain text
### Information to the public
### Information to the public
type: Plain text
In case of any Distribution or Communication of the Work by means of electronic communication by You (for example, by offering to download the Work from a remote location) the distribution channel or media (for example, a website) must at least provide to the public the information requested by the applicable law regarding the Licensor, the Licence and the way it may be accessible, concluded, stored and reproduced by the Licensee.
In case of any Distribution or Communication of the Work by means of electronic communication by You (for example, by offering to download the Work from a remote location) the distribution channel or media (for example, a website) must at least provide to the public the information requested by the applicable law regarding the Licensor, the Licence and the way it may be accessible, concluded, stored and reproduced by the Licensee.
type: Plain text
### Termination of the Licence
### Termination of the Licence
type: Plain text
The Licence and the rights granted hereunder will terminate automatically upon any breach by the Licensee of the terms of the Licence.
The Licence and the rights granted hereunder will terminate automatically upon any breach by the Licensee of the terms of the Licence.
type: Plain text
Such a termination will not terminate the licences of any person who has received the Work from the Licensee under the Licence, provided such persons remain in full compliance with the Licence.
Such a termination will not terminate the licences of any person who has received the Work from the Licensee under the Licence, provided such persons remain in full compliance with the Licence.
type: Plain text
### Miscellaneous
### Miscellaneous
type: Plain text
Without prejudice of Article 9 above, the Licence represents the complete agreement between the Parties as to the Work.
Without prejudice of Article 9 above, the Licence represents the complete agreement between the Parties as to the Work.
type: Plain text
If any provision of the Licence is invalid or unenforceable under applicable law, this will not affect the validity or enforceability of the Licence as a whole. Such provision will be construed or reformed so as necessary to make it valid and enforceable.
If any provision of the Licence is invalid or unenforceable under applicable law, this will not affect the validity or enforceability of the Licence as a whole. Such provision will be construed or reformed so as necessary to make it valid and enforceable.
type: Plain text
The European Commission may publish other linguistic versions or new versions of this Licence or updated versions of the Appendix, so far this is required and reasonable, without reducing the scope of the rights granted by the Licence.
The European Commission may publish other linguistic versions or new versions of this Licence or updated versions of the Appendix, so far this is required and reasonable, without reducing the scope of the rights granted by the Licence.
type: Plain text
New versions of the Licence will be published with a unique version number.
New versions of the Licence will be published with a unique version number.
type: Plain text
All linguistic versions of this Licence, approved by the European Commission, have identical value. Parties can take advantage of the linguistic version of their choice.
All linguistic versions of this Licence, approved by the European Commission, have identical value. Parties can take advantage of the linguistic version of their choice.
type: Plain text
### Jurisdiction
### Jurisdiction
type: Plain text
Without prejudice to specific agreement between parties,
Without prejudice to specific agreement between parties,
type: Plain text
any litigation resulting from the interpretation of this License, arising between the European Union institutions, bodies, offices or agencies, as a Licensor, and any Licensee, will be subject to the jurisdiction of the Court of Justice of the European Union, as laid down in article 272 of the Treaty on the Functioning of the European Union,
any litigation resulting from the interpretation of this License, arising between the European Union institutions, bodies, offices or agencies, as a Licensor, and any Licensee, will be subject to the jurisdiction of the Court of Justice of the European Union, as laid down in article 272 of the Treaty on the Functioning of the European Union,
type: Bullet: '- '
any litigation arising between other parties and resulting from the interpretation of this License, will be subject to the exclusive jurisdiction of the competent court where the Licensor resides or conducts its primary business.
any litigation arising between other parties and resulting from the interpretation of this License, will be subject to the exclusive jurisdiction of the competent court where the Licensor resides or conducts its primary business.
type: Bullet: '- '
### Applicable Law
### Applicable Law
type: Plain text
this Licence shall be governed by the law of the European Union Member State where the Licensor has his seat, resides or has his registered office,
this Licence shall be governed by the law of the European Union Member State where the Licensor has his seat, resides or has his registered office,
type: Bullet: '- '
this licence shall be governed by Belgian law if the Licensor has no seat, residence or registered office inside a European Union Member State.
this licence shall be governed by Belgian law if the Licensor has no seat, residence or registered office inside a European Union Member State.
type: Bullet: '- '
### Appendix
### Appendix
type: Plain text
'Compatible Licences' according to Article 5 EUPL are:
'Compatible Licences' according to Article 5 EUPL are:
type: Plain text
GNU General Public License (GPL) v. 2, v. 3
GNU General Public License (GPL) v. 2, v. 3
type: Bullet: '- '
GNU Affero General Public License (AGPL) v. 3
GNU Affero General Public License (AGPL) v. 3
type: Bullet: '- '
Open Software License (OSL) v. 2.1, v. 3.0
Open Software License (OSL) v. 2.1, v. 3.0
type: Bullet: '- '
Eclipse Public License (EPL) v. 1.0
Eclipse Public License (EPL) v. 1.0
type: Bullet: '- '
CeCILL v. 2.0, v. 2.1
CeCILL v. 2.0, v. 2.1
type: Bullet: '- '
Mozilla Public Licence (MPL) v. 2
Mozilla Public Licence (MPL) v. 2
type: Bullet: '- '
GNU Lesser General Public Licence (LGPL) v. 2.1, v. 3
GNU Lesser General Public Licence (LGPL) v. 2.1, v. 3
type: Bullet: '- '
Creative Commons Attribution-ShareAlike v. 3.0 Unported (CC BY-SA 3.0) for works other than software
Creative Commons Attribution-ShareAlike v. 3.0 Unported (CC BY-SA 3.0) for works other than software
type: Bullet: '- '
European Union Public Licence (EUPL) v. 1.1, v. 1.2
European Union Public Licence (EUPL) v. 1.1, v. 1.2
type: Bullet: '- '
Québec Free and Open-Source Licence --- Reciprocity (LiLiQ-R) or Strong Reciprocity (LiLiQ-R+)
Québec Free and Open-Source Licence --- Reciprocity (LiLiQ-R) or Strong Reciprocity (LiLiQ-R+)
type: Bullet: '- '
The European Commission may update this Appendix to later versions of the above licences without producing a new version of the EUPL, as long as they provide the rights granted in Article 2 of this Licence and protect the covered Source Code from exclusive appropriation.
The European Commission may update this Appendix to later versions of the above licences without producing a new version of the EUPL, as long as they provide the rights granted in Article 2 of this Licence and protect the covered Source Code from exclusive appropriation.
type: Plain text
All other changes or additions to this Appendix require the production of a new EUPL version.
All other changes or additions to this Appendix require the production of a new EUPL version.
type: Plain text