mirrors/caddy-website
1
0
Fork 0
mirror of https://github.com/caddyserver/website.git synced 2025-04-23 13:36:16 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

Use headings for overrides for clarity

Browse source
This commit is contained in:
Francis Lavoie 2024-10-06 11:17:55 -04:00
parent ee6838dc40
commit 3ad009af91
No known key found for this signature in database
GPG key ID: 52BC55A211F19186
1 changed files with 14 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

17
src/docs/markdown/running.md
View file

@ -13,6 +13,9 @@ While Caddy can be run directly with its [command line interface](/docs/command-
- [Using the Service](#using-the-service) - [Using the Service](#using-the-service)
- [Local HTTPS](#local-https-with-systemd) - [Local HTTPS](#local-https-with-systemd)
- [Overrides](#overrides) - [Overrides](#overrides)
- [Environment variables](#environment-variables)
- [Run and reload override](#run-and-reload-override)
- [Restart on crash](#restart-on-crash)
- [SELinux Considerations](#selinux-considerations) - [SELinux Considerations](#selinux-considerations)
- [Windows service](#windows-service) - [Windows service](#windows-service)
- [sc.exe](#scexe) - [sc.exe](#scexe)
@ -138,7 +141,9 @@ The best way to override aspects of the service files is with this command:
This will open a blank file with your default terminal text editor in which you can override or add directives to the unit definition. This is called a "drop-in" file. This will open a blank file with your default terminal text editor in which you can override or add directives to the unit definition. This is called a "drop-in" file.
For example, if you need to define environment variables for use in your config, you may do so like this: #### Environment variables
If you need to define environment variables for use in your config, you may do so like this:
```systemd ```systemd
[Service] [Service]
Environment="CF_API_TOKEN=super-secret-cloudflare-tokenvalue" Environment="CF_API_TOKEN=super-secret-cloudflare-tokenvalue"
@ -156,7 +161,9 @@ Then your `/etc/caddy/.env` file may look like this (do not use `"` quotes aroun
CF_API_TOKEN=super-secret-cloudflare-tokenvalue CF_API_TOKEN=super-secret-cloudflare-tokenvalue
``` ```
Or, for example if you need to change the config file from the default of the Caddyfile, to instead using a JSON file (note that `Exec*` directives [must be reset with empty strings](https://www.freedesktop.org/software/systemd/man/systemd.service.html#ExecStart=) before setting a new value): #### Run and reload override
If you need to change the config file from the default of the Caddyfile, to instead using a JSON file (note that `Exec*` directives [must be reset with empty strings](https://www.freedesktop.org/software/systemd/man/systemd.service.html#ExecStart=) before setting a new value):
```systemd ```systemd
[Service] [Service]
ExecStart= ExecStart=
@ -165,7 +172,9 @@ ExecReload=
ExecReload=/usr/bin/caddy reload --config /etc/caddy/caddy.json ExecReload=/usr/bin/caddy reload --config /etc/caddy/caddy.json
``` ```
Or, for example, if you'd like caddy to restart itself after 5s if it ever crashes unexpectedly: #### Restart on crash
If you'd like caddy to restart itself after 5s if it ever crashes unexpectedly:
```systemd ```systemd
[Service] [Service]
# Automatically restart caddy if it crashes except if the exit code was 1 # Automatically restart caddy if it crashes except if the exit code was 1
@ -177,6 +186,8 @@ RestartSec=5s
Then, save the file and exit the text editor, and restart the service for it to take effect: Then, save the file and exit the text editor, and restart the service for it to take effect:
<pre><code class="cmd bash">sudo systemctl restart caddy</code></pre> <pre><code class="cmd bash">sudo systemctl restart caddy</code></pre>
### SELinux Considerations ### SELinux Considerations
On SELinux enabled systems you have two options: On SELinux enabled systems you have two options: