From 370270eaf3ad961846de878f647e61c42362cbbe Mon Sep 17 00:00:00 2001
From: puls200 <schick@textbausteine.net>
Date: Mon, 18 Sep 2023 14:57:29 +0200
Subject: [PATCH] added ad readme for the role editor

---
 src/RoleEditor/ReadMe.md | 43 ++++++++++++++++++++++++++++++++++++++++
 1 file changed, 43 insertions(+)
 create mode 100644 src/RoleEditor/ReadMe.md

diff --git a/src/RoleEditor/ReadMe.md b/src/RoleEditor/ReadMe.md
new file mode 100644
index 0000000..f130a9b
--- /dev/null
+++ b/src/RoleEditor/ReadMe.md
@@ -0,0 +1,43 @@
+# Role Editor (Administration tool)
+
+![logo](../../misc/logo_bremen_calling.png)
+___
+
+## Purpose
+
+### Users and participants
+
+* Create and administrate participants (companies) in the system
+* Create users and assign them to participants
+* Create securables
+* Create mappings between users and securables (role management)
+
+### Berths
+
+* Create / edit / set mark deleted of berths (Liegeplätze)
+* Excel mass import for berths
+
+### Ships
+
+* Create / edit / set mark deleted of ships
+* Excel mass import for ships
+
+## Prerequisites
+
+### Installation
+
+### SSH tunnel for database access
+
+The database access works directly for everyone working with the tool. This means no remote access is possible since the server is configured to allow only local clients. Therefore a SSH tunnel must be used that maps the remote database server port to a local port.
+
+[Setup of a ssh tunnel via putty](https://www.heise.de/tipps-tricks/SSH-Tunnel-nutzen-so-geht-s-4320041.html.)
+
+For credentials please contact me directly.
+
+### RoleEditor client
+
+There will be no ClickOnce deployment for the role editor, since it is only intended for internal use by a few individuals.
+For each release a ZIP file will be prepared that will be hosted on the site.
+
+
+