Skip to content

Commit a7904ff

Browse files
authored
Merge pull request #133 from miharp/fix/markdown-extension-links
Fix .markdown extension links in openvox-server and openvoxdb docs
2 parents f265810 + d1c4455 commit a7904ff

22 files changed

Lines changed: 71 additions & 71 deletions

docs/_openvox-server_8x/config_file_auth.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ If this setting is `true`, Puppet Server ignores any presented certificate and r
7878
7979
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.
8080

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
8282
[Configuring the Authorization Service](https://github.com/puppetlabs/trapperkeeper-authorization/blob/master/doc/authorization-config.md#allow-header-cert-info) in the `trapperkeeper-authorization`
8383
documentation.
8484

docs/_openvox-server_8x/config_file_auth_migration.markdown

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -41,25 +41,25 @@ The following rules, settings, and values have no direct equivalent in the new H
4141

4242
The HOCON `auth.conf` file has some fundamental structural requirements:
4343

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.
5050
- If the value is between 1 and 399, the rule supersedes Puppet Server's default authorization rules.
5151
- 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.
5353
- 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:
5555
- 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,
5656
or a regular expression.
5757
- A single map value containing an `extension` key.
5858
- A single map value containing a `certname` key.
5959
- 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.
6161

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).
6363

6464
### Converting a simple rule
6565

@@ -92,7 +92,7 @@ authorization: {
9292

9393
Next, let's convert each component of the deprecated rule to the new HOCON format.
9494

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.
9696

9797
```hocon
9898
...
@@ -107,7 +107,7 @@ Next, let's convert each component of the deprecated rule to the new HOCON forma
107107
...
108108
```
109109

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`.
111111

112112
```hocon
113113
...
@@ -122,8 +122,8 @@ Next, let's convert each component of the deprecated rule to the new HOCON forma
122122
...
123123
```
124124

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.
127127

128128
```hocon
129129
...

docs/_openvox-server_8x/crl_refresh.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ canonical: "/puppetserver/latest/crl_refresh.html"
66

77
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.
88

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.
1010

1111
`puppetlabs.trapperkeeper.services.watcher.filesystem-watch-service/filesystem-watch-service`
1212

docs/_openvox-server_8x/gems.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ As an example, the following command installs `pry` locally in the project. Note
9090
Successfully installed pry-0.10.1-java
9191
5 gems installed
9292

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).
9494

9595
## Gems with Native (C) Extensions
9696

docs/_openvox-server_8x/puppet_conf_setting_diffs.markdown

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -9,17 +9,17 @@ Puppet Server honors almost all settings in puppet.conf and should pick them up
99

1010
## [`autoflush`](https://puppet.com/docs/puppet/latest/configuration.html#autoflush)
1111

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.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).
1313

1414
## [`bindaddress`](https://puppet.com/docs/puppet/latest/configuration.html#bindaddress)
1515

1616
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
17-
[webserver.conf](./configuration.markdown#webserverconf) file.
17+
[webserver.conf](./configuration.html#webserverconf) file.
1818

1919
## [`ca`](https://puppet.com/docs/puppet/latest/configuration.html#ca)
2020

2121
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.
2323

2424
## [`ca_ttl`](https://puppet.com/docs/puppet/latest/configuration.html#cattl)
2525

@@ -28,11 +28,11 @@ Puppet Server enforces a max ttl of 50 standard years (up to 1576800000 seconds)
2828
## [`cacert`](https://puppet.com/docs/puppet/latest/configuration.html#cacert)
2929

3030
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).
3232

3333
## [`cacrl`](https://puppet.com/docs/puppet/latest/configuration.html#cacrl)
3434

35-
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
3636
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.
3737

3838
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.
5555

5656
## [`hostcert`](https://puppet.com/docs/puppet/latest/configuration.html#hostcert)
5757

58-
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
5959
certificate via SSL.
6060

6161
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.
6666

6767
## [`hostcrl`](https://puppet.com/docs/puppet/latest/configuration.html#hostcrl)
6868

69-
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
7070
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.
7171

7272
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.
7777

7878
## [`hostprivkey`](https://puppet.com/docs/puppet/latest/configuration.html#hostprivkey)
7979

80-
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
8181
transactions.
8282

8383
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.
8989
## [`http_debug`](https://puppet.com/docs/puppet/latest/configuration.html#httpdebug)
9090

9191
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).
9393

9494
## [`keylength`](https://puppet.com/docs/puppet/latest/configuration.html#keylength)
9595

9696
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.
9797

9898
## [`localcacert`](https://puppet.com/docs/puppet/latest/configuration.html#localcacert)
9999

100-
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
101101
authenticating clients via SSL.
102102

103103
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,
104104
Puppet Server uses the CA file defined for the `localcacert` setting in puppet.conf for SSL authentication.
105105

106106
## [`logdir`](https://puppet.com/docs/puppet/latest/configuration.html#logdir)
107107

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.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).
109109

110110
## [`masterhttplog`](https://puppet.com/docs/puppet/latest/configuration.html#masterhttplog)
111111

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.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.
113113

114114
## [`masterlog`](https://puppet.com/docs/puppet/latest/configuration.html#masterlog)
115115

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.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).
117117

118118
## [`masterport`](https://puppet.com/docs/puppet/latest/configuration.html#masterport)
119119

120120
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
121-
[webserver.conf](./configuration.markdown#webserverconf) file.
121+
[webserver.conf](./configuration.html#webserverconf) file.
122122

123123
## [`puppetdlog`](https://puppet.com/docs/puppet/latest/configuration.html#puppetdlog)
124124

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.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).
126126

127127
## [`rails_loglevel`](https://puppet.com/docs/puppet/latest/configuration.html#railsloglevel)
128128

@@ -174,7 +174,7 @@ requests that the master would make to the `reporturl` for the `http` report pro
174174

175175
## Overriding Puppet settings in Puppet Server
176176

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`,
178178
`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.
179179

180180
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

Comments
 (0)