You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Fix .markdown extension links in openvox-server and openvoxdb docs
Inline links in _openvox-server_8x and _openvoxdb_8x used .markdown
extensions which Jekyll renders as .html. PR #119 fixed this in
_openvox_8x; this extends the same fix to the remaining two collections.
22 files updated across both collections.
Part of the link debt being surfaced by #120.
Signed-off-by: Michael Harp <mike@mikeharp.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Copy file name to clipboardExpand all lines: docs/_openvox-server_8x/config_file_auth.markdown
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -78,7 +78,7 @@ If this setting is `true`, Puppet Server ignores any presented certificate and r
78
78
79
79
You cannot rename any of the `X-Client` headers when this setting is enabled, and you must specify identity through the `X-Client-Verify`, `X-Client-DN`, and `X-Client-Cert` headers.
80
80
81
-
For more information, see [External SSL Termination](./external_ssl_termination.markdown#disable-https-for-puppet-server) in the Puppet Server documentation and
81
+
For more information, see [External SSL Termination](./external_ssl_termination.html#disable-https-for-puppet-server) in the Puppet Server documentation and
82
82
[Configuring the Authorization Service](https://github.com/puppetlabs/trapperkeeper-authorization/blob/master/doc/authorization-config.md#allow-header-cert-info) in the `trapperkeeper-authorization`
Copy file name to clipboardExpand all lines: docs/_openvox-server_8x/config_file_auth_migration.markdown
+14-14Lines changed: 14 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -41,25 +41,25 @@ The following rules, settings, and values have no direct equivalent in the new H
41
41
42
42
The HOCON `auth.conf` file has some fundamental structural requirements:
43
43
44
-
- An [`authorization`](./config_file_auth.markdown#authorization) section, which contains:
45
-
- A [`version`](./config_file_auth.markdown#version) setting.
46
-
- A [`rules`](./config_file_auth.markdown#rules) array of map values, each representing an authorization rule. Each rule must contain:
47
-
- A [`match-request`](./config_file_auth.markdown#match-request) section.
48
-
- Each `match-request` section must contain at least one [`path`](./config_file_auth.markdown#path) and [`type`](./config_file_auth.markdown#type).
49
-
- A numeric [`sort-order`](./config_file_auth.markdown#sort-order) value.
44
+
- An [`authorization`](./config_file_auth.html#authorization) section, which contains:
45
+
- A [`version`](./config_file_auth.html#version) setting.
46
+
- A [`rules`](./config_file_auth.html#rules) array of map values, each representing an authorization rule. Each rule must contain:
47
+
- A [`match-request`](./config_file_auth.html#match-request) section.
48
+
- Each `match-request` section must contain at least one [`path`](./config_file_auth.html#path) and [`type`](./config_file_auth.html#type).
49
+
- A numeric [`sort-order`](./config_file_auth.html#sort-order) value.
50
50
- If the value is between 1 and 399, the rule supersedes Puppet Server's default authorization rules.
51
51
- If the value is between 601 and 998, the rule can be overridden by Puppet Server's default authorization rules.
52
-
- A string [`name`](./config_file_auth.markdown#name) value.
52
+
- A string [`name`](./config_file_auth.html#name) value.
53
53
- At least one of the following:
54
-
- An [`allow` value, a `deny` value, or both](./config_file_auth.markdown#allow-allow-unauthenticated-and-deny). The `allow` or `deny` values can contain:
54
+
- An [`allow` value, a `deny` value, or both](./config_file_auth.html#allow-allow-unauthenticated-and-deny). The `allow` or `deny` values can contain:
55
55
- A single string, representing the request's "name" derived from the Common Name (CN) attribute within an X.509 certificate's Subject Distinguished Name (DN). This string can be an exact name, a glob,
56
56
or a regular expression.
57
57
- A single map value containing an `extension` key.
58
58
- A single map value containing a `certname` key.
59
59
- An array of values, including string and map values.
60
-
- An [`allow-unauthenticated`](./config_file_auth.markdown#allow-allow-unauthenticated-and-deny) value, but if present, there cannot also be an `allow` value.
60
+
- An [`allow-unauthenticated`](./config_file_auth.html#allow-allow-unauthenticated-and-deny) value, but if present, there cannot also be an `allow` value.
61
61
62
-
For an full example of a HOCON `auth.conf` file, see the [HOCON `auth.conf` documentation](./config_file_auth.markdown#hocon-example).
62
+
For an full example of a HOCON `auth.conf` file, see the [HOCON `auth.conf` documentation](./config_file_auth.html#hocon-example).
63
63
64
64
### Converting a simple rule
65
65
@@ -92,7 +92,7 @@ authorization: {
92
92
93
93
Next, let's convert each component of the deprecated rule to the new HOCON format.
94
94
95
-
1. Add the path to the new rule's [`path`](./config_file_auth.markdown#match-request) setting in its `match-request` section.
95
+
1. Add the path to the new rule's [`path`](./config_file_auth.html#match-request) setting in its `match-request` section.
96
96
97
97
```hocon
98
98
...
@@ -107,7 +107,7 @@ Next, let's convert each component of the deprecated rule to the new HOCON forma
107
107
...
108
108
```
109
109
110
-
2. Next, add its type to the section's [`type`](./config_file_auth.markdown#match-request) setting. Because this is a literal string path, the type is `path`.
110
+
2. Next, add its type to the section's [`type`](./config_file_auth.html#match-request) setting. Because this is a literal string path, the type is `path`.
111
111
112
112
```hocon
113
113
...
@@ -122,8 +122,8 @@ Next, let's convert each component of the deprecated rule to the new HOCON forma
122
122
...
123
123
```
124
124
125
-
3. The legacy rule has a [`method`](./config_file_auth.markdown#method-1) setting, with an indirector value of `find` that's equivalent to the GET and POST HTTP methods. We can implement these by adding an
126
-
optional HOCON [`method`](./config_file_auth.markdown#match-request) setting in the rule's `match-request` section and specifying GET and POST as an array.
125
+
3. The legacy rule has a [`method`](./config_file_auth.html#method-1) setting, with an indirector value of `find` that's equivalent to the GET and POST HTTP methods. We can implement these by adding an
126
+
optional HOCON [`method`](./config_file_auth.html#match-request) setting in the rule's `match-request` section and specifying GET and POST as an array.
Starting in version 5.1.0, Puppet Server can automatically reload an updated CRL into the running SSL context, so that the revocation of an agent's certificate no longer requires a restart of the service to take effect. Prior versions required an explicit restart or reload of this service to reload the CRL, resulting in some small amount of downtime to effect the revocation of a certificate. Revocation is now transparent and requires no service downtime.
8
8
9
-
If you are upgrading and have modified your ca.cfg, adding the following line manually may be required. See [Service Bootstraping](./configuration.markdown#service-bootstrapping) for information on how to update your Puppet Server's services bootstrap configuration.
9
+
If you are upgrading and have modified your ca.cfg, adding the following line manually may be required. See [Service Bootstraping](./configuration.html#service-bootstrapping) for information on how to update your Puppet Server's services bootstrap configuration.
Copy file name to clipboardExpand all lines: docs/_openvox-server_8x/gems.markdown
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -90,7 +90,7 @@ As an example, the following command installs `pry` locally in the project. Note
90
90
Successfully installed pry-0.10.1-java
91
91
5 gems installed
92
92
93
-
With the gem installed into the project tree `pry` can be invoked from inside Ruby code. For more detailed information on `pry` see [Puppet Server: Debugging](./dev_debugging.markdown#pry).
93
+
With the gem installed into the project tree `pry` can be invoked from inside Ruby code. For more detailed information on `pry` see [Puppet Server: Debugging](./dev_debugging.html#pry).
Puppet Server does not use this setting. For more information on the master logging implementation for Puppet Server, see the [logging configuration section](./configuration.markdown#logging).
12
+
Puppet Server does not use this setting. For more information on the master logging implementation for Puppet Server, see the [logging configuration section](./configuration.html#logging).
Puppet Server does not use this setting. To set the address on which the master listens, use either `host` (unencrypted) or `ssl-host` (SSL encrypted) in the
Puppet Server does not use this setting. Instead, Puppet Server acts as a certificate authority based on the certificate authority service configuration in the `ca.cfg` file. See
22
-
[Service Bootstrapping](./configuration.markdown#service-bootstrapping) for more details.
22
+
[Service Bootstrapping](./configuration.html#service-bootstrapping) for more details.
If you enable Puppet Server's certificate authority service, it uses the `cacert` setting in puppet.conf to determine the location of the CA certificate for such tasks as generating the CA certificate or using
31
-
the CA to sign client certificates. This is true regardless of the configuration of the `ssl-` settings in [webserver.conf](./configuration.markdown#webserverconf).
31
+
the CA to sign client certificates. This is true regardless of the configuration of the `ssl-` settings in [webserver.conf](./configuration.html#webserverconf).
If you define `ssl-cert`, `ssl-key`, `ssl-ca-cert`, or `ssl-crl-path` in [webserver.conf](./configuration.markdown#webserverconf), Puppet Server uses the file at `ssl-crl-path` as the CRL for authenticating
35
+
If you define `ssl-cert`, `ssl-key`, `ssl-ca-cert`, or `ssl-crl-path` in [webserver.conf](./configuration.html#webserverconf), Puppet Server uses the file at `ssl-crl-path` as the CRL for authenticating
36
36
clients via SSL. If at least one of the `ssl-` settings in webserver.conf is set but `ssl-crl-path` is not set, Puppet Server will _not_ use a CRL to validate clients via SSL.
37
37
38
38
If none of the `ssl-` settings in webserver.conf are set, Puppet Server uses the CRL file defined for the `hostcrl` setting---and not the file defined for the `cacrl` setting--in puppet.conf. At start time,
@@ -55,7 +55,7 @@ Puppet Server does not use this setting.
If you define `ssl-cert`, `ssl-key`, `ssl-ca-cert`, or `ssl-crl-path` in [webserver.conf](./configuration.markdown#webserverconf), Puppet Server presents the file at `ssl-cert` to clients as the server
58
+
If you define `ssl-cert`, `ssl-key`, `ssl-ca-cert`, or `ssl-crl-path` in [webserver.conf](./configuration.html#webserverconf), Puppet Server presents the file at `ssl-cert` to clients as the server
59
59
certificate via SSL.
60
60
61
61
If at least one of the `ssl-` settings in webserver.conf is set but `ssl-cert` is not set, Puppet Server gives an error and shuts down at startup. If none of the `ssl-` settings in webserver.conf are set,
@@ -66,7 +66,7 @@ determine the location of the server host certificate to generate.
If you define `ssl-cert`, `ssl-key`, `ssl-ca-cert`, or `ssl-crl-path` in [webserver.conf](./configuration.markdown#webserverconf), Puppet Server uses the file at `ssl-crl-path` as the CRL for authenticating
69
+
If you define `ssl-cert`, `ssl-key`, `ssl-ca-cert`, or `ssl-crl-path` in [webserver.conf](./configuration.html#webserverconf), Puppet Server uses the file at `ssl-crl-path` as the CRL for authenticating
70
70
clients via SSL. If at least one of the `ssl-` settings in webserver.conf is set but `ssl-crl-path` is not set, Puppet Server will _not_ use a CRL to validate clients via SSL.
71
71
72
72
If none of the `ssl-` settings in webserver.conf are set, Puppet Server uses the CRL file defined for the `hostcrl` setting---and not the file defined for the `cacrl` setting--in puppet.conf. At start time,
@@ -77,7 +77,7 @@ the CRL. This is true regardless of the `ssl-` settings in webserver.conf.
If you define `ssl-cert`, `ssl-key`, `ssl-ca-cert`, or `ssl-crl-path` in [webserver.conf](./configuration.markdown#webserverconf), Puppet Server uses the file at `ssl-key` as the server private key during SSL
80
+
If you define `ssl-cert`, `ssl-key`, `ssl-ca-cert`, or `ssl-crl-path` in [webserver.conf](./configuration.html#webserverconf), Puppet Server uses the file at `ssl-key` as the server private key during SSL
81
81
transactions.
82
82
83
83
If at least one of the `ssl-` settings in webserver.conf is set but `ssl-key` is not, Puppet Server gives an error and shuts down at startup. If none of the `ssl-` settings in webserver.conf are set, Puppet
@@ -89,40 +89,40 @@ regardless of the configuration of the `ssl-` settings in webserver.conf.
Puppet Server does not use this setting. Debugging for HTTP client code in the Puppet Server master is controlled through Puppet Server's common logging mechanism. For more information on the master logging
92
-
implementation for Puppet Server, see the [logging configuration section](./configuration.markdown#logging).
92
+
implementation for Puppet Server, see the [logging configuration section](./configuration.html#logging).
Puppet Server does not currently use this setting. Puppet Server's certificate authority generates 4096-bit keys in conjunction with any SSL certificates that it generates.
If you define `ssl-cert`, `ssl-key`, `ssl-ca-cert`, and/or `ssl-crl-path` in [webserver.conf](./configuration.markdown#webserverconf), Puppet Server uses the file at `ssl-ca-cert` as the CA cert store for
100
+
If you define `ssl-cert`, `ssl-key`, `ssl-ca-cert`, and/or `ssl-crl-path` in [webserver.conf](./configuration.html#webserverconf), Puppet Server uses the file at `ssl-ca-cert` as the CA cert store for
101
101
authenticating clients via SSL.
102
102
103
103
If at least one of the `ssl-` settings in webserver.conf is set but `ssl-ca-cert` is not set, Puppet Server gives an error and shuts down at startup. If none of the `ssl-` settings in webserver.conf is set,
104
104
Puppet Server uses the CA file defined for the `localcacert` setting in puppet.conf for SSL authentication.
Puppet Server does not use this setting. For more information on the master logging implementation for Puppet Server, see the [logging configuration section](./configuration.markdown#logging).
108
+
Puppet Server does not use this setting. For more information on the master logging implementation for Puppet Server, see the [logging configuration section](./configuration.html#logging).
Puppet Server does not use this setting. You can configure a web server access log via the `access-log-config` setting in the [webserver.conf](./configuration.markdown#webserverconf) file.
112
+
Puppet Server does not use this setting. You can configure a web server access log via the `access-log-config` setting in the [webserver.conf](./configuration.html#webserverconf) file.
Puppet Server does not use this setting. For more information on the master logging implementation for Puppet Server, see the [logging configuration section](./configuration.markdown#logging).
116
+
Puppet Server does not use this setting. For more information on the master logging implementation for Puppet Server, see the [logging configuration section](./configuration.html#logging).
Puppet Server does not use this setting. To set the port on which the master listens, set the `port` (unencrypted) or `ssl-port` (SSL encrypted) setting in the
Puppet Server does not use this setting. For more information on the master logging implementation for Puppet Server, see the [logging configuration section](./configuration.markdown#logging).
125
+
Puppet Server does not use this setting. For more information on the master logging implementation for Puppet Server, see the [logging configuration section](./configuration.html#logging).
@@ -174,7 +174,7 @@ requests that the master would make to the `reporturl` for the `http` report pro
174
174
175
175
## Overriding Puppet settings in Puppet Server
176
176
177
-
Currently, the [`jruby-puppet` section of your `puppetserver.conf` file](./configuration.markdown#puppetserver.conf) contains five settings (`master-conf-dir`, `master-code-dir`, `master-var-dir`,
177
+
Currently, the [`jruby-puppet` section of your `puppetserver.conf` file](./configuration.html#puppetserver.conf) contains five settings (`master-conf-dir`, `master-code-dir`, `master-var-dir`,
178
178
`master-run-dir`, and `master-log-dir`) that allow you to override settings set in your `puppet.conf` file. On installation, these five settings will be set to the proper default values.
179
179
180
180
While you are free to change these settings at will, please note that any changes made to the `master-conf-dir` and `master-code-dir` settings absolutely MUST be made to the corresponding Puppet settings
0 commit comments