diff options
| author | Simo Sorce <simo@redhat.com> | 2015-04-15 17:50:38 -0400 |
|---|---|---|
| committer | Simo Sorce <simo@redhat.com> | 2015-04-16 09:28:41 -0400 |
| commit | f77b0158f87a13efc1d315b1bcb58cccf4406e88 (patch) | |
| tree | 8bd77bce8e045cadd788a29033d193e51d4e2dc0 /docs/source/index.rst | |
| parent | 974837af648f2fbc80f3468e7a90fca7d11f8e29 (diff) | |
| download | custodia-f77b0158f87a13efc1d315b1bcb58cccf4406e88.tar.gz custodia-f77b0158f87a13efc1d315b1bcb58cccf4406e88.tar.xz custodia-f77b0158f87a13efc1d315b1bcb58cccf4406e88.zip | |
Add skeleton docs dir
Signed-off-by: Simo Sorce <simo@redhat.com>
Diffstat (limited to 'docs/source/index.rst')
| -rw-r--r-- | docs/source/index.rst | 31 |
1 files changed, 31 insertions, 0 deletions
diff --git a/docs/source/index.rst b/docs/source/index.rst new file mode 100644 index 0000000..53a93da --- /dev/null +++ b/docs/source/index.rst @@ -0,0 +1,31 @@ +.. Custodia documentation master file, created by + sphinx-quickstart on Wed Apr 15 17:49:46 2015. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to Custodia's documentation! +==================================== + +Custodia is a Secrets Service Provider, it stores or proxies access to keys, +password, and secret material in general. Custodia is built to use the HTTP +protocol and a RESTful API as an IPC mechanism over a local Unix Socket. It +can also be exposed to a network via a Reverse Proxy service assuming proper +authentication and header validation is implemented in the Proxy. + +Custodia is modular, the configuration file controls how authentication, +authorization, storage and API plugins are combined and exposed. + +Contents: + +.. toctree:: + :maxdepth: 2 + + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` + |