Add documentation of the root directory and cgi-bin
authorJan Dittberner <jandd@cacert.org>
Sun, 28 Oct 2018 10:00:55 +0000 (11:00 +0100)
committerJan Dittberner <jandd@cacert.org>
Sun, 28 Oct 2018 10:00:55 +0000 (11:00 +0100)
source/database.rst [new file with mode: 0644]
source/directories.rst [new file with mode: 0644]
source/index.rst

diff --git a/source/database.rst b/source/database.rst
new file mode 100644 (file)
index 0000000..ee8ac46
--- /dev/null
@@ -0,0 +1,6 @@
+==================
+Database structure
+==================
+
+This part of the documentation describes the database schema of the CAcert
+web application.
diff --git a/source/directories.rst b/source/directories.rst
new file mode 100644 (file)
index 0000000..fd67962
--- /dev/null
@@ -0,0 +1,49 @@
+===================
+Directory structure
+===================
+
+root Directory
+==============
+
+The root directory contains
+
+- a :file:`.gitignore` file with a list of excluded files
+- a :file:`LICENSE` file the `GPL`_ license text
+- a :file:`README` file with very rudimentary documentation stating the
+  license and a list of system requirements
+
+.. _GPL: https://www.gnu.org/licenses/old-licenses/gpl-2.0
+
+Directory :file:`cgi-bin`
+=========================
+
+The `cgi-bin` directory contains
+
+.. _cgi-bin-siteseal-cgi:
+
+- :file:`siteseal.cgi` a PHP CGI script that generates some JavaScript code
+  to invoke :ref:`sealgen.php <www-sealgen-php>`. The configuration on
+  www.cacert.org does not seem to support this script
+  https://www.cacert.org/cgi-bin/siteseal.cgi returns a 403 response.
+
+.. todo: check whether this is linked anywhere or can be removed
+
+Directory :file:`www`
+=====================
+
+This contains the PHP code that is the entry point to the application:
+
+.. _www-sealgen-php:
+
+- :file:`sealgen.php` generates a small site seal image from
+  :ref:`www/images/secured.png <www-images-secured-png>`. This could be
+  replaced with a static image if it is used at all. This is referenced
+  by :ref:`cgi-bin/siteseal.cgi <cgi-bin-siteseal-cgi>`
+
+Directory :file:`www/images`
+============================
+
+.. _www-images-secured-png:
+
+- :file:`secured.png` is a small image used by
+  :ref:`www/sealgen.php <www-sealgen-php>`
index fbbddc9..d49e27a 100644 (file)
@@ -20,6 +20,8 @@ contribution. The canonical repository is the :cacertgit:`cacert-devel` though.
    :maxdepth: 2
    :caption: Contents:
 
+   directories
+   database
    building
 
 Filesystem structure