Skip to content

Commit 27039a0

Browse files
committed
use Asciidoc headings in configuration files
not Markdown ones. the output is slightly different. perl -p -i -e 's/^# # /# = /;s/^# ## /# == /;s/^# ### /# === /;s/^# #### /# ==== /;' $(git grep -l '^# #' raddb/)
1 parent 57018ca commit 27039a0

File tree

167 files changed

+533
-530
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

167 files changed

+533
-530
lines changed

doc/antora/modules/reference/pages/raddb/clients.conf.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ security, packets from other IP addresses are ignored.
1010

1111

1212

13-
## Client subsection
13+
== Client subsection
1414

1515
A client is defined via a section called `client NAME { ... }`.
1616
The NAME field is mandatory, and is used as the "short name" of the
@@ -249,7 +249,7 @@ We *strongly recommend* that you set an idle timeout.
249249

250250

251251

252-
## Client examples
252+
== Client examples
253253

254254

255255

@@ -312,5 +312,5 @@ client localhost_ipv6 {
312312
#}
313313
```
314314

315-
// Copyright (C) 2025 Network RADIUS SAS. Licenced under CC-by-NC 4.0.
315+
// Copyright (C) 2026 Network RADIUS SAS. Licenced under CC-by-NC 4.0.
316316
// This documentation was developed by Network RADIUS SAS.

doc/antora/modules/reference/pages/raddb/debug.conf.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ packaging system. It is only for developers.
1212

1313

1414

15-
## The main configuration file.
15+
== The main configuration file.
1616

1717

1818
== Default Configuration
@@ -21,5 +21,5 @@ packaging system. It is only for developers.
2121
$INCLUDE ${confdir}/radiusd.conf
2222
```
2323

24-
// Copyright (C) 2025 Network RADIUS SAS. Licenced under CC-by-NC 4.0.
24+
// Copyright (C) 2026 Network RADIUS SAS. Licenced under CC-by-NC 4.0.
2525
// This documentation was developed by Network RADIUS SAS.

doc/antora/modules/reference/pages/raddb/dictionary.adoc

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33

44

5-
# Local dictionary definitions
5+
= Local dictionary definitions
66

77
This is the local dictionary file which can be
88
edited by local administrators. It will be loaded
@@ -26,7 +26,7 @@ This file exists for two purposes:
2626
process of migrating from version 3 to version 4. We
2727
recommend using the new names where possible.
2828

29-
## Dictionary loading order
29+
== Dictionary loading order
3030

3131
FreeRADIUS will automatically load the main dictionary files from:
3232

@@ -37,15 +37,15 @@ dictionaries from this file. However, if the `$INCLUDE` line is
3737
here, nothing bad will happen.
3838

3939

40-
## Dictionaries per Virtual Server
40+
== Dictionaries per Virtual Server
4141

4242
v4 also supports a `dictionary { ... }` subsection in a virtual
4343
server. If the attributes are used only in one virtual server,
4444
they should be defined there.
4545

4646

4747

48-
## Editing the dictionary
48+
== Editing the dictionary
4949

5050
Any new/changed attributes *must* be placed in this file.
5151
The pre-defined dictionaries *should not* be edited.
@@ -73,15 +73,15 @@ See https://tools.ietf.org/html/rfc6158[RFC 6158] for more details:
7373
http://ietf.org/rfc/rfc6158.txt
7474

7575

76-
## Example attributes
76+
== Example attributes
7777

7878
The attributes below are examples. You should edit them as
7979
required, or add your own.
8080

8181

8282

8383

84-
## v3 Compatibility and Migration
84+
== v3 Compatibility and Migration
8585

8686
By default, the server does NOT load the v3 names. While this
8787
behavior is done to simplify the server configuration, it can also
@@ -177,5 +177,5 @@ editor backup files, and others which are known to not be real files.
177177
$INCLUDE- dictionary.d/
178178
```
179179

180-
// Copyright (C) 2025 Network RADIUS SAS. Licenced under CC-by-NC 4.0.
180+
// Copyright (C) 2026 Network RADIUS SAS. Licenced under CC-by-NC 4.0.
181181
// This documentation was developed by Network RADIUS SAS.

doc/antora/modules/reference/pages/raddb/mods-available/always.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ specified, is 'fail'.
1313

1414

1515

16-
## Syntax
16+
== Syntax
1717

1818

1919
rcode:: Return code.
@@ -52,7 +52,7 @@ simulates the user having multilink sessions.
5252

5353

5454

55-
## xlat for peeking and poking the status
55+
== xlat for peeking and poking the status
5656

5757
An xlat based on the instance name can be called to change the status
5858
returned by the instance.
@@ -77,7 +77,7 @@ current status without affecting it call the xlat with an empty argument:
7777

7878

7979

80-
## Configuration Settings
80+
== Configuration Settings
8181

8282
The following default instances allow the use of return codes like
8383
`reject` or `ok` in `unlang` policies.
@@ -120,5 +120,5 @@ always updated {
120120
}
121121
```
122122

123-
// Copyright (C) 2025 Network RADIUS SAS. Licenced under CC-by-NC 4.0.
123+
// Copyright (C) 2026 Network RADIUS SAS. Licenced under CC-by-NC 4.0.
124124
// This documentation was developed by Network RADIUS SAS.

doc/antora/modules/reference/pages/raddb/mods-available/attr_filter.adoc

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ them, which should be rare). The value field uses standard regular expression sy
5151
| !~ | Regular Expression Not Equal
5252
|===
5353

