Mirrors/caddy
1
0
Fork 0
mirror of https://github.com/caddyserver/caddy.git synced 2025-02-24 16:59:00 +01:00
Code Issues Projects Releases Packages Wiki Activity

Post init script guidelines

Browse source
This commit is contained in:
Matthew Holt 2016-12-30 11:56:37 -07:00
parent d98a7aad0f
commit 466efb7e67
No known key found for this signature in database
GPG key ID: 2A349DD577D586A5
1 changed files with 16 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
dist/init/README.md vendored
View file

@ -10,3 +10,19 @@ Different scripts have different maintainers; please consult the comments in the
## Disclaimer
The files contained herein are not officially supported by the Caddy project author and/or contributors, and as such, the files are not endorsed by the same. The Caddy project author and its contributors are not responsible for the function or malfunction of these scripts/files, or any unintended consequences to your system or website in attempting to set up Caddy. Users are expected to know how to administer their system, and these files should be considered as only a guide or suggestion for using Caddy in certain environments.
## Guidelines
The files distributed here should adhere to these principles where relevant (adjust accordingly for each system/platform):
- Don't run as root.
- Create a no-shell default user to run it.
- Raise file descriptor limits.
- Don't restart endlessly; if Caddy fails to start, there's a reason -- fix it, don't hammer it.
- Allow Caddy to re-use the same, persistent folder for storage.
- Stay as simple and minimal as possible.
- Be idempotent.
- Use comments to explain unexpected or unusual lines/patterns.
- Be secure by default.
Thank you for using Caddy! May it serve you well.