.. CAcert code documentation master file, created by
   sphinx-quickstart on Fri Oct 26 23:40:43 2018.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

CAcert code documentation
=========================

This is a work in progress documentation of the CAcert web application source
code in the `release` branch of the :cacertgit:`cacert-devel`.

The goal is to document the existing code base to give insight into its
functionality and to support writing a specification for a potential
reimplementation.

The code repository is mirrored to the :github:`cacert-devel` to encourage
contribution. The canonical repository is the :cacertgit:`cacert-devel` though.

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   general
   directories
   database
   signer
   building
   glossary

Filesystem structure
--------------------

The file system structure as of 2018-10-27 looks like shown below:

.. literalinclude:: structure.txt
   :language: text
   :encoding: utf-8



Indices and tables
==================

* :ref:`genindex`
* :ref:`search`