54-
## Syntax
54+
== Syntax
5555

5656
The configuration items are:
5757

@@ -69,13 +69,13 @@ filename:: The `filename` with the attributes to filter.
6969

7070

7171

72-
## Configuration Settings
72+
== Configuration Settings
7373

7474
The following default instances.
7575

7676

7777

78-
### pre-proxy
78+
=== pre-proxy
7979

8080
Filters the attributes in the packets we send to
8181
the RADIUS home servers.
@@ -84,7 +84,7 @@ Add this before calling rlm_radius for proxying.
8484

8585

8686

87-
### post-proxy
87+
=== post-proxy
8888

8989
Filters the attributes received in replies from proxied
9090
servers, to make sure we send back to our RADIUS client
@@ -94,21 +94,21 @@ Add this after calling `rlm_radius` for proxying.
9494

9595

9696

97-
### access_reject
97+
=== access_reject
9898

9999
Enforce RFC requirements on the contents of `link:https://freeradius.org/rfc/rfc2865.html#Access-Reject[Access-Reject]`
100100
packets. This should be called from `send Access-Reject`.
101101

102102

103103

104-
### access_challenge
104+
=== access_challenge
105105

106106
Enforce RFC requirements on the contents of `link:https://freeradius.org/rfc/rfc2865.html#Access-Challenge[Access-Challenge]`
107107
packets. This is called from `send Access-Challenge`.
108108

109109

110110

111-
### accounting_response
111+
=== accounting_response
112112

113113
Enforce RFC requirements on the contents of the
114114
`link:https://freeradius.org/rfc/rfc2866.html#Accounting-Response[Accounting-Response]` packets. Called from the
@@ -145,5 +145,5 @@ attr_filter attr_filter.accounting_response {
145145
}
146146
```
147147

148-
// Copyright (C) 2025 Network RADIUS SAS. Licenced under CC-by-NC 4.0.
148+
// Copyright (C) 2026 Network RADIUS SAS. Licenced under CC-by-NC 4.0.
149149
// This documentation was developed by Network RADIUS SAS.

doc/antora/modules/reference/pages/raddb/mods-available/brotli.adoc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,11 @@ decompressing data using the Brotli algorithm.
99

1010

1111

12-
## Configuration Settings
12+
== Configuration Settings
1313

1414

1515

16-
### An example configuration
16+
=== An example configuration
1717

1818

1919
mode:: The compression mode to use.
@@ -66,11 +66,11 @@ The default is `no`.
6666

6767

6868

69-
## Expansions
69+
== Expansions
7070

7171
The rlm_ldap provides the below xlat's functions.
7272

73-
### %<inst>.compress(...)
73+
=== %<inst>.compress(...)
7474

7575
Ingests uncomprssed data and returns the compressed data.
7676

@@ -89,7 +89,7 @@ Ingests uncomprssed data and returns the compressed data.
8989
\0332\000\210\304&G(ɋ\031]\372l\265`\003\016\330\023L\002\332\375\344\b^\241\003\177YԜ浣D\254\223\230\002
9090
```
9191

92-
### %<inst>.decompress(...)
92+
=== %<inst>.decompress(...)
9393

9494
Ingests compressed data and emits the uncompressed data.
9595

@@ -125,5 +125,5 @@ brotli {
125125
}
126126
```
127127

