Skip to content

Commit 1e3e30d

Browse files
committed
nixos/h2o: clarify/format some docs to point to upstream config
1 parent 28aa290 commit 1e3e30d

File tree

1 file changed

+17
-7
lines changed

1 file changed

+17
-7
lines changed

nixos/modules/services/web-servers/h2o/vhost-options.nix

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,8 @@ in
3333
"example.org"
3434
];
3535
description = ''
36-
Additional names of virtual hosts served by this virtual host configuration.
36+
Additional names of virtual hosts served by this virtual host
37+
configuration.
3738
'';
3839
};
3940

@@ -42,7 +43,8 @@ in
4243
default = null;
4344
example = "127.0.0.1";
4445
description = ''
45-
Set the host address for this virtual host.
46+
Set the host address for this virtual host. If unset, the default is to
47+
listen on all network interfaces.
4648
'';
4749
};
4850

@@ -79,7 +81,7 @@ in
7981
config.services.h2o.defaultTLSListenPort
8082
'';
8183
description = ''
82-
Override the default TLS port for this virtual host.";
84+
Override the default TLS port for this virtual host.
8385
'';
8486
example = 8443;
8587
};
@@ -114,11 +116,17 @@ in
114116
options = {
115117
key-file = mkOption {
116118
type = types.path;
117-
description = "Path to key file";
119+
description = ''
120+
Path to key file. See
121+
<https://h2o.examp1e.net/configure/base_directives.html#key-file>.
122+
'';
118123
};
119124
certificate-file = mkOption {
120125
type = types.path;
121-
description = "Path to certificate file";
126+
description = ''
127+
Path to certificate file. See
128+
<https://h2o.examp1e.net/configure/base_directives.html#certificate-file>.
129+
'';
122130
};
123131
};
124132
}
@@ -148,7 +156,8 @@ in
148156
type = types.attrs;
149157
default = { };
150158
description = ''
151-
Additional TLS/SSL-related configuration options.
159+
Additional TLS/SSL-related configuration options. See
160+
<https://h2o.examp1e.net/configure/base_directives.html#listen-ssl>.
152161
'';
153162
example =
154163
literalExpression
@@ -214,7 +223,8 @@ in
214223
default = { };
215224
description = ''
216225
Attrset to be transformed into YAML for host config. Note that the HTTP
217-
/ TLS configurations will override these config values.
226+
/ TLS configurations will override these config values. See
227+
<https://h2o.examp1e.net/configure/base_directives.html#hosts>.
218228
'';
219229
};
220230
};

0 commit comments

Comments
 (0)