Skip to content
Snippets Groups Projects
Verified Commit e120774a authored by Tamas Gal's avatar Tamas Gal :speech_balloon:
Browse files

Update README

parent 4a66abe5
No related branches found
No related tags found
No related merge requests found
Pipeline #62193 passed
......@@ -6,13 +6,15 @@ Online monitoring suite for the KM3NeT neutrino detectors.
## Requirements
- Docker and Docker Compose
- Docker
Everything is containerised, so no need to install other software. The version
of the pre-built Docker images is determined by the `KM3MON_VERSION` variable
of the pre-built Docker base images is determined by the `KM3MON_VERSION` variable
in the `.env` file (see `example.env`). Ideally, you want to keep the same version
as the checked out Git tag. If you want to experiment around, feel free to
uncomment the `build` lines in the `docker-compose.yml`.
as the checked out Git tag, but scripts which are not part of the base images can
be updated independently. The `backend` for example contains a lot of Python scripts
which can easily be updated without touching the base image, that only consists of
a Python installation with the required packages.
## Setup
......@@ -57,6 +59,13 @@ to a number of lines `--tail=N`, e.g.
The `SERVICE_NAME` can be any of `backend`, `frontend`, `ligier`, `ligiermirror`,
`ligierlogmirror`, `reco` or `livelog`.
## Back-end configuration file
The file `backend/pipeline.toml` is the heart of most monitoring processes and
can be used to set different kind of parameters, like plot attributes or ranges.
That configuration file is accessibe within each Python script under
`backend/scripts`.
The monitoring back-end is running inside a Docker container and controlled
by `supervisord`. You can enter the `backend` with
......@@ -101,10 +110,13 @@ a group of processes. Use the ``supervisorctl help`` to find out more and
``supervisorctl help COMMAND`` to get a detailed description of the
corresponding command.
## Back-end configuration file
## Frontent
The file `backend/pipeline.toml` is the heart of all monitoring processes and
can be used to set different kind of parameters, like plot attributes or ranges.
The frontend is a simple webserver and uses HTML templates to render the websites.
The layout of the plots can be changed in `frontend/app/routes.py` using nested lists.
Each URL endpoint can be assigned to a specific function which uses a specific template
to render the actual page. The templates for the base layout (incuding the menubar) and
each page are under `frontend/app/templates`.
## Chatbot
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment