Skip to content

Commit

Permalink
Post init script guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
mholt committed Dec 30, 2016
1 parent d98a7aa commit 466efb7
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions dist/init/README.md
Expand Up @@ -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.

0 comments on commit 466efb7

Please sign in to comment.