blob: dcb6be5dca04ff1aeea03f17a169996fd44ea15e (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
|
---
title: "Documentation"
description: "Authelia Development Documentation Guidelines"
summary: "This section covers the guidelines we use when writing documentation."
date: 2022-10-02T14:32:16+11:00
draft: false
images: []
weight: 320
toc: true
seo:
title: "" # custom title (optional)
description: "" # custom description (recommended)
canonical: "" # custom canonical URL (optional)
noindex: false # false (default) or true
---
## Domains
Always use the generic domain (or subdomain of) `example.com` in documentation.
If it's necessary to utilize more than one domain please ask for specific feedback in any PR.
## Certificates
When including certificates in documentation always ensure they are valid for 1 year starting at `Jan 1 00:00:00 1970`.
This ensures the certificate is not valid for multiple reasons.
In addition the guidance for [Private Keys](#private-keys) should be followed.
## Private Keys
Always append invalid data to the END of the PEM block before the base64 padding `=` (if present). The suggested
text is `^invalid DO NOT USE`. This both has an invalid base64 character `^` and has information to communicate that
users should not use the PEM block.
|
