docs(servereye): 📝 Add servereye admin guide

.config/spelling.txt

@@ -18,10 +18,10 @@ CSS
 CSV
 CVE
 DESK-456
-DSN
 docupike
 docupike.cloud
 dropdown
+DSN
 duplicatable
 DVCS
 e.g.
@@ -67,6 +67,7 @@ resized
 scrollable
 searchbar
 SEO
+servereye
 sexualized
 ShareAlike
 subdomain

docs/admin/servereye.md

@@ -1,14 +1,27 @@
 ---
-title: servereye Add-on
-description: Basics for using the servereye Add-on
+title: servereye configuration
+description: Admin basics for using the servereye Add-on in Docupike
 lang: en
 ---
 
-## servereye Add-on configuration
+## servereye with docupike
 
-A configuration is not needed, because each instance requested via servereye is passed ready configured.
+The servereye Add-on is designed to synchronize all data from servereye to docupike. The Add-on is passed ready configured.
 
-## First login
+## Overview
+
+-   Add-on configuration is not needed
+-   The synchronization is executed 3 times a day
+-   The synchronization can be triggered manually
+-   Customer companies are synchronized as tenant
+-   User are synchronized as user
+-   User are assigned to tenant/s
+-   Each user is assigned to group "servereye reader"
+-   The group "servereye reader" is only permitted to read data
+-   Objects are synchronized for each tenant
+-   Categories are synchronized for each Object
+
+## Login
 
 This gives you an oversight how-to login for the first time.<br>
 You can access your docupike.cloud instance with the following URL schema:
@@ -23,35 +36,44 @@ Point your Web browser to the Web UI of docupike to see the login screen:
 
 [helpdesk]: mailto:[email protected]
 
+You can log in either through servereye or by using your username and password. This will grant you access to the default tenant, which is not associated with any specific customer.
+
 !!! info "No default login"
-    docupike has no default login like an admin user called `admin` with a trivial password like `admin`. Instead, during the installation the first individual user will be created automatically. This user has the admin role with all rights and permissions.
+    docupike has no default login. Instead, during the installation the first individual user will be created automatically. This user has the admin role with all rights and permissions.
 
 !!! info "Reset password"
-    If you forgot your password or simply need to change it, you can contact our support. If wrong credentials are used for login, you will also be shown a link to contact our support, who will be pleased to help you.
-
-
-
-
-
-
-Docupike with Serverye
-Serverye integration für MSPs und Docupike
-Der MSP fragt docupike an und bekommt dann eine instanz
-Pro Kunde des MSP wird ein Mandant erstellt.
-Der Sync läuft alle 6 Stunden
-Objekttyp:
-- Servereye import
-Kategorien:
-- CPU
-- IP
-- Memory
-- Model
-- Storage Devices
-- Storage Volumes
-Die Einträge in den aufgeführten Kategorien werden durch den Servereye sync aktualisiert. Manuelle Änderungen an synchronisierten Einträgen werden überschrieben.
-Es gibt Mapping zu Objekten und Kategorie Einträgen.
-## OAUTH
-Benutzer werden automatisch synchronisiert und dem Mandanten zugewiesen. Matching via E-Mail.
-Benutzer erhalten standard Rechte auf den Mandant(Organisation) und Leserechte auf alle Objekte darin.
-Synchronisierte Benutzer haben keine Rechte!
-Widget zeigt letzten sync und einen link zum servereye objekt
+    If you forgot your password or simply need to change it, you can use the `Reset Password` Button on the login Screen.
+
+After the login you will find a, with servereye, synchronized docupike. The servereye Add-on is already configured and does not need any further configuration.
+
+## Rights in docupike
+
+As admin you have the capability to view all tenants and configure docupike.
+
+However, synchronized users possess only the rights to view their designated tenant, **with permissions limited to reading all objects and categories**. You have the option to assign create, edit and additional [permissions](rights-and-permissions.md) as needed.
+
+## Tenants
+
+A separate tenant is created for each customer. Access these tenants through the dropdown menu located at the top left, next to the Docupike logo.
+
+## User
+
+Each user, which have at least access to one tenant, is synchronized from servereye. The [Users](users-groups-roles.md) can be found via `Settings > User management >> Users`. Users are matched via E-Mail address.
+
+## Objects and categories
+
+Objects are imported into the class **servereye import**, in the corresponding tenant. Users are able to change the class of the objects.
+
+Categories which are synchronized are **CPU**, **IP**, **Memory**, **Model**, **Storage Devices** and **Storage Volumes**.
+The entries in the listed categories undergo updates through the servereye sync. **Manual alterations to synchronized entries are overridden**, as there is mapping to both objects and category entries.
+
+## servereye synchronization
+
+You can check the servereye synchronization via `Add-ons > servereye settings`. Here you will find a **Sync**, **Refresh** and **Recent imports** button.
+The **Sync** button will execute a complete Sync for user and objects.The **Refresh** button refreshes the page, while the **Recent Imports** button opens the "servereye Import" class view.
+
+## Widget
+
+Docupike has a [Widget](../user/finder/widgets.md) view.
+
+There is a servereye widget, which displays "Last sync" with date/time and a Link to the object in servereye.

mkdocs.yml

@@ -127,6 +127,7 @@ nav:
       - Export Data: admin/export-data.md
       - Rights and permissions: admin/rights-and-permissions.md
       - Users, groups and roles: admin/users-groups-roles.md
+      - servereye: admin/servereye.md
   - Developer guide:
       - API: dev/api.md
       - Add-ons: