Skip to content

Commit 2ec215b

Browse files
committed
docs: fixes
1 parent a1fda7d commit 2ec215b

File tree

9 files changed

+39
-28
lines changed

9 files changed

+39
-28
lines changed

content/unit/howto/certbot.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ The commands in this document starting with a hash (#) must be run as root or
1616
with superuser privileges.
1717
{{< /note >}}
1818

19-
## Generating Certificates
19+
## Generating certificates
2020

2121
1. Install [Unit]({{< relref "/unit/installation.md#installation-precomp-pkgs" >}}) on your website's server.
2222

@@ -155,7 +155,7 @@ with superuser privileges.
155155
...
156156
```
157157

158-
## Renewing Certificates
158+
## Renewing certificates
159159

160160
Certbot enables renewing the certificates [manually](https://eff-certbot.readthedocs.io/en/stable/using.html#renewing-certificates)
161161
or [automatically](https://eff-certbot.readthedocs.io/en/stable/using.html#automated-renewals).

content/unit/howto/docker.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ also, see a more elaborate discussion
5353

5454
Now for a few detailed scenarios.
5555

56-
## Apps in a Containerized Unit {#docker-apps-containerized-unit}
56+
## Apps in a containerized Unit {#docker-apps-containerized-unit}
5757

5858
Suppose we have a web app with a few dependencies, say
5959
[Flask`s]({{< relref "/unit/howto/frameworks/flask.md" >}}) official **hello, world** app:
@@ -243,7 +243,7 @@ $ export UNIT=$( \
243243
```
244244

245245

246-
## Containerized Apps {#docker-apps}
246+
## Containerized apps {#docker-apps}
247247

248248
Suppose you have a Unit-ready
249249
[Express]({{< relref "/unit/howto/frameworks/express.md" >}})
@@ -399,7 +399,7 @@ $ docker exec -ti $UNIT curl -X PUT -d '"/www/newapp/"' \
399399
This approach is applicable to any Unit-supported apps with external
400400
dependencies.
401401

402-
## Multilanguage Images {#docker-multi}
402+
## Multilanguage images {#docker-multi}
403403

404404
Earlier, Unit had a **-full** Docker image with modules for all supported
405405
languages, but it was discontinued with version 1.22.0. If you still need a
@@ -442,7 +442,7 @@ Instead of packages, you can build custom
442442
[modules]({{< relref "/unit/howto/source.md#source-modules" >}});
443443
use these **Dockerfile.\*** [templates](https://github.com/nginx/unit/tree/master/pkg/docker) as reference.
444444

445-
## Startup Customization {#docker-startup}
445+
## Startup customization {#docker-startup}
446446

447447
Finally, you can customize the way Unit starts in a container by adding a new
448448
Dockerfile layer:

content/unit/howto/integration.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: NGINX Integration
2+
title: NGINX integration
33
toc: true
44
weight: 500
55
---
@@ -74,7 +74,7 @@ listener's **client_ip** option.
7474
For details, see the [NGINX documentation](https://nginx.org). Commercial
7575
support and advanced features are [also available](https://www.nginx.com).
7676

77-
## Securely Proxying Unit's Control API {#nginx-secure-api}
77+
## Securely proxying Unit's control API {#nginx-secure-api}
7878

7979
By default, Unit exposes its
8080
[control API]({{< relref "/unit/controlapi.md#configuration-mgmt" >}})

content/unit/howto/modules.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Working With Language Modules
2+
title: Working with language modules
33
weight: 700
44
toc: true
55
---
@@ -20,7 +20,7 @@ The commands in this document starting with a hash (#) must be run as root or
2020
with superuser privileges.
2121
{{< /note >}}
2222

23-
## External Language Modules {#modules-ext}
23+
## External language modules {#modules-ext}
2424

2525
External modules are regular language libraries or packages that you install
2626
like any other. They provide common web functionality, communicating with Unit
@@ -44,7 +44,7 @@ For WebAssembly, Unit delegates bytecode execution to the
4444
module or during a
4545
[source build]({{< relref "/unit/howto/source.md#source-wasm" >}}).
4646

47-
## Embedded Language Modules {#modules-emb}
47+
## Embedded language modules {#modules-emb}
4848

4949
Embedded modules are shared libraries that Unit loads at startup. Query Unit
5050
to find them in your system:

content/unit/howto/security.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ The commands in this document starting with a hash (#) must be run as root or
1717
with superuser privileges.
1818
{{< /note >}}
1919

20-
## Update Unit Regularly {#security-update}
20+
## Update Unit regularly {#security-update}
2121

2222
**Rationale**: Each release introduces [bug fixes and new
2323
features]({{< relref "/unit/changes.md" >}}) that improve your installation's security.
@@ -49,7 +49,7 @@ Specific upgrade steps depend on your installation method:
4949

5050
</details>
5151

52-
## Secure Socket and State {#security-socket-state}
52+
## Secure socket and state {#security-socket-state}
5353

5454
**Rationale**: Your
5555
[control socket and state directory]({{< relref "/unit/howto/source.md#source-dir" >}})
@@ -189,7 +189,7 @@ configure SSL certificate bundles for your Unit installation.
189189

190190
**Actions**: For details, see [SSL/TLS configuration]({{< relref "/unit/certificates.md#configuration-ssl" >}}) and [TLS with certbot]({{< relref "/unit/howto/certbot.md" >}}).
191191

192-
## Error-Proof Your Routes {#security-routes}
192+
## Error-proof your routes {#security-routes}
193193

194194
**Rationale**: Arguably, [routes]({{< relref "/unit/configuration.md#configuration-routes" >}})
195195
are the most flexible and versatile part of the Unit configuration. Thus, they must be as
@@ -227,7 +227,7 @@ Some considerations:
227227

228228
</details>
229229

230-
## Protect App Data {#security-apps}
230+
## Protect app data {#security-apps}
231231

232232
**Rationale**: Unit's architecture involves many processes that operate
233233
together during app delivery; improper process permissions can make sensitive
@@ -649,7 +649,7 @@ shared during routing.
649649

650650
</details>
651651

652-
## Prune Debug and Access Logs {#security-logs}
652+
## Prune debug and access logs {#security-logs}
653653

654654
**Rationale**: Unit stores potentially sensitive data in its general and access
655655
logs; their size can also become a concern if debug mode is enabled.
@@ -753,7 +753,7 @@ ACLs.
753753

754754
</details>
755755

756-
## Add Restrictions, Isolation {#security-isolation}
756+
## Add restrictions, isolation {#security-isolation}
757757

758758
**Rationale**: If the underlying OS allows, Unit provides features that create an
759759
additional level of separation and containment for your apps, such as:

content/unit/howto/source.md

-1
Original file line numberDiff line numberDiff line change
@@ -379,7 +379,6 @@ or support for certain features:
379379
{{</bootstrap-table>}}
380380

381381

382-
(source-config-src-pcre)=
383382
<a name="source-config-src-pcre"></a>
384383

385384
By default, Unit relies on the locally installed version of the [PCRE](https://www.pcre.org) library to support regular expressions in

content/unit/news/2024/wasm-component-model-part-2.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ For more information about Wasmtime and installing it, see their [GitHub reposit
5656

5757
Once we have all the tools in place, we can create the Rust projects.
5858

59-
(tutorial-rust-based-wasm-component)=
59+
<a name="tutorial-rust-based-wasm-component"></a>
6060

6161
### Using the **wasi** Rust library
6262

content/unit/statusapi.md

+18-6
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,10 @@ Example:
7070
}
7171
```
7272

73+
---
74+
75+
## Modules
76+
7377
Each item in the **modules** object lists one of the currently loaded language
7478
modules, the installed version (or versions) of the module, and the path to the
7579
module file:
@@ -84,6 +88,9 @@ module file:
8488

8589
{{</bootstrap-table>}}
8690

91+
---
92+
93+
## Connections
8794

8895
The **connections** object offers the following Unit instance metrics:
8996

@@ -98,8 +105,6 @@ The **connections** object offers the following Unit instance metrics:
98105

99106
{{</bootstrap-table>}}
100107

101-
102-
103108
Example:
104109

105110
```json
@@ -117,6 +122,9 @@ refer to
117122
[Configuration Settings]({{< relref "/unit/configuration.md#configuration-stngs" >}}).
118123
{{< /note >}}
119124

125+
---
126+
127+
## Requests
120128

121129
The **requests** object currently exposes a single instance-wide metric:
122130

@@ -128,8 +136,6 @@ The **requests** object currently exposes a single instance-wide metric:
128136

129137
{{</bootstrap-table>}}
130138

131-
132-
133139
Example:
134140

135141
```json
@@ -138,6 +144,10 @@ Example:
138144
}
139145
```
140146

147+
---
148+
149+
## Applications
150+
141151
Each item in **applications** describes an app currently listed in the
142152
**/config/applications**
143153
[section]({{< relref "/unit/configuration.md#configuration-applications" >}}).
@@ -151,8 +161,6 @@ Each item in **applications** describes an app currently listed in the
151161

152162
{{</bootstrap-table>}}
153163

154-
155-
156164
Example:
157165

158166
```json
@@ -171,6 +179,10 @@ Example:
171179
}
172180
```
173181

182+
---
183+
184+
## Processes
185+
174186
The **processes** object exposes the following per-app metrics:
175187

176188
{{<bootstrap-table "table table-striped table-bordered">}}

content/unit/troubleshooting.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ the [control API]({{< relref "/unit/controlapi.md" >}}) for details:
9090
curl --unix-socket /path/to/control.unit.sock http://localhost/config/routes/2 # The step listed in the log
9191
```
9292

93-
### Debug Events {#troubleshooting-dbg-log}
93+
### Debug events {#troubleshooting-dbg-log}
9494

9595
Unit's log can be set to record **[debug]**-level events; the steps to enable this
9696
mode vary by install method.
@@ -150,7 +150,7 @@ Then recompile and reinstall Unit and your
150150
{{< /tabs >}}
151151

152152

153-
## Core Dumps {#troubleshooting-core-dumps}
153+
## Core dumps {#troubleshooting-core-dumps}
154154

155155
Core dumps help us investigate crashes; attach them when
156156
[reporting an issue]({{< relref "/unit/troubleshooting.md#troubleshooting-support" >}}).
@@ -308,7 +308,7 @@ After a crash, locate the core dump file:
308308
{{% /tab %}}
309309
{{< /tabs >}}
310310

311-
## Getting Support {#troubleshooting-support}
311+
## Getting support {#troubleshooting-support}
312312

313313
{{<bootstrap-table "table table-striped table-bordered">}}
314314

0 commit comments

Comments
 (0)