aboutsummaryrefslogtreecommitdiff
path: root/README.rst
blob: 6a0050286d2c8dad8b58cfec06c45f27c9545736 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
======================================
 kerbana - a data management platform
======================================

kerbana is a platform that receives data from MQTT, saves it into RRDs
(Round Robin Databases) and generates and serves user-configured graphs.

It is designed for ease of hosting and packaging inside distributions,
and it's meant to be especially suitable for small installations with a
few users. Think environmental monitoring at home, not data monitoring
inside a datacenter (there are already many other versatile, if complex,
solutions for that usecase).

The name comes from kerbaną_, cognate of γράφω_

.. _kerbaną: https://en.wiktionary.org/wiki/Reconstruction:Proto-Germanic/kerban%C4%85
.. _γράφω: https://en.wiktionary.org/wiki/%CE%B3%CF%81%CE%AC%CF%86%CF%89#Ancient_Greek

Installation
------------


Contributing
------------

Running Tests
-------------

To run the MQTT integration tests, create a file ``kerbana_tests.toml``
in the base directory with the variable ``MQTT_SERVER`` pointing to a
valid mqtt server you can use.

License
-------

Copyright (C) 2023 Elena Grandi

This program is free software: you can redistribute it and/or modify it
under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 of the License, or (at
your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.