From c63e4627ec0613f7fcc6d9a936c14a64a2655b33 Mon Sep 17 00:00:00 2001
From: Jonathan Weth <git@jonathanweth.de>
Date: Mon, 27 Jul 2020 15:31:27 +0200
Subject: Add documentation

---
 docs/admin/00_index.rst        |  7 +++++++
 docs/admin/01_installation.rst | 45 ++++++++++++++++++++++++++++++++++++++++++
 docs/admin/02_config.rst       |  4 ++++
 docs/admin/03_testing.rst      | 24 ++++++++++++++++++++++
 4 files changed, 80 insertions(+)
 create mode 100644 docs/admin/00_index.rst
 create mode 100644 docs/admin/01_installation.rst
 create mode 100644 docs/admin/02_config.rst
 create mode 100644 docs/admin/03_testing.rst

(limited to 'docs/admin')

diff --git a/docs/admin/00_index.rst b/docs/admin/00_index.rst
new file mode 100644
index 0000000..a5587b8
--- /dev/null
+++ b/docs/admin/00_index.rst
@@ -0,0 +1,7 @@
+Installation and configuration
+==============================
+
+.. toctree::
+   :glob:
+
+   *
diff --git a/docs/admin/01_installation.rst b/docs/admin/01_installation.rst
new file mode 100644
index 0000000..064cce9
--- /dev/null
+++ b/docs/admin/01_installation.rst
@@ -0,0 +1,45 @@
+Installation
+============
+
+We recommend to use Debian-based systems for first tests.
+Later there will be supported more operating systems,
+but for now you should start with a Debian-like system.
+
+As a first step use ``apt`` to install the core dependencies as debian packages:
+
+::
+
+	sudo apt install python3 python3-venv python3-pip x11vnc libcairo2-dev libdbus-glib-1-dev libgirepository1.0-dev wget
+
+To bundle the further dependencies of the D-Bus daemon,
+we use Poetry to get them from the PyPI. So, install Poetry using PIP:
+
+::
+
+	sudo pip3 install poetry
+
+Then use poetry to get all packages from PyPI necessary for running the service
+(be sure that you are in the source code directory):
+
+::
+
+	poetry install
+
+
+Now you can continue with :doc:`02_config`.
+
+.. warning::
+
+    As Poetry also manages your virtual environment, you must use
+    ``poetry run`` everytime if you want to start something in your environment:
+
+    **Example:**
+
+    ::
+
+        poetry run python test_client.py
+
+        # or
+
+        poetry run python tox
+
diff --git a/docs/admin/02_config.rst b/docs/admin/02_config.rst
new file mode 100644
index 0000000..8666afa
--- /dev/null
+++ b/docs/admin/02_config.rst
@@ -0,0 +1,4 @@
+Configuration
+=============
+
+TBA.
\ No newline at end of file
diff --git a/docs/admin/03_testing.rst b/docs/admin/03_testing.rst
new file mode 100644
index 0000000..ab427bc
--- /dev/null
+++ b/docs/admin/03_testing.rst
@@ -0,0 +1,24 @@
+Test your installation
+======================
+
+To ensure that your D-Bus daemon is installed and configured correctly
+and can work with the RWA server,
+you can use the test client provided in the Session Service package:
+
+
+Firstly, start the D-Bus daemon in foreground (e. g. in a second terminal),
+so the client can interact with it:
+
+
+::
+
+    poetry run python service.py
+
+Now you can use the test client to start a test session
+and register it in your RWA server. It will return a PIN and
+a URL in JSON which you can use to connect to the remote session
+in the web browser:
+
+::
+
+    poetry run python test_client.py
\ No newline at end of file
-- 
cgit v1.2.3