All of the documentation is now in Asciidoc format. Please see the introduction file for full details.
We also suggest reading the directory file, which describes the layout of this directory.
Please run the top-level configure script in order to create HTML
versions of the documentation.
If the local system has Antora installed, then you can run:
make docsite
The output HTML is placed in the following location:
./build/docsite/freeradius-server/latest/index.html
If Antora is not installed locally, it can usually be installed from
npm (a command available once you install Node.js):
npm i -g @antora/[email protected] @antora/[email protected]
The documentation for each module syntax, configuration, etc. is
auto-generated from the files in the raddb directory. Each
configuration file has some Asciidoc markup in the comments. The file
scripts/asciidoc/conf2adoc takes care of converting configuration
files to Asciidoc. See all.mk for specific commands.
When any documentation is built, the files in raddb are checked to
see if they are "out of date" with respect to the output .adoc
files. If so, the conf2adoc script is run to refresh the Asciidoc files.