-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add documentation of file system layout and service configuration
- Loading branch information
Showing
3 changed files
with
71 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -7,6 +7,7 @@ Ansible role: ganto.acme_tiny | |
introduction | ||
getting-started | ||
defaults | ||
system-configuration | ||
copyright | ||
|
||
.. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,62 @@ | ||
System Configuration | ||
==================== | ||
|
||
.. _acme_tiny_ref_fs_layout | ||
File system layout | ||
------------------ | ||
|
||
The role will setup a configurable directory layout to store the certificates | ||
and make them accessible by the services. | ||
|
||
Example layout of the default configuration: | ||
|
||
======================================================= ================================== | ||
Server path Ansible role variable | ||
======================================================= ================================== | ||
:file:`/etc/ssl/acme-tiny` :envvar:`acme_tiny__config_dir` | ||
:file:`/etc/ssl/acme-tiny/example.com` :envvar:`acme_tiny__cert_dir` | ||
:file:`/etc/ssl/acme-tiny/example.com/example.com.key` :envvar:`acme_tiny__private_key` | ||
:file:`/etc/ssl/acme-tiny/example.com/example.com.crq` :envvar:`acme_tiny__cert_request` | ||
:file:`/etc/ssl/acme-tiny/example.com/example.com.crt` :envvar:`acme_tiny__certificate` | ||
======================================================= ================================== | ||
|
||
When setting a :envvar:`acme_tiny_cert_type` other than ``plain`` or ``chain`` | ||
an additional layer of indirection through symlinks which will make the | ||
certificates accessible in a transparent way. For each service the role will | ||
create a :file:`ssl/` subdirectory from where the actual certificates and keys | ||
are symlinked. Like this the CA could be changed easily without reconfiguration | ||
of the secured services. | ||
|
||
E.g. For for Apache :program:`httpd` this would look like this:: | ||
|
||
/etc/apache2/ssl/example.com.crt -> /etc/ssl/acme-tiny/example.com/example.com_chain.crt | ||
/etc/apache2/ssl/example.com.key -> /etc/ssl/acme-tiny/example.com/example.com.key | ||
|
||
For :program:`lighttpd`:: | ||
|
||
/etc/lighttpd/ssl/example.com.pem -> /etc/ssl/acme-tiny/example.com/example.com_lighttpd.pem | ||
/etc/lighttpd/ssl/ca.crt -> /etc/ssl/acme-tiny/intermediate.crt | ||
|
||
For :program:`Dovecot`:: | ||
|
||
/etc/postfix/ssl/example.com.crt -> /etc/ssl/acme-tiny/example.com/example.com.crt | ||
/etc/postfix/ssl/example.com.key -> /etc/ssl/acme-tiny/example.com/example.com.key | ||
|
||
|
||
.. _acme_tiny_ref_service_cfg | ||
Service configuration | ||
--------------------- | ||
|
||
|
||
.. _acme_tiny_ref_cert_renewal | ||
Certificate renewal | ||
------------------- | ||
|
||
.. | ||
Local Variables: | ||
mode: rst | ||
ispell-local-dictionary: "american" | ||
End: |