1Caddy(8)                                                              Caddy(8)
2
3
4

NAME

6       caddy-run - Starts the Caddy process and blocks indefinitely
7
8
9

SYNOPSIS

11       caddy run [flags]
12
13
14

DESCRIPTION

16       Starts  the Caddy process, optionally bootstrapped with an initial con‐
17       fig file, and blocks indefinitely until the  server  is  stopped;  i.e.
18       runs Caddy in "daemon" mode (foreground).
19
20
21       If a config file is specified, it will be applied immediately after the
22       process is running. If the config file is not in  Caddy's  native  JSON
23       format,  you  can  specify an adapter with --adapter to adapt the given
24       config file to Caddy's native format. The config adapter must be a reg‐
25       istered  module.  Any  warnings  will be printed to the log, but beware
26       that any adaptation without errors will immediately  be  used.  If  you
27       want  to  review  the  results of the adaptation first, use the 'adapt'
28       subcommand.
29
30
31       As a special case, if the current working directory has a  file  called
32       "Caddyfile"  and  the caddyfile config adapter is plugged in (default),
33       then that file will be loaded and used to configure Caddy, even without
34       any command line flags.
35
36
37       If  --envfile  is specified, an environment file with environment vari‐
38       ables in the KEY=VALUE format will be loaded into the Caddy process.
39
40
41       If --environ is specified, the environment as seen by the Caddy process
42       will  be  printed before starting. This is the same as the environ com‐
43       mand but does not quit after printing, and  can  be  useful  for  trou‐
44       bleshooting.
45
46
47       The  --resume flag will override the --config flag if there is a config
48       auto- save file. It is not an error if --resume is used and no autosave
49       file exists.
50
51
52       If  --watch  is specified, the config file will be loaded automatically
53       after changes. ⚠️ This can make unintentional  config  changes  easier;
54       only use this option in a local development environment.
55
56
57

OPTIONS

59       --adapter=""      Name of config adapter to apply
60
61
62       --config=""      Configuration file
63
64
65       --envfile=""      Environment file to load
66
67
68       --environ[=false]      Print environment
69
70
71       -h, --help[=false]      help for run
72
73
74       --pidfile=""      Path of file to which to write process ID
75
76
77       --pingback=""      Echo confirmation bytes to this address on success
78
79
80       --resume[=false]       Use saved config, if any (and prefer over --con‐
81       fig file)
82
83
84       --watch[=false]      Watch config file for changes and reload it  auto‐
85       matically
86
87
88

SEE ALSO

90       caddy(8)
91
92
93

HISTORY

95       15-Aug-2023 Auto generated by spf13/cobra
96
97
98
99Auto generated by spf13/cobra      Aug 2023                           Caddy(8)
Impressum