128-
// Copyright (C) 2025 Network RADIUS SAS. Licenced under CC-by-NC 4.0.
128+
// Copyright (C) 2026 Network RADIUS SAS. Licenced under CC-by-NC 4.0.
129129
// This documentation was developed by Network RADIUS SAS.

doc/antora/modules/reference/pages/raddb/mods-available/cache.adoc

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ via `cache <nameN> { ... }`.
2626

2727

2828

29-
## Configuration Settings
29+
== Configuration Settings
3030

3131

3232
driver::
@@ -59,7 +59,7 @@ Driver specific options are:
5959

6060

6161

62-
### Htrie cache driver
62+
=== Htrie cache driver
6363

6464

6565
type:: Htrie backend type
@@ -74,7 +74,7 @@ type:: Htrie backend type
7474
|===
7575

7676

77-
### Memcached cache driver
77+
=== Memcached cache driver
7878

7979

8080
options:: Memcached configuration options.
@@ -88,7 +88,7 @@ pool:: Connection pool.
8888

8989

9090

91-
### Redis cache driver
91+
=== Redis cache driver
9292

9393

9494
server:: Redis Server name.
@@ -249,6 +249,7 @@ control.Cache-TTL:: Sets the TTL of an entry to be created, or
249249
| `Cache-TTL` of `0` | Expire the existing entry and create a new one.
250250
|===
251251

252+
252253
control.Cache-Status-Only:: If present and set to `yes` will
253254
prevent a new entry from being created, and existing entries from
254255
being merged. It will also alter the module's return codes.
@@ -437,5 +438,5 @@ cache {
437438
}
438439
```
439440

440-
// Copyright (C) 2025 Network RADIUS SAS. Licenced under CC-by-NC 4.0.
441+
// Copyright (C) 2026 Network RADIUS SAS. Licenced under CC-by-NC 4.0.
441442
// This documentation was developed by Network RADIUS SAS.

doc/antora/modules/reference/pages/raddb/mods-available/cache_eap.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ IP/port), but with the same contents.
5050

5151

5252

53-
## Configuration Settings
53+
== Configuration Settings
5454

5555

5656
key:: Cache key.
@@ -77,5 +77,5 @@ cache cache_eap {
7777
}
7878
```
7979

80-
// Copyright (C) 2025 Network RADIUS SAS. Licenced under CC-by-NC 4.0.
80+
// Copyright (C) 2026 Network RADIUS SAS. Licenced under CC-by-NC 4.0.
8181
// This documentation was developed by Network RADIUS SAS.

doc/antora/modules/reference/pages/raddb/mods-available/cache_tls.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,11 +25,11 @@ configuration.
2525

2626

2727

28-
## Configuration Settings
28+
== Configuration Settings
2929

3030

3131

32-
### TLS Session Configuration
32+
=== TLS Session Configuration
3333

3434

3535
driver:: `cache` driver.
@@ -48,7 +48,7 @@ update { ... }::
4848

4949

5050

51-
### OCSP Session Configuration
51+
=== OCSP Session Configuration
5252

5353
In addition to TLS sessions, the OCSP queries can be cached.
5454

@@ -85,5 +85,5 @@ cache cache_ocsp {
8585
}
8686
```
8787

88-
// Copyright (C) 2025 Network RADIUS SAS. Licenced under CC-by-NC 4.0.
88+
// Copyright (C) 2026 Network RADIUS SAS. Licenced under CC-by-NC 4.0.
8989
// This documentation was developed by Network RADIUS SAS.

doc/antora/modules/reference/pages/raddb/mods-available/chap.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ CHAP authentication requires access to the Password.Cleartext for the user.
1111
Standard Unix system authentication or passwords encrypted via `crypt()`
1212
are not compatible with CHAP.
1313

14-
## Configuration Settings
14+
== Configuration Settings
1515

1616
This module takes no configuration.
1717

@@ -24,5 +24,5 @@ chap {
2424
}
2525
```
2626

27-
// Copyright (C) 2025 Network RADIUS SAS. Licenced under CC-by-NC 4.0.
27+
// Copyright (C) 2026 Network RADIUS SAS. Licenced under CC-by-NC 4.0.
2828
// This documentation was developed by Network RADIUS SAS.

0 commit comments

Comments
 (0)