diff options
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 28 |
1 files changed, 26 insertions, 2 deletions
@@ -42,7 +42,7 @@ Perl Dependencies db-infoscreen depends on a set of Perl modules which are documented in `cpanfile`. After installing the dependencies mentioned above, you can use -carton or cpanminus to install Perl depenencies locally. +carton or cpanminus to install Perl dependencies locally. In the project root directory (where `cpanfile` resides), run either @@ -101,7 +101,7 @@ pass requests for db-infoscreen to the appropriate port. See the You can run the app using a Mojo::Server of your choice, e.g. **perl index.pl daemon -m production** (quick&dirty, does not respect all variables) -or **hypnotad** (recommended). A systemd unit example is provided in +or **hypnotoad** (recommended). A systemd unit example is provided in `examples/db-infoscreen.service`. All code in this repository may be used under the terms of the BSD-2-Clause @@ -132,3 +132,27 @@ Resource requirements depend on usage. For a few requests per second, about 200MB (600k inodes) cache and one or two CPU cores should be sufficient. db-infoscreen typically needs 50MB RAM per worker process, though calculating with 100MB per worker is recommended to leave a safety margin. + +Licensing +--- + +This project follows the REUSE specification. The copyright of individual files +is documented in the file's header or in .reuse/dep5. The referenced licenses +are stored in the LICENSES directory. + +The program code of db-infoscreen is licensed under the terms of the GNU AGPL +v3. HTML Templates and SASS/CSS layout are licensed under the terms of the +2-Clause BSD License. This means that you are free to host your own +db-infoscreen instance, both for personal/internal and public use, under the +following conditions. + +* You are free to change HTML/SASS/CSS templates as you see fit (though you + must not remove the copyright headers). +* If you make changes to the program code, that is, a file below lib/ or a + db-infoscreen javascript file below public/static/js/, you must make those + changes available to the public. + +The easiest way of making changes available is by maintaining a public fork of +the Git repository. A tarball is also acceptable. Please change `source_url` in +`lib/DBInfoscreen.pm` to point to your Git repository / source archive if you +are using a version with custom changes. |