diff options
| -rw-r--r-- | source/database.rst | 6 | ||||
| -rw-r--r-- | source/directories.rst | 49 | ||||
| -rw-r--r-- | source/index.rst | 2 |
3 files changed, 57 insertions, 0 deletions
diff --git a/source/database.rst b/source/database.rst new file mode 100644 index 0000000..ee8ac46 --- /dev/null +++ b/source/database.rst @@ -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 index 0000000..fd67962 --- /dev/null +++ b/source/directories.rst @@ -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>` diff --git a/source/index.rst b/source/index.rst index fbbddc9..d49e27a 100644 --- a/source/index.rst +++ b/source/index.rst @@ -20,6 +20,8 @@ contribution. The canonical repository is the :cacertgit:`cacert-devel` though. :maxdepth: 2 :caption: Contents: + directories + database building Filesystem structure |