aboutsummaryrefslogtreecommitdiff
path: root/README.rst
blob: e932f28c8f31b7e34ef69cf7c6b7e9aacd44eb5e (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
50
51
52
RWA.Support.SessionService
==========================
D-Bus service, written in Python 3,
for managing sessions with Django and as a backend for GUI applications

Getting started
---------------

Step 1: Clone repository
^^^^^^^^^^^^^^^^^^^^^^^^

Clone the source code repository via Git (sudo apt install git).

>>> $ git clone https://gitlab.das-netzwerkteam.de/remotewebapp/rwa.support.sessionservice.git

Step 2: Build documentation
^^^^^^^^^^^^^^^^^^^^^^^^^^^

Go into the docs directory and build the html files.

>>> $ cd rwa.support.sessionservice/docs

Use the `Makefile` to build documentation with Sphinx.

>>> $ make html

You have now a bunch of HTML files in `_build/html`.
You can make the files available via a small local webserver. We are using PHP as an example.

You can also just open the `_build/html/index.html` file in your browser (if your browser is allowed to access those files).

>>> $ php -S localhost:8080 -t "_build/html"

Step 3: Follow installation instructions there
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

http://localhost:8080/admin/01_installation.html


Licence
-------

::

  Copyright © 2020-2023 Jonathan Weth <dev@jonathanweth.de>
  Copyright © 2020-2023 Mike Gabriel <mike.gabriel@das-netzwerkteam.de>
  Copyright © 2020-2023 Daniel Teichmann <daniel.teichmann@das-netzwerkteam.de>

  Licenced under the GPL, version 2.0 or later

Please see the LICENCE file accompanying this distribution for the
full licence text.