From 786c9fdad173154b8ad878ae8e3038a33377b5ed Mon Sep 17 00:00:00 2001
From: Jan Ulrich Hasecke <jan.ulrich@hasecke.com>
Date: Mon, 04 Nov 2019 16:05:08 +0100
Subject: [PATCH] Kapitel Referenz angefangen, todos und graphviz in conf
---
source/referenz/webpaket/dateien-paket-admin.rst | 4 +
source/referenz/webpaket/index.rst | 27 +++---
source/referenz/webpaket/verzeichnisebenen-domain-admin.rst | 78 +++++++++++-------
source/referenz/webpaket/verzeichnisse.rst | 19 ----
source/referenz/webpaket/verzeichnisebenen-paket-admin.rst | 37 +++++----
source/index.rst | 8 -
source/referenz/webpaket/speicherbelegung.rst | 6
source/conf.py | 11 ++
source/einstieg/webspace.rst | 2
source/referenz/webpaket/verzeichnisebenen-email-nutzer.rst | 7 +
10 files changed, 110 insertions(+), 89 deletions(-)
diff --git a/source/conf.py b/source/conf.py
index 0763d74..585590e 100644
--- a/source/conf.py
+++ b/source/conf.py
@@ -42,7 +42,11 @@
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
+ 'sphinx.ext.todo',
+ 'sphinx.ext.graphviz'
]
+
+todo_include_todos = True
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
@@ -72,7 +76,7 @@
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
-latex_basename = 'Software-Dokumentation-mit-Sphinx-%s.tex' % changesetid
+latex_basename = 'Hostsharing-Benutzerhandbuch-%s.tex' % changesetid
latex_engine = 'lualatex'
@@ -120,6 +124,11 @@
latex_show_urls = 'footnote'
latex_use_xindy = False
+latex_documents = [
+ ('index', latex_basename, 'Hostsharing Benutzerhandbuch',
+ 'Hostsharing eG', 'manual'),
+ ]
+
def setup(app):
app.add_object_type('role', 'role',
objname='Rolle',
diff --git a/source/einstieg/webspace.rst b/source/einstieg/webspace.rst
index ece8cf8..5f7943f 100644
--- a/source/einstieg/webspace.rst
+++ b/source/einstieg/webspace.rst
@@ -14,6 +14,8 @@
In unserem Beispiel ist das :file:`xyz00.hostsharing.net`.
Nach dem Einloggen finden Sie die im nächsten Abschnitt beschriebene Ordnerstruktur vor.
+.. _kap-einstieg-ordnerstruktur:
+
Ordnerstruktur
==============
diff --git a/source/index.rst b/source/index.rst
index 8872ee9..c287dea 100644
--- a/source/index.rst
+++ b/source/index.rst
@@ -41,10 +41,6 @@
glossar
+.. only:: html
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
+ * :ref:`genindex`
diff --git a/source/referenz/webpaket/dateien-paket-admin.rst b/source/referenz/webpaket/dateien-paket-admin.rst
index 00bfa3a..3b0a89a 100644
--- a/source/referenz/webpaket/dateien-paket-admin.rst
+++ b/source/referenz/webpaket/dateien-paket-admin.rst
@@ -1,3 +1,7 @@
+.. _kap-dateien-pa:
+
=========================
Initial angelegte Dateien
=========================
+
+.. todo:: Kapitel schreiben
\ No newline at end of file
diff --git a/source/referenz/webpaket/index.rst b/source/referenz/webpaket/index.rst
index 9d129ca..146aa66 100644
--- a/source/referenz/webpaket/index.rst
+++ b/source/referenz/webpaket/index.rst
@@ -10,26 +10,23 @@
Die Bezeichnung besteht aus einem frei wählbaren, dreistelligen Präfix und einem zweistelligen Zähler (z.B xyz00).
Ableitend ergibt sich aus der Vergabe des Paket-Präfix:
-* der Name des :doc:`Paketadmins<../benutzer/paket-admin>` xyz00
+* der Name des :role:`Paket-Admins <Paket-Admin>` xyz00
* das Paketverzeichnis \ ``/home/pacs/xyz00/``\
* die :doc:`Paket-Sub-Domain<../domain/paket-subdomain>` xyz00.hostsharing.net
Ein Web-Paket kann enthalten:
-* Nutzer mit unterschiedlichen Rollen (z.B. :doc:`E-Mail-<../benutzer/userohneshell>`, :doc:`Domain-<../benutzer/domain-admin>` oder :doc:`Datenbank-Nutzer<../datenbanken/datenbanken-nutzer>`)
-* :doc:`Datenbanken<../datenbanken/index>`
-* :doc:`Domains<../domain/index>`
-
-
-Inhalt:
+* die Verzeichnisse von Benutzern, deren Struktur von der jeweiligen Rolle des Benutzers abhängig ist
+* die :doc:`Datenbanken<../datenbanken/index>`
+* die :doc:`Domains<../domain/index>`
.. toctree::
- :maxdepth: 1
-
- verzeichnisse
- verzeichnisebenen-paket-admin
- verzeichnisebenen-domain-admin
- verzeichnisebenen-email-nutzer
- dateien-paket-admin
- speicherbelegung
+ :maxdepth: 1
+
+ verzeichnisse
+ verzeichnisebenen-paket-admin
+ verzeichnisebenen-domain-admin
+ verzeichnisebenen-email-nutzer
+ dateien-paket-admin
+ speicherbelegung
diff --git a/source/referenz/webpaket/speicherbelegung.rst b/source/referenz/webpaket/speicherbelegung.rst
index b0566ed..7decfae 100644
--- a/source/referenz/webpaket/speicherbelegung.rst
+++ b/source/referenz/webpaket/speicherbelegung.rst
@@ -8,12 +8,12 @@
vorhandene Dateien und temporäre Daten im Verzeichnis ``/tmp``.
Die Speicherbegrenzung für ein Web-Paket ist unter Linux durch eine Quota
-für die Gruppe xyz00 realisiert. Die aktuelle Belegung der Quota
+für die Gruppe ``xyz00`` realisiert. Die aktuelle Belegung der Quota
läßt sich mit dem Kommando
.. code-block:: console
- quota -gs
+ $ quota -gs
ermitteln. Die Ausgabe
@@ -21,7 +21,7 @@
Disk quotas for group xyz00 (gid 999999):
Filesystem space quota limit grace files quota limit grace
- /dev/vda2 5587M 6144M 9216M 103k 6292k 6292k
+ /dev/vda2 5587M 6144M 9216M 103k 6292k 6292k
bedeutet:
diff --git a/source/referenz/webpaket/verzeichnisebenen-domain-admin.rst b/source/referenz/webpaket/verzeichnisebenen-domain-admin.rst
index 92d75ec..c751aee 100644
--- a/source/referenz/webpaket/verzeichnisebenen-domain-admin.rst
+++ b/source/referenz/webpaket/verzeichnisebenen-domain-admin.rst
@@ -1,43 +1,59 @@
=============================
Verzeichnisebene Domain-Admin
=============================
-Das Home-Verzeichnis des :doc:`Domain-Admins<../benutzer/domain-admin>` umfasst folgende Verzeichnisse:
-+-----------------+-----------+--------+---------+----------------------------------------------------------------------------+
-| Berechtigungen | Nutzer | Gruppe | Ordner | Erläuterung |
-+=================+===========+========+=========+============================================================================+
-| dr-xr-x--T | httpd | xyz00 | doms | Ablage der in diesem Web-Paket aufgeschaltenen Domains dieses Domain-Admin.|
-+-----------------+-----------+--------+---------+----------------------------------------------------------------------------+
-| drwx------ | xyz00-abc | xyz00 | Maildir | Mailordner des Domain-Admin. |
-+-----------------+-----------+--------+---------+----------------------------------------------------------------------------+
+Das Home-Verzeichnis des :role:`Domain-Admins <Domain-Admin>` umfasst folgende Verzeichnisse:
+
+
+.. tabularcolumns:: llllL
+
+.. table:: Verzeichnisstruktur des Domain-Admin
+
+ +----------------+-----------+--------+---------+------------------------------------------+
+ | Berechtigungen | Nutzer | Gruppe | Ordner | Erläuterung |
+ +================+===========+========+=========+==========================================+
+ | dr-xr-x--T | httpd | xyz00 | doms | Ablage der Domains dieses Domain-Admins. |
+ +----------------+-----------+--------+---------+------------------------------------------+
+ | drwx------ | xyz00-abc | xyz00 | Maildir | Mailordner des Domain-Admin. |
+ +----------------+-----------+--------+---------+------------------------------------------+
Unterhalb des Ordners *doms* findet sich für jede Domain ein weiterer Ordner mit dem Namen der Domain, zum Beispiel *example.com*, und darin befindet sich die Verzeichnisstruktur für die jeweilige Domain:
+.. raw:: latex
-+----------------+-----------+--------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Berechtigungen | Nutzer | Gruppe | Ordner | Erläuterung |
-+================+===========+========+=============+===========================================================================================================================================================+
-| drwxr-xr-x | xyz00-abc | xyz00 | cgi | Ablage externer Software zur Generierung dynamischer Webseiten in einem Webserver. |
-+----------------+-----------+--------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
-| drwxr-xr-x | xyz00-abc | xyz00 | cgi-ssl | Ablage externer Software zur Generierung dynamischer Webseiten, die verschlüsselt ausgeliefert werden (siehe auch :doc:`TLS</referenz/tls/index>`). |
-+----------------+-----------+--------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
-| drwxr-xr-x | xyz00-abc | xyz00 | fastcgi | Ablage externer Software zur Generierung dynamischer Webseiten in einem Webserver. |
-+----------------+-----------+--------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
-| drwxr-xr-x | xyz00-abc | xyz00 | fastcgi-ssl | Ablage externer Software zur Generierung dynamischer Webseiten, die verschlüsselt ausgeliefert werden (siehe auch :doc:`TLS</referenz/tls/index>`). |
-+----------------+-----------+--------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
-| drwxr-xr-x | xyz00-abc | xyz00 | htdocs | Ablage für die Daten einer Webseite, wenn diese unverschlüsselt ausgeliefert werden soll. |
-+----------------+-----------+--------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
-| drwxr-xr-x | xyz00-abc | xyz00 | subs | Ablage für Sub-Domain aus htdocs, wenn diese unverschlüsselt ausgeliefert werden soll. |
-+----------------+-----------+--------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
-| drwxr-xr-x | xyz00-abc | xyz00 | htdocs-ssl | Ablage für die Daten einer Webseite, wenn diese verschlüsselt ausgeliefert werden soll (siehe auch :doc:`TLS</referenz/tls/index>`). |
-+----------------+-----------+--------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
-| drwxr-xr-x | xyz00-abc | xyz00 | subs-ssl | Ablage für Sub-Domain aus htdocs-ssl, wenn diese verschlüsselt ausgeliefert werden soll. |
-+----------------+-----------+--------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
-| drwxr-xr-x | xyz00-abc | xyz00 | etc | Ablage für domaineigene Konfigurationsdateien (z.B. eigenes :doc:`Zonefile</referenz/zonefile/index>`). |
-+----------------+-----------+--------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
-| drwxr-xr-x | xyz00-abc | xyz00 | var | Ablage für Logfiles. |
-+----------------+-----------+--------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
+ \begin{small}
+.. tabularcolumns:: llllL
+.. table:: Verzeichnisstruktur einer Domain
+ +----------------+-----------+--------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
+ | Berechtigungen | Nutzer | Gruppe | Ordner | Erläuterung |
+ +================+===========+========+=============+=====================================================================================================================================================+
+ | drwxr-xr-x | xyz00-abc | xyz00 | cgi | Ablage externer Software zur Generierung dynamischer Webseiten in einem Webserver. |
+ +----------------+-----------+--------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
+ | drwxr-xr-x | xyz00-abc | xyz00 | cgi-ssl | Ablage externer Software zur Generierung dynamischer Webseiten, die verschlüsselt ausgeliefert werden (siehe auch :doc:`TLS</referenz/tls/index>`). |
+ +----------------+-----------+--------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
+ | drwxr-xr-x | xyz00-abc | xyz00 | fastcgi | Ablage externer Software zur Generierung dynamischer Webseiten in einem Webserver. |
+ +----------------+-----------+--------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
+ | drwxr-xr-x | xyz00-abc | xyz00 | fastcgi-ssl | Ablage externer Software zur Generierung dynamischer Webseiten, die verschlüsselt ausgeliefert werden (siehe auch :doc:`TLS</referenz/tls/index>`). |
+ +----------------+-----------+--------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
+ | drwxr-xr-x | xyz00-abc | xyz00 | htdocs | Ablage für die Daten einer Webseite, wenn diese unverschlüsselt ausgeliefert werden soll. |
+ +----------------+-----------+--------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
+ | drwxr-xr-x | xyz00-abc | xyz00 | subs | Ablage für Sub-Domain aus htdocs, wenn diese unverschlüsselt ausgeliefert werden soll. |
+ +----------------+-----------+--------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
+ | drwxr-xr-x | xyz00-abc | xyz00 | htdocs-ssl | Ablage für die Daten einer Webseite, wenn diese verschlüsselt ausgeliefert werden soll (siehe auch :doc:`TLS</referenz/tls/index>`). |
+ +----------------+-----------+--------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
+ | drwxr-xr-x | xyz00-abc | xyz00 | subs-ssl | Ablage für Sub-Domain aus htdocs-ssl, wenn diese verschlüsselt ausgeliefert werden soll. |
+ +----------------+-----------+--------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
+ | drwxr-xr-x | xyz00-abc | xyz00 | etc | Ablage für domaineigene Konfigurationsdateien (z.B. eigenes :doc:`Zonefile</referenz/zonefile/index>`). |
+ +----------------+-----------+--------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
+ | drwxr-xr-x | xyz00-abc | xyz00 | var | Ablage für Logfiles. |
+ +----------------+-----------+--------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
+
+.. raw:: latex
+
+ \end{small}
+
+Die Verzeichnisstruktur ist auch in :numref:`kap-einstieg-ordnerstruktur` beschrieben.
diff --git a/source/referenz/webpaket/verzeichnisebenen-email-nutzer.rst b/source/referenz/webpaket/verzeichnisebenen-email-nutzer.rst
index 0a6bba0..9118da0 100644
--- a/source/referenz/webpaket/verzeichnisebenen-email-nutzer.rst
+++ b/source/referenz/webpaket/verzeichnisebenen-email-nutzer.rst
@@ -1,7 +1,12 @@
==============================
Verzeichnisebene E-Mail-Nutzer
==============================
-Das Home-Verzeichnis des :doc:`E-Mail-Nutzers<../benutzer/userohneshell>` umfasst folgende Verzeichnisse:
+
+Das Home-Verzeichnis des :role:`E-Mail-Benutzers<E-Mail-Benutzer>` umfasst folgende Verzeichnisse:
+
+.. tabularcolumns:: llllL
+
+.. table:: Verzeichnisstruktur eines E-Mail-Benutzers
+-----------------+-------------+--------+---------+--------------------------------+
| Berechtigungen | Nutzer | Gruppe | Ordner | Erläuterung |
diff --git a/source/referenz/webpaket/verzeichnisebenen-paket-admin.rst b/source/referenz/webpaket/verzeichnisebenen-paket-admin.rst
index 57a5136..bfcdf96 100644
--- a/source/referenz/webpaket/verzeichnisebenen-paket-admin.rst
+++ b/source/referenz/webpaket/verzeichnisebenen-paket-admin.rst
@@ -1,22 +1,27 @@
===========================
Verzeichnisebene Paketadmin
===========================
-Das Home-Verzeichnis des :doc:`Paket-Admins<../benutzer/paket-admin>` umfasst folgende Verzeichnisse:
-+-----------------+--------+---------+----------+--------------------------------------------------------------------------+
-| Berechtigungen | Nutzer | Gruppe | Ordner | Erläuterung |
-+=================+========+=========+==========+==========================================================================+
-| drwx----- | xyz00 | xyz00 | .bak | Ablage komprimierter Backups der Datenbanken und Cronjobs. |
-+-----------------+--------+---------+----------+--------------------------------------------------------------------------+
-| dr-xr-x--T | httpd | xyz00 | doms | Ablage der Paketdomain xyz00.hostsharing.net. |
-+-----------------+--------+---------+----------+--------------------------------------------------------------------------+
-| drwx------ | xyz00 | xyz00 | etc | Ablage für eigene Konfigurationsdateien. |
-+-----------------+--------+---------+----------+--------------------------------------------------------------------------+
-| drwxr-xr-x | xyz00 | xyz00 | users | Ablage der angelegten Nutzer |
-+-----------------+--------+---------+----------+--------------------------------------------------------------------------+
-| drwxr-x--- | xyz00 | xyz00 | var | Ablage von Logfiles (z.B. Web-Logs, Traffic-Logs) |
-+-----------------+--------+---------+----------+--------------------------------------------------------------------------+
-| drwx------ | xyz00 | xyz00 | Maildir | Mailordner des :doc:`Paket-Admin</referenz/benutzer/paket-admin>`.|
-+-----------------+--------+---------+----------+--------------------------------------------------------------------------+
+Das Home-Verzeichnis des :role:`Paket-Admins<Paket-Admin>` umfasst folgende Verzeichnisse:
+
+.. tabularcolumns:: llllL
+
+.. table:: Verzeichnisstruktur des Paket-Admins
+
+ +-----------------+--------+---------+----------+--------------------------------------------------------------------------+
+ | Berechtigungen | Nutzer | Gruppe | Ordner | Erläuterung |
+ +=================+========+=========+==========+==========================================================================+
+ | drwx----- | xyz00 | xyz00 | .bak | Ablage komprimierter Backups der Datenbanken und Cronjobs. |
+ +-----------------+--------+---------+----------+--------------------------------------------------------------------------+
+ | dr-xr-x--T | httpd | xyz00 | doms | Ablage der Paketdomain xyz00.hostsharing.net. |
+ +-----------------+--------+---------+----------+--------------------------------------------------------------------------+
+ | drwx------ | xyz00 | xyz00 | etc | Ablage für eigene Konfigurationsdateien. |
+ +-----------------+--------+---------+----------+--------------------------------------------------------------------------+
+ | drwxr-xr-x | xyz00 | xyz00 | users | Ablage der angelegten Nutzer |
+ +-----------------+--------+---------+----------+--------------------------------------------------------------------------+
+ | drwxr-x--- | xyz00 | xyz00 | var | Ablage von Logfiles (z.B. Web-Logs, Traffic-Logs) |
+ +-----------------+--------+---------+----------+--------------------------------------------------------------------------+
+ | drwx------ | xyz00 | xyz00 | Maildir | Mailordner des :role:`Paket-Admin`. |
+ +-----------------+--------+---------+----------+--------------------------------------------------------------------------+
diff --git a/source/referenz/webpaket/verzeichnisse.rst b/source/referenz/webpaket/verzeichnisse.rst
index 43bca22..7c79e15 100644
--- a/source/referenz/webpaket/verzeichnisse.rst
+++ b/source/referenz/webpaket/verzeichnisse.rst
@@ -4,19 +4,6 @@
Initial angelegte Verzeichnisse und Dateien
===========================================
-Verzeichnisstruktur
--------------------
-
-Jeder :doc:`Nutzer<../benutzer/index>` eines Web-Paketes hat eine initial angelegete Verzeichnisstruktur.
-Die Verzeichnisstruktur entspricht der dem jeweiligen Nutzer zugesprochenen Rolle.
-
-* :doc:`Paket-Admin<verzeichnisebenen-paket-admin>`
-* :doc:`Domain-Admin<verzeichnisebenen-domain-admin>`
-* :doc:`E-Mail-Nutzer<verzeichnisebenen-email-nutzer>`
-
-Dateien
--------
-
-Der Paket-Admin besitzt initial angelegte Konfigurationsdateien und Dateien für das Logging von Webseiten, Traffic des Web-Pakets und E-Mail-Traffic.
-
-* :doc:`initial angelegte Dateien<dateien-paket-admin>`
+Jeder Nutzer eines Web-Pakets hat eine initial angelegete Verzeichnisstruktur.
+Die Verzeichnisstruktur entspricht der dem jeweiligen Nutzer zugesprochenen Rolle.
+Die Verzeichnisstrukturen von :role:`Paket-Admin`, :role:`Domain-Admin` und :role:`E-Mail-Benutzer` werden im Folgenden beschrieben.
--
Gitblit v1.9.0-SNAPSHOT