From 6da6765f91b0445e5676b782a2a25bd9e123737a Mon Sep 17 00:00:00 2001 From: "Alan T. DeKok" Date: Tue, 14 Jan 2025 16:30:52 -0500 Subject: [PATCH] move raddb to reference it's not it's own thing, it's part of the reference for the server. move the files git mv doc/antora/modules/raddb/pages doc/antora/modules/references/pages/raddb fix up the cross refs perl -p -i -e 's,xref:raddb:,xref:reference:raddb/,' $(git grep -l xref:raddb .) fix up doc/all.mk with change thingies move raddb/nav.adoc into references/nav.adoc, with one more level of nesting --- doc/all.mk | 8 +- doc/antora/modules/ROOT/pages/index.adoc | 4 +- .../pages/modules/ldap/authentication.adoc | 6 +- .../howto/pages/modules/chap/index.adoc | 4 +- .../pages/modules/configuring_modules.adoc | 2 +- .../ldap/base_configuration/index.adoc | 6 +- .../howto/pages/modules/ldap/index.adoc | 2 +- .../ldap/ldapsearch/locating_objects.adoc | 2 +- .../modules/installation/pages/upgrade.adoc | 4 +- doc/antora/modules/raddb/nav.adoc | 122 ----------------- doc/antora/modules/reference/nav.adoc | 123 ++++++++++++++++++ doc/antora/modules/reference/pages/index.adoc | 4 +- .../reference/pages/policy/different.adoc | 4 +- .../pages/raddb}/.gitignore | 0 .../pages/raddb}/certs/index.adoc | 0 .../pages/raddb}/clients.conf.adoc | 0 .../pages/raddb}/debug.conf.adoc | 0 .../pages/raddb}/dictionary.adoc | 0 .../pages/raddb}/experimental.conf.adoc | 0 .../pages/raddb}/format.adoc | 0 .../pages/raddb}/global.d/index.adoc | 0 .../pages/raddb}/global.d/ldap.adoc | 0 .../pages/raddb}/global.d/python.adoc | 0 .../pages/raddb}/index.adoc | 0 .../raddb}/mods-available/abfab_psk_sql.adoc | 0 .../raddb}/mods-available/all_modules.adoc | 0 .../pages/raddb}/mods-available/always.adoc | 0 .../raddb}/mods-available/attr_filter.adoc | 0 .../pages/raddb}/mods-available/brotli.adoc | 0 .../pages/raddb}/mods-available/cache.adoc | 0 .../raddb}/mods-available/cache_eap.adoc | 0 .../raddb}/mods-available/cache_tls.adoc | 0 .../pages/raddb}/mods-available/chap.adoc | 0 .../pages/raddb}/mods-available/cipher.adoc | 0 .../pages/raddb}/mods-available/client.adoc | 0 .../raddb}/mods-available/couchbase.adoc | 0 .../pages/raddb}/mods-available/csv.adoc | 0 .../pages/raddb}/mods-available/cui.adoc | 0 .../pages/raddb}/mods-available/date.adoc | 0 .../pages/raddb}/mods-available/delay.adoc | 0 .../pages/raddb}/mods-available/detail.adoc | 0 .../mods-available/detail.example.com.adoc | 0 .../raddb}/mods-available/detail.log.adoc | 0 .../pages/raddb}/mods-available/dhcpv4.adoc | 0 .../pages/raddb}/mods-available/dict.adoc | 0 .../pages/raddb}/mods-available/digest.adoc | 0 .../pages/raddb}/mods-available/eap.adoc | 0 .../raddb}/mods-available/eap_inner.adoc | 0 .../pages/raddb}/mods-available/echo.adoc | 0 .../pages/raddb}/mods-available/escape.adoc | 0 .../raddb}/mods-available/etc_group.adoc | 0 .../pages/raddb}/mods-available/exec.adoc | 0 .../pages/raddb}/mods-available/files.adoc | 4 +- .../pages/raddb}/mods-available/icmp.adoc | 0 .../pages/raddb}/mods-available/idn.adoc | 0 .../pages/raddb}/mods-available/imap.adoc | 0 .../pages/raddb}/mods-available/index.adoc | 0 .../pages/raddb}/mods-available/isc_dhcp.adoc | 0 .../pages/raddb}/mods-available/json.adoc | 0 .../pages/raddb}/mods-available/krb5.adoc | 0 .../pages/raddb}/mods-available/ldap.adoc | 0 .../pages/raddb}/mods-available/linelog.adoc | 0 .../pages/raddb}/mods-available/logtee.adoc | 0 .../pages/raddb}/mods-available/lua.adoc | 0 .../pages/raddb}/mods-available/mac2ip.adoc | 0 .../pages/raddb}/mods-available/mac2vlan.adoc | 0 .../pages/raddb}/mods-available/mruby.adoc | 0 .../pages/raddb}/mods-available/mschap.adoc | 0 .../raddb}/mods-available/ntlm_auth.adoc | 0 .../raddb}/mods-available/opendirectory.adoc | 0 .../pages/raddb}/mods-available/pam.adoc | 0 .../pages/raddb}/mods-available/pap.adoc | 0 .../pages/raddb}/mods-available/passwd.adoc | 0 .../pages/raddb}/mods-available/perl.adoc | 0 .../pages/raddb}/mods-available/python.adoc | 0 .../pages/raddb}/mods-available/radius.adoc | 0 .../pages/raddb}/mods-available/radutmp.adoc | 0 .../pages/raddb}/mods-available/redis.adoc | 0 .../raddb}/mods-available/redis_ippool.adoc | 0 .../pages/raddb}/mods-available/rediswho.adoc | 0 .../raddb}/mods-available/redundant_sql.adoc | 0 .../pages/raddb}/mods-available/rest.adoc | 0 .../raddb}/mods-available/smbpasswd.adoc | 0 .../pages/raddb}/mods-available/smtp.adoc | 0 .../raddb}/mods-available/sometimes.adoc | 0 .../pages/raddb}/mods-available/sql.adoc | 2 +- .../raddb}/mods-available/sqlcounter.adoc | 0 .../raddb}/mods-available/sqlippool.adoc | 0 .../pages/raddb}/mods-available/sradutmp.adoc | 0 .../pages/raddb}/mods-available/stats.adoc | 0 .../pages/raddb}/mods-available/tacacs.adoc | 0 .../pages/raddb}/mods-available/totp.adoc | 0 .../pages/raddb}/mods-available/unbound.adoc | 0 .../pages/raddb}/mods-available/unix.adoc | 0 .../pages/raddb}/mods-available/unpack.adoc | 0 .../pages/raddb}/mods-available/utf8.adoc | 0 .../pages/raddb}/mods-available/wimax.adoc | 0 .../pages/raddb}/mods-available/winbind.adoc | 0 .../pages/raddb}/mods-available/yubikey.adoc | 0 .../pages/raddb}/mods-config/files/users.adoc | 6 +- .../pages/raddb}/mods-config/index.adoc | 0 .../pages/raddb}/radclient.conf.adoc | 0 .../pages/raddb}/radiusd.conf.adoc | 0 .../pages/raddb}/radrelay.conf.adoc | 0 .../raddb}/sites-available/abfab-tls.adoc | 0 .../raddb}/sites-available/abfab-tr-idp.adoc | 0 .../pages/raddb}/sites-available/arp.adoc | 0 .../pages/raddb}/sites-available/bfd.adoc | 0 .../raddb}/sites-available/buffered-sql.adoc | 0 .../raddb}/sites-available/challenge.adoc | 0 .../sites-available/channel_bindings.adoc | 0 .../raddb}/sites-available/check-eap-tls.adoc | 0 .../raddb}/sites-available/coa-relay.adoc | 0 .../pages/raddb}/sites-available/coa.adoc | 0 .../sites-available/control-socket.adoc | 0 .../copy-acct-to-home-server.adoc | 0 .../pages/raddb}/sites-available/cron.adoc | 0 .../sites-available/decoupled-accounting.adoc | 0 .../pages/raddb}/sites-available/default.adoc | 0 .../pages/raddb}/sites-available/detail.adoc | 0 .../pages/raddb}/sites-available/dhcp.adoc | 0 .../raddb}/sites-available/dhcp.relay.adoc | 0 .../pages/raddb}/sites-available/dhcpv6.adoc | 0 .../pages/raddb}/sites-available/dns.adoc | 0 .../sites-available/dynamic-clients.adoc | 0 .../raddb}/sites-available/eap-aka-sim.adoc | 0 .../pages/raddb}/sites-available/example.adoc | 0 .../pages/raddb}/sites-available/index.adoc | 0 .../raddb}/sites-available/inner-tunnel.adoc | 0 .../raddb}/sites-available/ldap_sync.adoc | 0 .../pages/raddb}/sites-available/load.adoc | 0 .../raddb}/sites-available/originate-coa.adoc | 0 .../sites-available/proxy-inner-tunnel.adoc | 0 .../raddb}/sites-available/radius-acct.adoc | 0 .../sites-available/resource-check.adoc | 0 .../robust-proxy-accounting.adoc | 0 .../pages/raddb}/sites-available/status.adoc | 0 .../pages/raddb}/sites-available/tacacs.adoc | 0 .../raddb}/sites-available/test_load.adoc | 0 .../raddb}/sites-available/tls-cache.adoc | 0 .../pages/raddb}/sites-available/tls.adoc | 0 .../sites-available/virtual.example.com.adoc | 0 .../pages/raddb}/sites-available/vmps.adoc | 0 .../pages/raddb}/templates.conf.adoc | 0 .../pages/raddb}/trigger.conf.adoc | 0 .../reference/pages/unlang/interpreter.adoc | 20 +-- .../reference/pages/unlang/keywords.adoc | 2 +- .../pages/unlang/module_builtin.adoc | 2 +- .../reference/pages/xlat/character.adoc | 8 +- .../tutorials/pages/final_group_project.adoc | 20 +-- .../tutorials/pages/unlang_return_codes.adoc | 10 +- 151 files changed, 183 insertions(+), 182 deletions(-) delete mode 100644 doc/antora/modules/raddb/nav.adoc rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/.gitignore (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/certs/index.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/clients.conf.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/debug.conf.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/dictionary.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/experimental.conf.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/format.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/global.d/index.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/global.d/ldap.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/global.d/python.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/index.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/mods-available/abfab_psk_sql.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/mods-available/all_modules.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/mods-available/always.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/mods-available/attr_filter.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/mods-available/brotli.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/mods-available/cache.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/mods-available/cache_eap.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/mods-available/cache_tls.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/mods-available/chap.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/mods-available/cipher.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/mods-available/client.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/mods-available/couchbase.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/mods-available/csv.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/mods-available/cui.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/mods-available/date.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/mods-available/delay.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/mods-available/detail.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/mods-available/detail.example.com.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/mods-available/detail.log.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/mods-available/dhcpv4.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/mods-available/dict.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/mods-available/digest.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/mods-available/eap.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/mods-available/eap_inner.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/mods-available/echo.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/mods-available/escape.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/mods-available/etc_group.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/mods-available/exec.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/mods-available/files.adoc (89%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/mods-available/icmp.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/mods-available/idn.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/mods-available/imap.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/mods-available/index.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/mods-available/isc_dhcp.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/mods-available/json.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/mods-available/krb5.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/mods-available/ldap.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/mods-available/linelog.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/mods-available/logtee.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/mods-available/lua.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/mods-available/mac2ip.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/mods-available/mac2vlan.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/mods-available/mruby.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/mods-available/mschap.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/mods-available/ntlm_auth.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/mods-available/opendirectory.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/mods-available/pam.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/mods-available/pap.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/mods-available/passwd.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/mods-available/perl.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/mods-available/python.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/mods-available/radius.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/mods-available/radutmp.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/mods-available/redis.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/mods-available/redis_ippool.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/mods-available/rediswho.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/mods-available/redundant_sql.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/mods-available/rest.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/mods-available/smbpasswd.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/mods-available/smtp.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/mods-available/sometimes.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/mods-available/sql.adoc (99%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/mods-available/sqlcounter.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/mods-available/sqlippool.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/mods-available/sradutmp.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/mods-available/stats.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/mods-available/tacacs.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/mods-available/totp.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/mods-available/unbound.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/mods-available/unix.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/mods-available/unpack.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/mods-available/utf8.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/mods-available/wimax.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/mods-available/winbind.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/mods-available/yubikey.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/mods-config/files/users.adoc (97%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/mods-config/index.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/radclient.conf.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/radiusd.conf.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/radrelay.conf.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/sites-available/abfab-tls.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/sites-available/abfab-tr-idp.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/sites-available/arp.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/sites-available/bfd.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/sites-available/buffered-sql.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/sites-available/challenge.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/sites-available/channel_bindings.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/sites-available/check-eap-tls.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/sites-available/coa-relay.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/sites-available/coa.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/sites-available/control-socket.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/sites-available/copy-acct-to-home-server.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/sites-available/cron.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/sites-available/decoupled-accounting.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/sites-available/default.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/sites-available/detail.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/sites-available/dhcp.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/sites-available/dhcp.relay.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/sites-available/dhcpv6.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/sites-available/dns.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/sites-available/dynamic-clients.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/sites-available/eap-aka-sim.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/sites-available/example.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/sites-available/index.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/sites-available/inner-tunnel.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/sites-available/ldap_sync.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/sites-available/load.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/sites-available/originate-coa.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/sites-available/proxy-inner-tunnel.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/sites-available/radius-acct.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/sites-available/resource-check.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/sites-available/robust-proxy-accounting.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/sites-available/status.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/sites-available/tacacs.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/sites-available/test_load.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/sites-available/tls-cache.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/sites-available/tls.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/sites-available/virtual.example.com.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/sites-available/vmps.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/templates.conf.adoc (100%) rename doc/antora/modules/{raddb/pages => reference/pages/raddb}/trigger.conf.adoc (100%) diff --git a/doc/all.mk b/doc/all.mk index dcc8cd67b6..849e57fcdc 100644 --- a/doc/all.mk +++ b/doc/all.mk @@ -70,7 +70,7 @@ clean: clean.doc # Our "conf to asciidoc" stuff. # CONF_FILES := $(filter-out %~,$(wildcard raddb/*conf raddb/mods-available/* raddb/sites-available/* raddb/dictionary)) -BASE_ADOC_FILES := $(wildcard doc/*.adoc doc/*/*.adoc doc/*/*/*.adoc) doc/raddb/mods-available/all_modules.adoc +BASE_ADOC_FILES := $(wildcard doc/*.adoc doc/*/*.adoc doc/*/*/*.adoc) doc/antora/modules/reference/pages/raddb/mods-available/all_modules.adoc ADOC_FILES := $(BASE_ADOC_FILES) $(AUTO_ADOC_FILES) PDF_FILES := $(patsubst doc/%.adoc,doc/%.pdf,$(ADOC_FILES)) @@ -197,7 +197,7 @@ endif # # Conf files get converted to Asciidoc via our own magic script. # -doc/antora/modules/raddb/pages/%.adoc: raddb/% +doc/antora/modules/reference/pages/raddb/%.adoc: raddb/% @echo ADOC $^ ${Q}mkdir -p $(dir $@) ${Q}perl -pi -e 's/^# ([^ \t])/# $$1/;s/^([ \t]+)# ([^ \t])/$$1# $$2/;s/[ \t]+$$//' $^ @@ -207,7 +207,7 @@ doc/antora/modules/raddb/pages/%.adoc: raddb/% # Simple rule for lazy people. # .PHONY: doc.raddb -doc.raddb: $(patsubst raddb/%,doc/antora/modules/raddb/pages/%.adoc,$(CONF_FILES)) +doc.raddb: $(patsubst raddb/%,doc/antora/modules/reference/pages/raddb/%.adoc,$(CONF_FILES)) # # antora rebuilds the entire documentation site on each run @@ -257,7 +257,7 @@ doc/raddb/%.adoc: raddb/% # IGNORE_MODULES := $(patsubst %,src/modules/%/README.md,rlm_dict rlm_securid rlm_sigtran rlm_test) README_MODULES := $(filter-out $(IGNORE_MODULES), $(wildcard src/modules/rlm_*/README.md)) -doc/raddb/mods-available/all_modules.adoc: $(README_MODULES) +doc/antora/modules/reference/pages/raddb/mods-available/all_modules.adoc: $(README_MODULES) @echo ADOC mods-available/all_modules.adoc ${Q}./scripts/asciidoc/mod_readme2adoc $(README_MODULES) > $@ endif diff --git a/doc/antora/modules/ROOT/pages/index.adoc b/doc/antora/modules/ROOT/pages/index.adoc index 6892986542..df45e085f8 100644 --- a/doc/antora/modules/ROOT/pages/index.adoc +++ b/doc/antora/modules/ROOT/pages/index.adoc @@ -39,7 +39,7 @@ desired outcome. At a high level, the subject areas describe: * xref:concepts:index.adoc[Concepts] and introduction for newcomers. * xref:installation:index.adoc[Installing] and xref:installation:upgrade.adoc[upgrading] FreeRADIUS. * The syntax of the xref:reference:unlang/index.adoc[unlang] processing language. -* The xref:raddb:index.adoc[configuration files] located in `/etc/raddb/`, or `/etc/freeradius/` +* The xref:reference:raddb/index.adoc[configuration files] located in `/etc/raddb/`, or `/etc/freeradius/` * Various xref:howto:index.adoc[how-to] guides. * xref:developers:index.adoc[Developer documentation]. @@ -145,7 +145,7 @@ A detailed xref:reference:unlang/index.adoc[unlang] reference guide is also avai This section describes the syntax and functionality of the keywords, data types, etc. used in the `unlang` processing language. -All of the xref:raddb:index.adoc[configuration files] are available in +All of the xref:reference:raddb/index.adoc[configuration files] are available in hypertext format. It can often be easier to read the configuration files in a nicely formatted version, instead of as a fixed-width font in a text editor. diff --git a/doc/antora/modules/concepts/pages/modules/ldap/authentication.adoc b/doc/antora/modules/concepts/pages/modules/ldap/authentication.adoc index 02990567fd..52679aeafc 100644 --- a/doc/antora/modules/concepts/pages/modules/ldap/authentication.adoc +++ b/doc/antora/modules/concepts/pages/modules/ldap/authentication.adoc @@ -21,7 +21,7 @@ PAP:: Use "bind as user" MS-CHAP:: -Use xref:raddb:mods-available/ntlm_auth.adoc[`ntlm`] or xref:raddb:mods-available/winbind.adoc[`winbind`]. +Use xref:reference:raddb/mods-available/ntlm_auth.adoc[`ntlm`] or xref:reference:raddb/mods-available/winbind.adoc[`winbind`]. Due to the limitations of Active Directory, There are unfortunately no other possible choices. @@ -121,7 +121,7 @@ formats. There is sufficient information in the password values to determine what format it is in (base64, binary, or text), and what password "encryption" mechanism has been used (crypt, MD5, SHA, SSHA2, SHA3, etc). All that is necessary is that the -xref:raddb:mods-available/ldap.adoc[ldap module] be configured to map +xref:reference:raddb/mods-available/ldap.adoc[ldap module] be configured to map the `userPassword` LDAP field to the `&control.Password.With-Header` attribute in FreeRADIUS. FreeRADIUS will then "do the right thing" to authenticate the user. @@ -129,7 +129,7 @@ authenticate the user. This mapping is done in the default module configuration. There are no additional changes required for FreeRADIUS to correctly read and decode the `userPassword` field from LDAP. Please see the -xref:raddb:mods-available/pap.adoc[pap module] for a full list of +xref:reference:raddb/mods-available/pap.adoc[pap module] for a full list of supported password "encryption" formats. == Additional Considerations diff --git a/doc/antora/modules/howto/pages/modules/chap/index.adoc b/doc/antora/modules/howto/pages/modules/chap/index.adoc index 128290c281..8472f4d7a9 100644 --- a/doc/antora/modules/howto/pages/modules/chap/index.adoc +++ b/doc/antora/modules/howto/pages/modules/chap/index.adoc @@ -2,7 +2,7 @@ = Configuring the CHAP module -The xref:raddb:mods-available/chap.adoc[mods-available/chap] +The xref:reference:raddb/mods-available/chap.adoc[mods-available/chap] configuration file describes the configuration parameters accepted by the CHAP module, and what they do. This document explains how to perform testing with the CHAP module. @@ -11,7 +11,7 @@ include::howto:partial$pre_test.adoc[] == Editing mods-available/chap -The xref:raddb:mods-available/chap.adoc[mods-available/chap] module +The xref:reference:raddb/mods-available/chap.adoc[mods-available/chap] module contains no configuration items, and does not need to be edited. == Enabling mods-available/chap diff --git a/doc/antora/modules/howto/pages/modules/configuring_modules.adoc b/doc/antora/modules/howto/pages/modules/configuring_modules.adoc index 73251e99b8..2f7295ea7f 100644 --- a/doc/antora/modules/howto/pages/modules/configuring_modules.adoc +++ b/doc/antora/modules/howto/pages/modules/configuring_modules.adoc @@ -1,7 +1,7 @@ = Configuring a Module The configuration files in -xref:raddb:mods-available/index.adoc[mods-available/] file describe +xref:reference:raddb/mods-available/index.adoc[mods-available/] file describe the configuration parameters accepted by each module, and what they do. This document explains how to perform generic testing with any module. diff --git a/doc/antora/modules/howto/pages/modules/ldap/base_configuration/index.adoc b/doc/antora/modules/howto/pages/modules/ldap/base_configuration/index.adoc index 79abd6a0c7..fc3a0b00cc 100644 --- a/doc/antora/modules/howto/pages/modules/ldap/base_configuration/index.adoc +++ b/doc/antora/modules/howto/pages/modules/ldap/base_configuration/index.adoc @@ -2,9 +2,9 @@ The configuration step should be little more than xref:modules/ldap/ldapsearch/index.adoc#_translating_ldapsearch_arguments_to_rlm_ldap_configuration_items[copying the parameters used by ldapsearch] -to the xref:raddb:mods-available/ldap.adoc[ldap module] configuration file. +to the xref:reference:raddb/mods-available/ldap.adoc[ldap module] configuration file. -The xref:raddb:mods-available/ldap.adoc[ldap module] configuration file +The xref:reference:raddb/mods-available/ldap.adoc[ldap module] configuration file describes the configuration parameters accepted by the module, and what they do. include::howto:partial$pre_test.adoc[] @@ -22,7 +22,7 @@ command-line options to that tool using the xref:modules/ldap/ldapsearch/index.adoc#_translating_ldapsearch_arguments_to_rlm_ldap_configuration_items[translation table] on that page. At a minimum you will need to set the following configuration items -in in xref:raddb:mods-available/ldap.adoc[mods-available/ldap] using +in in xref:reference:raddb/mods-available/ldap.adoc[mods-available/ldap] using the values you discovered running the xref:modules/ldap/ldapsearch/index.adoc[ldapsearch] tests. diff --git a/doc/antora/modules/howto/pages/modules/ldap/index.adoc b/doc/antora/modules/howto/pages/modules/ldap/index.adoc index 94a69f8aa4..1569c00df5 100644 --- a/doc/antora/modules/howto/pages/modules/ldap/index.adoc +++ b/doc/antora/modules/howto/pages/modules/ldap/index.adoc @@ -62,7 +62,7 @@ tutorial section. == Sections in this tutorial For features and configuration items not covered by this tutorial series -xref:raddb:mods-available/ldap.adoc[mods-available/ldap] page provides a complete +xref:reference:raddb/mods-available/ldap.adoc[mods-available/ldap] page provides a complete reference for all the configuration items available for the rlm_ldap module. === xref:modules/ldap/base_configuration/index.adoc[Base configuration] diff --git a/doc/antora/modules/howto/pages/modules/ldap/ldapsearch/locating_objects.adoc b/doc/antora/modules/howto/pages/modules/ldap/ldapsearch/locating_objects.adoc index 5c2475135c..f5f696a324 100644 --- a/doc/antora/modules/howto/pages/modules/ldap/ldapsearch/locating_objects.adoc +++ b/doc/antora/modules/howto/pages/modules/ldap/ldapsearch/locating_objects.adoc @@ -72,7 +72,7 @@ result: 0 Success when the user logs in to services. <5> A base64 encoded `userPassword` attribute. This shows the LDAP directory is willing to provided user password hashes. These hashes can be used by - the xref:raddb:mods-available/pap.adoc[pap] module to authenticate the + the xref:reference:raddb/mods-available/pap.adoc[pap] module to authenticate the user locally without the overhead of additional bind operations. ==== diff --git a/doc/antora/modules/installation/pages/upgrade.adoc b/doc/antora/modules/installation/pages/upgrade.adoc index 3892e3fce0..69d4ac738d 100644 --- a/doc/antora/modules/installation/pages/upgrade.adoc +++ b/doc/antora/modules/installation/pages/upgrade.adoc @@ -124,7 +124,7 @@ sections for their replacements. The `log` section has been updated to remove many configuration items which are specific to RADIUS, and to Access-Request packets. Please see `sites-available/default`, and look for the `Access-Request` -subsection there. See also xref:raddb:templates.conf.adoc[`templates.conf`] +subsection there. See also xref:reference:raddb/templates.conf.adoc[`templates.conf`] for a way to regain one global configuration for `Access-Request` packets. @@ -138,7 +138,7 @@ moved to the `mods-available/` and `mods-enabled/` directories. i.e. in version 4, just list the virtual module in a file, as if it was a real module. -See the xref:raddb:mods-available/redundant_sql.adoc[redundant_sql] module +See the xref:reference:raddb/mods-available/redundant_sql.adoc[redundant_sql] module for more information. In short, a virtual module can be put into the `mods-enabled` directory as with any other module, as with the following text: diff --git a/doc/antora/modules/raddb/nav.adoc b/doc/antora/modules/raddb/nav.adoc deleted file mode 100644 index 1c95aed0b4..0000000000 --- a/doc/antora/modules/raddb/nav.adoc +++ /dev/null @@ -1,122 +0,0 @@ -* xref:index.adoc[Configuration] -** xref:format.adoc[Format of the Configuration Files] - -** xref:certs/index.adoc[Certificates] - -** xref:global.d/index.adoc[Global Configuration] -** xref:global.d/ldap.adoc[ldap] -** xref:global.d/python.adoc[ldap] - -** xref:mods-available/index.adoc[Modules] -*** xref:mods-available/all_modules.adoc[Summary of all modules] -*** xref:mods-available/abfab_psk_sql.adoc[ADFAB PSK] -*** xref:mods-available/always.adoc[Always] -*** xref:mods-available/attr_filter.adoc[Attr_filter] -*** xref:mods-available/cache.adoc[Cache] -*** xref:mods-available/cache_eap.adoc[Cache EAP] -*** xref:mods-available/cache_tls.adoc[Cache TLS Session] -*** xref:mods-available/chap.adoc[CHAP module] -*** xref:mods-available/cipher.adoc[Cipher] -*** xref:mods-available/client.adoc[Client] -*** xref:mods-available/couchbase.adoc[Couchbase] -*** xref:mods-available/csv.adoc[CSV] -*** xref:mods-available/cui.adoc[CUI] -*** xref:mods-available/date.adoc[Date] -*** xref:mods-available/delay.adoc[Delay] -*** xref:mods-available/detail.adoc[Detail] -*** xref:mods-available/detail.example.com.adoc[Detail (Sample)] -*** xref:mods-available/detail.log.adoc[Detail (Log Sample)] -*** xref:mods-available/dhcpv4.adoc[DHCPv4] -*** xref:mods-available/dict.adoc[Dict] -*** xref:mods-available/digest.adoc[Digest] -*** xref:mods-available/eap.adoc[EAP] -*** xref:mods-available/eap_inner.adoc[EAP/Inner] -*** xref:mods-available/echo.adoc[Echo] -*** xref:mods-available/escape.adoc[Escape] -*** xref:mods-available/etc_group.adoc[etc_group] -*** xref:mods-available/exec.adoc[Exec] -*** xref:mods-available/files.adoc[Files] -**** xref:mods-config/files/users.adoc[users file format] -*** xref:mods-available/idn.adoc[IDN] -*** xref:mods-available/isc_dhcp.adoc[ISC DHCP] -*** xref:mods-available/imap.adoc[IMAP] -*** xref:mods-available/json.adoc[JSON] -*** xref:mods-available/krb5.adoc[Kerberos] -*** xref:mods-available/ldap.adoc[LDAP (Lightweight Directory Access Protocol)] -*** xref:mods-available/linelog.adoc[Linelog] -*** xref:mods-available/logtee.adoc[Logtee] -*** xref:mods-available/lua.adoc[Lua] -*** xref:mods-available/mac2ip.adoc[Mac2IP] -*** xref:mods-available/mac2vlan.adoc[Mac2Vlan] -*** xref:mods-available/mschap.adoc[Microsoft CHAP authentication] -*** xref:mods-available/ntlm_auth.adoc[NTLM Auth] -*** xref:mods-available/opendirectory.adoc[OpenDirectory] -*** xref:mods-available/pam.adoc[Pluggable Authentication] -*** xref:mods-available/pap.adoc[PAP] -*** xref:mods-available/passwd.adoc[Passwd] -*** xref:mods-available/perl.adoc[Perl] -*** xref:mods-available/python.adoc[Python] -*** xref:mods-available/radius.adoc[Radius] -*** xref:mods-available/radutmp.adoc[Radutmp] -*** xref:mods-available/redis.adoc[REDIS] -*** xref:mods-available/redis_ippool.adoc[Redis IP Pool] -*** xref:mods-available/rediswho.adoc[REDISWho] -*** xref:mods-available/redundant_sql.adoc[redundant_sql] -*** xref:mods-available/rest.adoc[Rest] -*** xref:mods-available/mruby.adoc[Ruby] -*** xref:mods-available/smbpasswd.adoc[SMBPasswd] -*** xref:mods-available/sometimes.adoc[Sometimes] -*** xref:mods-available/sql.adoc[SQL] -*** xref:mods-available/sqlcounter.adoc[SQL Counter] -*** xref:mods-available/sqlippool.adoc[SQL-IP-Pool] -*** xref:mods-available/sradutmp.adoc[sRadutmp] -*** xref:mods-available/stats.adoc[Stats] -*** xref:mods-available/totp.adoc[TOTP] -*** xref:mods-available/unbound.adoc[Unbound] -*** xref:mods-available/unix.adoc[Unix] -*** xref:mods-available/unpack.adoc[Unpack] -*** xref:mods-available/utf8.adoc[UTF-8] -*** xref:mods-available/wimax.adoc[WiMAX] -*** xref:mods-available/winbind.adoc[Winbind] -*** xref:mods-available/yubikey.adoc[Yubikey] - -** xref:index.adoc[Virtual Servers] -*** xref:sites-available/abfab-tls.adoc[ABFAB: Listening on TLS] -*** xref:sites-available/abfab-tr-idp.adoc[ABFAB: Trust Router] -*** xref:sites-available/arp.adoc[ARP Virtual Server] -*** xref:sites-available/bfd.adoc[BFD - Bidirectional Forwarding Detection] -*** xref:sites-available/buffered-sql.adoc[Buffered SQL] -*** xref:sites-available/challenge.adoc[Challenge] -*** xref:sites-available/channel_bindings.adoc[Channel Bindings] -*** xref:sites-available/check-eap-tls.adoc[Check EAP-TLS] -*** xref:sites-available/coa.adoc[CoA] -*** xref:sites-available/control-socket.adoc[Control Socket Interface.] -*** xref:sites-available/copy-acct-to-home-server.adoc[Copy ACCT to Home Server] -*** xref:sites-available/decoupled-accounting.adoc[Decoupled Accounting] -*** xref:sites-available/detail.adoc[Detail] -*** xref:sites-available/dhcp.adoc[Dhcp] -*** xref:sites-available/dhcp.relay.adoc[Dhcp Relay] -*** xref:sites-available/dynamic-clients.adoc[Dynamic Clients] -*** xref:sites-available/example.adoc[Example] -*** xref:sites-available/inner-tunnel.adoc[Inner Tunnel] -*** xref:sites-available/ldap_sync.adoc[LDAP Sync] -*** xref:sites-available/originate-coa.adoc[Originate CoA-Request packets] -*** xref:sites-available/proxy-inner-tunnel.adoc[Proxy Inner Tunnel] -*** xref:sites-available/radius-acct.adoc[Radius Acct] -*** xref:sites-available/robust-proxy-accounting.adoc[Robust Proxy Accounting] -*** xref:sites-available/status.adoc[Status] -*** xref:sites-available/tacacs.adoc[Tacacs] -*** xref:sites-available/default.adoc[The default Virtual Server] -*** xref:sites-available/tls-cache.adoc[TLS Cache] -*** xref:sites-available/tls.adoc[TLS] -*** xref:sites-available/virtual.example.com.adoc[virtual.example.com] -*** xref:sites-available/vmps.adoc[VMPS] -*** xref:experimental.conf.adoc[Experimental modules] - -** xref:clients.conf.adoc[Client Definitions] -** xref:debug.conf.adoc[Debugging configuration] -** xref:dictionary.adoc[Local dictionary definitions] -** xref:radrelay.conf.adoc[Radrelay Configuration] -** xref:radiusd.conf.adoc[Server Configuration File] -** xref:templates.conf.adoc[Templates] -** xref:trigger.conf.adoc[Triggers] diff --git a/doc/antora/modules/reference/nav.adoc b/doc/antora/modules/reference/nav.adoc index 0c64019fd7..c6e0780234 100644 --- a/doc/antora/modules/reference/nav.adoc +++ b/doc/antora/modules/reference/nav.adoc @@ -117,3 +117,126 @@ *** xref:man/radiusd.adoc[radiusd] *** xref:man/radmin.adoc[radmin] *** xref:man/radsniff.adoc[radsniff] + +** xref:index.adoc[Configuration Files] +*** xref:format.adoc[Format of the Configuration Files] + +*** xref:certs/index.adoc[Certificates] + +*** xref:global.d/index.adoc[Global Configuration] +*** xref:global.d/ldap.adoc[ldap] +*** xref:global.d/python.adoc[ldap] + +*** xref:mods-available/index.adoc[Modules] +**** xref:mods-available/all_modules.adoc[Summary of all modules] +**** xref:mods-available/abfab_psk_sql.adoc[ADFAB PSK] +**** xref:mods-available/always.adoc[Always] +**** xref:mods-available/attr_filter.adoc[Attr_filter] +**** xref:mods-available/cache.adoc[Cache] +**** xref:mods-available/cache_eap.adoc[Cache EAP] +**** xref:mods-available/cache_tls.adoc[Cache TLS Session] +**** xref:mods-available/chap.adoc[CHAP module] +**** xref:mods-available/cipher.adoc[Cipher] +**** xref:mods-available/client.adoc[Client] +**** xref:mods-available/couchbase.adoc[Couchbase] +**** xref:mods-available/csv.adoc[CSV] +**** xref:mods-available/cui.adoc[CUI] +**** xref:mods-available/date.adoc[Date] +**** xref:mods-available/delay.adoc[Delay] +**** xref:mods-available/detail.adoc[Detail] +**** xref:mods-available/detail.example.com.adoc[Detail (Sample)] +**** xref:mods-available/detail.log.adoc[Detail (Log Sample)] +**** xref:mods-available/dhcpv4.adoc[DHCPv4] +**** xref:mods-available/dict.adoc[Dict] +**** xref:mods-available/digest.adoc[Digest] +**** xref:mods-available/eap.adoc[EAP] +**** xref:mods-available/eap_inner.adoc[EAP/Inner] +**** xref:mods-available/echo.adoc[Echo] +**** xref:mods-available/escape.adoc[Escape] +**** xref:mods-available/etc_group.adoc[etc_group] +**** xref:mods-available/exec.adoc[Exec] +**** xref:mods-available/files.adoc[Files] +***** xref:mods-config/files/users.adoc[users file format] +**** xref:mods-available/idn.adoc[IDN] +**** xref:mods-available/isc_dhcp.adoc[ISC DHCP] +**** xref:mods-available/imap.adoc[IMAP] +**** xref:mods-available/json.adoc[JSON] +**** xref:mods-available/krb5.adoc[Kerberos] +**** xref:mods-available/ldap.adoc[LDAP (Lightweight Directory Access Protocol)] +**** xref:mods-available/linelog.adoc[Linelog] +**** xref:mods-available/logtee.adoc[Logtee] +**** xref:mods-available/lua.adoc[Lua] +**** xref:mods-available/mac2ip.adoc[Mac2IP] +**** xref:mods-available/mac2vlan.adoc[Mac2Vlan] +**** xref:mods-available/mschap.adoc[Microsoft CHAP authentication] +**** xref:mods-available/ntlm_auth.adoc[NTLM Auth] +**** xref:mods-available/opendirectory.adoc[OpenDirectory] +**** xref:mods-available/pam.adoc[Pluggable Authentication] +**** xref:mods-available/pap.adoc[PAP] +**** xref:mods-available/passwd.adoc[Passwd] +**** xref:mods-available/perl.adoc[Perl] +**** xref:mods-available/python.adoc[Python] +**** xref:mods-available/radius.adoc[Radius] +**** xref:mods-available/radutmp.adoc[Radutmp] +**** xref:mods-available/redis.adoc[REDIS] +**** xref:mods-available/redis_ippool.adoc[Redis IP Pool] +**** xref:mods-available/rediswho.adoc[REDISWho] +**** xref:mods-available/redundant_sql.adoc[redundant_sql] +**** xref:mods-available/rest.adoc[Rest] +**** xref:mods-available/mruby.adoc[Ruby] +**** xref:mods-available/smbpasswd.adoc[SMBPasswd] +**** xref:mods-available/sometimes.adoc[Sometimes] +**** xref:mods-available/sql.adoc[SQL] +**** xref:mods-available/sqlcounter.adoc[SQL Counter] +**** xref:mods-available/sqlippool.adoc[SQL-IP-Pool] +**** xref:mods-available/sradutmp.adoc[sRadutmp] +**** xref:mods-available/stats.adoc[Stats] +**** xref:mods-available/totp.adoc[TOTP] +**** xref:mods-available/unbound.adoc[Unbound] +**** xref:mods-available/unix.adoc[Unix] +**** xref:mods-available/unpack.adoc[Unpack] +**** xref:mods-available/utf8.adoc[UTF-8] +**** xref:mods-available/wimax.adoc[WiMAX] +**** xref:mods-available/winbind.adoc[Winbind] +**** xref:mods-available/yubikey.adoc[Yubikey] + +*** xref:index.adoc[Virtual Servers] +**** xref:sites-available/abfab-tls.adoc[ABFAB: Listening on TLS] +**** xref:sites-available/abfab-tr-idp.adoc[ABFAB: Trust Router] +**** xref:sites-available/arp.adoc[ARP Virtual Server] +**** xref:sites-available/bfd.adoc[BFD - Bidirectional Forwarding Detection] +**** xref:sites-available/buffered-sql.adoc[Buffered SQL] +**** xref:sites-available/challenge.adoc[Challenge] +**** xref:sites-available/channel_bindings.adoc[Channel Bindings] +**** xref:sites-available/check-eap-tls.adoc[Check EAP-TLS] +**** xref:sites-available/coa.adoc[CoA] +**** xref:sites-available/control-socket.adoc[Control Socket Interface.] +**** xref:sites-available/copy-acct-to-home-server.adoc[Copy ACCT to Home Server] +**** xref:sites-available/decoupled-accounting.adoc[Decoupled Accounting] +**** xref:sites-available/detail.adoc[Detail] +**** xref:sites-available/dhcp.adoc[Dhcp] +**** xref:sites-available/dhcp.relay.adoc[Dhcp Relay] +**** xref:sites-available/dynamic-clients.adoc[Dynamic Clients] +**** xref:sites-available/example.adoc[Example] +**** xref:sites-available/inner-tunnel.adoc[Inner Tunnel] +**** xref:sites-available/ldap_sync.adoc[LDAP Sync] +**** xref:sites-available/originate-coa.adoc[Originate CoA-Request packets] +**** xref:sites-available/proxy-inner-tunnel.adoc[Proxy Inner Tunnel] +**** xref:sites-available/radius-acct.adoc[Radius Acct] +**** xref:sites-available/robust-proxy-accounting.adoc[Robust Proxy Accounting] +**** xref:sites-available/status.adoc[Status] +**** xref:sites-available/tacacs.adoc[Tacacs] +**** xref:sites-available/default.adoc[The default Virtual Server] +**** xref:sites-available/tls-cache.adoc[TLS Cache] +**** xref:sites-available/tls.adoc[TLS] +**** xref:sites-available/virtual.example.com.adoc[virtual.example.com] +**** xref:sites-available/vmps.adoc[VMPS] +**** xref:experimental.conf.adoc[Experimental modules] + +*** xref:clients.conf.adoc[Client Definitions] +*** xref:debug.conf.adoc[Debugging configuration] +*** xref:dictionary.adoc[Local dictionary definitions] +*** xref:radrelay.conf.adoc[Radrelay Configuration] +*** xref:radiusd.conf.adoc[Server Configuration File] +*** xref:templates.conf.adoc[Templates] +*** xref:trigger.conf.adoc[Triggers] diff --git a/doc/antora/modules/reference/pages/index.adoc b/doc/antora/modules/reference/pages/index.adoc index 9c42650340..7492ff572a 100644 --- a/doc/antora/modules/reference/pages/index.adoc +++ b/doc/antora/modules/reference/pages/index.adoc @@ -3,13 +3,13 @@ There are small number of high-level concepts associated with the server, as outlined below. * xref:unlang/index.adoc[Unlang] syntax -* xref:raddb:index.adoc[Configuration Files] +* xref:reference:raddb/index.adoc[Configuration Files] * xref:dictionary/index.adoc[Dictionary] where attribute names and data types are defined * xref:type/index.adoc[Data Types] in the server * xref:xlat/index.adoc[Dynamic expansions] i.e. "xlat"s. The server includes a large number of -xref:raddb:index.adoc[configuration files]. These files are +xref:reference:raddb/index.adoc[configuration files]. These files are automatically converted to HTML for the on-line documentation. During normal operation, the server receives packets of information diff --git a/doc/antora/modules/reference/pages/policy/different.adoc b/doc/antora/modules/reference/pages/policy/different.adoc index b829cea4cc..897b96b258 100644 --- a/doc/antora/modules/reference/pages/policy/different.adoc +++ b/doc/antora/modules/reference/pages/policy/different.adoc @@ -33,8 +33,8 @@ That is not always the case for RADIUS. With RADIUS, it is true that basic configuration is simple. For example, policies such as "I have users in LDAP, and I want authenticated users to access the network". For this policy, the -administrator configures the xref:raddb:mods-available/ldap.adoc[LDAP] -module, adds some xref:raddb:clients.conf.adoc[client] definitions, +administrator configures the xref:reference:raddb/mods-available/ldap.adoc[LDAP] +module, adds some xref:reference:raddb/clients.conf.adoc[client] definitions, and _everything just works_. The problem comes when people need policies like "allow users onto the diff --git a/doc/antora/modules/raddb/pages/.gitignore b/doc/antora/modules/reference/pages/raddb/.gitignore similarity index 100% rename from doc/antora/modules/raddb/pages/.gitignore rename to doc/antora/modules/reference/pages/raddb/.gitignore diff --git a/doc/antora/modules/raddb/pages/certs/index.adoc b/doc/antora/modules/reference/pages/raddb/certs/index.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/certs/index.adoc rename to doc/antora/modules/reference/pages/raddb/certs/index.adoc diff --git a/doc/antora/modules/raddb/pages/clients.conf.adoc b/doc/antora/modules/reference/pages/raddb/clients.conf.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/clients.conf.adoc rename to doc/antora/modules/reference/pages/raddb/clients.conf.adoc diff --git a/doc/antora/modules/raddb/pages/debug.conf.adoc b/doc/antora/modules/reference/pages/raddb/debug.conf.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/debug.conf.adoc rename to doc/antora/modules/reference/pages/raddb/debug.conf.adoc diff --git a/doc/antora/modules/raddb/pages/dictionary.adoc b/doc/antora/modules/reference/pages/raddb/dictionary.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/dictionary.adoc rename to doc/antora/modules/reference/pages/raddb/dictionary.adoc diff --git a/doc/antora/modules/raddb/pages/experimental.conf.adoc b/doc/antora/modules/reference/pages/raddb/experimental.conf.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/experimental.conf.adoc rename to doc/antora/modules/reference/pages/raddb/experimental.conf.adoc diff --git a/doc/antora/modules/raddb/pages/format.adoc b/doc/antora/modules/reference/pages/raddb/format.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/format.adoc rename to doc/antora/modules/reference/pages/raddb/format.adoc diff --git a/doc/antora/modules/raddb/pages/global.d/index.adoc b/doc/antora/modules/reference/pages/raddb/global.d/index.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/global.d/index.adoc rename to doc/antora/modules/reference/pages/raddb/global.d/index.adoc diff --git a/doc/antora/modules/raddb/pages/global.d/ldap.adoc b/doc/antora/modules/reference/pages/raddb/global.d/ldap.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/global.d/ldap.adoc rename to doc/antora/modules/reference/pages/raddb/global.d/ldap.adoc diff --git a/doc/antora/modules/raddb/pages/global.d/python.adoc b/doc/antora/modules/reference/pages/raddb/global.d/python.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/global.d/python.adoc rename to doc/antora/modules/reference/pages/raddb/global.d/python.adoc diff --git a/doc/antora/modules/raddb/pages/index.adoc b/doc/antora/modules/reference/pages/raddb/index.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/index.adoc rename to doc/antora/modules/reference/pages/raddb/index.adoc diff --git a/doc/antora/modules/raddb/pages/mods-available/abfab_psk_sql.adoc b/doc/antora/modules/reference/pages/raddb/mods-available/abfab_psk_sql.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/mods-available/abfab_psk_sql.adoc rename to doc/antora/modules/reference/pages/raddb/mods-available/abfab_psk_sql.adoc diff --git a/doc/antora/modules/raddb/pages/mods-available/all_modules.adoc b/doc/antora/modules/reference/pages/raddb/mods-available/all_modules.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/mods-available/all_modules.adoc rename to doc/antora/modules/reference/pages/raddb/mods-available/all_modules.adoc diff --git a/doc/antora/modules/raddb/pages/mods-available/always.adoc b/doc/antora/modules/reference/pages/raddb/mods-available/always.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/mods-available/always.adoc rename to doc/antora/modules/reference/pages/raddb/mods-available/always.adoc diff --git a/doc/antora/modules/raddb/pages/mods-available/attr_filter.adoc b/doc/antora/modules/reference/pages/raddb/mods-available/attr_filter.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/mods-available/attr_filter.adoc rename to doc/antora/modules/reference/pages/raddb/mods-available/attr_filter.adoc diff --git a/doc/antora/modules/raddb/pages/mods-available/brotli.adoc b/doc/antora/modules/reference/pages/raddb/mods-available/brotli.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/mods-available/brotli.adoc rename to doc/antora/modules/reference/pages/raddb/mods-available/brotli.adoc diff --git a/doc/antora/modules/raddb/pages/mods-available/cache.adoc b/doc/antora/modules/reference/pages/raddb/mods-available/cache.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/mods-available/cache.adoc rename to doc/antora/modules/reference/pages/raddb/mods-available/cache.adoc diff --git a/doc/antora/modules/raddb/pages/mods-available/cache_eap.adoc b/doc/antora/modules/reference/pages/raddb/mods-available/cache_eap.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/mods-available/cache_eap.adoc rename to doc/antora/modules/reference/pages/raddb/mods-available/cache_eap.adoc diff --git a/doc/antora/modules/raddb/pages/mods-available/cache_tls.adoc b/doc/antora/modules/reference/pages/raddb/mods-available/cache_tls.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/mods-available/cache_tls.adoc rename to doc/antora/modules/reference/pages/raddb/mods-available/cache_tls.adoc diff --git a/doc/antora/modules/raddb/pages/mods-available/chap.adoc b/doc/antora/modules/reference/pages/raddb/mods-available/chap.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/mods-available/chap.adoc rename to doc/antora/modules/reference/pages/raddb/mods-available/chap.adoc diff --git a/doc/antora/modules/raddb/pages/mods-available/cipher.adoc b/doc/antora/modules/reference/pages/raddb/mods-available/cipher.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/mods-available/cipher.adoc rename to doc/antora/modules/reference/pages/raddb/mods-available/cipher.adoc diff --git a/doc/antora/modules/raddb/pages/mods-available/client.adoc b/doc/antora/modules/reference/pages/raddb/mods-available/client.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/mods-available/client.adoc rename to doc/antora/modules/reference/pages/raddb/mods-available/client.adoc diff --git a/doc/antora/modules/raddb/pages/mods-available/couchbase.adoc b/doc/antora/modules/reference/pages/raddb/mods-available/couchbase.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/mods-available/couchbase.adoc rename to doc/antora/modules/reference/pages/raddb/mods-available/couchbase.adoc diff --git a/doc/antora/modules/raddb/pages/mods-available/csv.adoc b/doc/antora/modules/reference/pages/raddb/mods-available/csv.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/mods-available/csv.adoc rename to doc/antora/modules/reference/pages/raddb/mods-available/csv.adoc diff --git a/doc/antora/modules/raddb/pages/mods-available/cui.adoc b/doc/antora/modules/reference/pages/raddb/mods-available/cui.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/mods-available/cui.adoc rename to doc/antora/modules/reference/pages/raddb/mods-available/cui.adoc diff --git a/doc/antora/modules/raddb/pages/mods-available/date.adoc b/doc/antora/modules/reference/pages/raddb/mods-available/date.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/mods-available/date.adoc rename to doc/antora/modules/reference/pages/raddb/mods-available/date.adoc diff --git a/doc/antora/modules/raddb/pages/mods-available/delay.adoc b/doc/antora/modules/reference/pages/raddb/mods-available/delay.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/mods-available/delay.adoc rename to doc/antora/modules/reference/pages/raddb/mods-available/delay.adoc diff --git a/doc/antora/modules/raddb/pages/mods-available/detail.adoc b/doc/antora/modules/reference/pages/raddb/mods-available/detail.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/mods-available/detail.adoc rename to doc/antora/modules/reference/pages/raddb/mods-available/detail.adoc diff --git a/doc/antora/modules/raddb/pages/mods-available/detail.example.com.adoc b/doc/antora/modules/reference/pages/raddb/mods-available/detail.example.com.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/mods-available/detail.example.com.adoc rename to doc/antora/modules/reference/pages/raddb/mods-available/detail.example.com.adoc diff --git a/doc/antora/modules/raddb/pages/mods-available/detail.log.adoc b/doc/antora/modules/reference/pages/raddb/mods-available/detail.log.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/mods-available/detail.log.adoc rename to doc/antora/modules/reference/pages/raddb/mods-available/detail.log.adoc diff --git a/doc/antora/modules/raddb/pages/mods-available/dhcpv4.adoc b/doc/antora/modules/reference/pages/raddb/mods-available/dhcpv4.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/mods-available/dhcpv4.adoc rename to doc/antora/modules/reference/pages/raddb/mods-available/dhcpv4.adoc diff --git a/doc/antora/modules/raddb/pages/mods-available/dict.adoc b/doc/antora/modules/reference/pages/raddb/mods-available/dict.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/mods-available/dict.adoc rename to doc/antora/modules/reference/pages/raddb/mods-available/dict.adoc diff --git a/doc/antora/modules/raddb/pages/mods-available/digest.adoc b/doc/antora/modules/reference/pages/raddb/mods-available/digest.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/mods-available/digest.adoc rename to doc/antora/modules/reference/pages/raddb/mods-available/digest.adoc diff --git a/doc/antora/modules/raddb/pages/mods-available/eap.adoc b/doc/antora/modules/reference/pages/raddb/mods-available/eap.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/mods-available/eap.adoc rename to doc/antora/modules/reference/pages/raddb/mods-available/eap.adoc diff --git a/doc/antora/modules/raddb/pages/mods-available/eap_inner.adoc b/doc/antora/modules/reference/pages/raddb/mods-available/eap_inner.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/mods-available/eap_inner.adoc rename to doc/antora/modules/reference/pages/raddb/mods-available/eap_inner.adoc diff --git a/doc/antora/modules/raddb/pages/mods-available/echo.adoc b/doc/antora/modules/reference/pages/raddb/mods-available/echo.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/mods-available/echo.adoc rename to doc/antora/modules/reference/pages/raddb/mods-available/echo.adoc diff --git a/doc/antora/modules/raddb/pages/mods-available/escape.adoc b/doc/antora/modules/reference/pages/raddb/mods-available/escape.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/mods-available/escape.adoc rename to doc/antora/modules/reference/pages/raddb/mods-available/escape.adoc diff --git a/doc/antora/modules/raddb/pages/mods-available/etc_group.adoc b/doc/antora/modules/reference/pages/raddb/mods-available/etc_group.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/mods-available/etc_group.adoc rename to doc/antora/modules/reference/pages/raddb/mods-available/etc_group.adoc diff --git a/doc/antora/modules/raddb/pages/mods-available/exec.adoc b/doc/antora/modules/reference/pages/raddb/mods-available/exec.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/mods-available/exec.adoc rename to doc/antora/modules/reference/pages/raddb/mods-available/exec.adoc diff --git a/doc/antora/modules/raddb/pages/mods-available/files.adoc b/doc/antora/modules/reference/pages/raddb/mods-available/files.adoc similarity index 89% rename from doc/antora/modules/raddb/pages/mods-available/files.adoc rename to doc/antora/modules/reference/pages/raddb/mods-available/files.adoc index 5874ec31d3..e55826acd0 100644 --- a/doc/antora/modules/raddb/pages/mods-available/files.adoc +++ b/doc/antora/modules/reference/pages/raddb/mods-available/files.adoc @@ -6,7 +6,7 @@ The `users` file as located in `raddb/mods-config/files/authorize`. (Livingston-style format). -See the xref:raddb:mods-config/files/users.adoc[users] file documentation for information +See the xref:reference:raddb/mods-config/files/users.adoc[users] file documentation for information on the format of the input file, and how it operates. @@ -26,7 +26,7 @@ The content of this attribute is used to match the `name` of the entry. Note that unlike v4, the key does not have to be a string, but could instead be an IP address or netmask! For more information, see -xref:raddb:mods-config/files/users.adoc[users] +xref:reference:raddb/mods-config/files/users.adoc[users] diff --git a/doc/antora/modules/raddb/pages/mods-available/icmp.adoc b/doc/antora/modules/reference/pages/raddb/mods-available/icmp.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/mods-available/icmp.adoc rename to doc/antora/modules/reference/pages/raddb/mods-available/icmp.adoc diff --git a/doc/antora/modules/raddb/pages/mods-available/idn.adoc b/doc/antora/modules/reference/pages/raddb/mods-available/idn.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/mods-available/idn.adoc rename to doc/antora/modules/reference/pages/raddb/mods-available/idn.adoc diff --git a/doc/antora/modules/raddb/pages/mods-available/imap.adoc b/doc/antora/modules/reference/pages/raddb/mods-available/imap.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/mods-available/imap.adoc rename to doc/antora/modules/reference/pages/raddb/mods-available/imap.adoc diff --git a/doc/antora/modules/raddb/pages/mods-available/index.adoc b/doc/antora/modules/reference/pages/raddb/mods-available/index.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/mods-available/index.adoc rename to doc/antora/modules/reference/pages/raddb/mods-available/index.adoc diff --git a/doc/antora/modules/raddb/pages/mods-available/isc_dhcp.adoc b/doc/antora/modules/reference/pages/raddb/mods-available/isc_dhcp.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/mods-available/isc_dhcp.adoc rename to doc/antora/modules/reference/pages/raddb/mods-available/isc_dhcp.adoc diff --git a/doc/antora/modules/raddb/pages/mods-available/json.adoc b/doc/antora/modules/reference/pages/raddb/mods-available/json.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/mods-available/json.adoc rename to doc/antora/modules/reference/pages/raddb/mods-available/json.adoc diff --git a/doc/antora/modules/raddb/pages/mods-available/krb5.adoc b/doc/antora/modules/reference/pages/raddb/mods-available/krb5.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/mods-available/krb5.adoc rename to doc/antora/modules/reference/pages/raddb/mods-available/krb5.adoc diff --git a/doc/antora/modules/raddb/pages/mods-available/ldap.adoc b/doc/antora/modules/reference/pages/raddb/mods-available/ldap.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/mods-available/ldap.adoc rename to doc/antora/modules/reference/pages/raddb/mods-available/ldap.adoc diff --git a/doc/antora/modules/raddb/pages/mods-available/linelog.adoc b/doc/antora/modules/reference/pages/raddb/mods-available/linelog.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/mods-available/linelog.adoc rename to doc/antora/modules/reference/pages/raddb/mods-available/linelog.adoc diff --git a/doc/antora/modules/raddb/pages/mods-available/logtee.adoc b/doc/antora/modules/reference/pages/raddb/mods-available/logtee.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/mods-available/logtee.adoc rename to doc/antora/modules/reference/pages/raddb/mods-available/logtee.adoc diff --git a/doc/antora/modules/raddb/pages/mods-available/lua.adoc b/doc/antora/modules/reference/pages/raddb/mods-available/lua.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/mods-available/lua.adoc rename to doc/antora/modules/reference/pages/raddb/mods-available/lua.adoc diff --git a/doc/antora/modules/raddb/pages/mods-available/mac2ip.adoc b/doc/antora/modules/reference/pages/raddb/mods-available/mac2ip.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/mods-available/mac2ip.adoc rename to doc/antora/modules/reference/pages/raddb/mods-available/mac2ip.adoc diff --git a/doc/antora/modules/raddb/pages/mods-available/mac2vlan.adoc b/doc/antora/modules/reference/pages/raddb/mods-available/mac2vlan.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/mods-available/mac2vlan.adoc rename to doc/antora/modules/reference/pages/raddb/mods-available/mac2vlan.adoc diff --git a/doc/antora/modules/raddb/pages/mods-available/mruby.adoc b/doc/antora/modules/reference/pages/raddb/mods-available/mruby.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/mods-available/mruby.adoc rename to doc/antora/modules/reference/pages/raddb/mods-available/mruby.adoc diff --git a/doc/antora/modules/raddb/pages/mods-available/mschap.adoc b/doc/antora/modules/reference/pages/raddb/mods-available/mschap.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/mods-available/mschap.adoc rename to doc/antora/modules/reference/pages/raddb/mods-available/mschap.adoc diff --git a/doc/antora/modules/raddb/pages/mods-available/ntlm_auth.adoc b/doc/antora/modules/reference/pages/raddb/mods-available/ntlm_auth.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/mods-available/ntlm_auth.adoc rename to doc/antora/modules/reference/pages/raddb/mods-available/ntlm_auth.adoc diff --git a/doc/antora/modules/raddb/pages/mods-available/opendirectory.adoc b/doc/antora/modules/reference/pages/raddb/mods-available/opendirectory.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/mods-available/opendirectory.adoc rename to doc/antora/modules/reference/pages/raddb/mods-available/opendirectory.adoc diff --git a/doc/antora/modules/raddb/pages/mods-available/pam.adoc b/doc/antora/modules/reference/pages/raddb/mods-available/pam.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/mods-available/pam.adoc rename to doc/antora/modules/reference/pages/raddb/mods-available/pam.adoc diff --git a/doc/antora/modules/raddb/pages/mods-available/pap.adoc b/doc/antora/modules/reference/pages/raddb/mods-available/pap.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/mods-available/pap.adoc rename to doc/antora/modules/reference/pages/raddb/mods-available/pap.adoc diff --git a/doc/antora/modules/raddb/pages/mods-available/passwd.adoc b/doc/antora/modules/reference/pages/raddb/mods-available/passwd.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/mods-available/passwd.adoc rename to doc/antora/modules/reference/pages/raddb/mods-available/passwd.adoc diff --git a/doc/antora/modules/raddb/pages/mods-available/perl.adoc b/doc/antora/modules/reference/pages/raddb/mods-available/perl.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/mods-available/perl.adoc rename to doc/antora/modules/reference/pages/raddb/mods-available/perl.adoc diff --git a/doc/antora/modules/raddb/pages/mods-available/python.adoc b/doc/antora/modules/reference/pages/raddb/mods-available/python.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/mods-available/python.adoc rename to doc/antora/modules/reference/pages/raddb/mods-available/python.adoc diff --git a/doc/antora/modules/raddb/pages/mods-available/radius.adoc b/doc/antora/modules/reference/pages/raddb/mods-available/radius.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/mods-available/radius.adoc rename to doc/antora/modules/reference/pages/raddb/mods-available/radius.adoc diff --git a/doc/antora/modules/raddb/pages/mods-available/radutmp.adoc b/doc/antora/modules/reference/pages/raddb/mods-available/radutmp.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/mods-available/radutmp.adoc rename to doc/antora/modules/reference/pages/raddb/mods-available/radutmp.adoc diff --git a/doc/antora/modules/raddb/pages/mods-available/redis.adoc b/doc/antora/modules/reference/pages/raddb/mods-available/redis.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/mods-available/redis.adoc rename to doc/antora/modules/reference/pages/raddb/mods-available/redis.adoc diff --git a/doc/antora/modules/raddb/pages/mods-available/redis_ippool.adoc b/doc/antora/modules/reference/pages/raddb/mods-available/redis_ippool.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/mods-available/redis_ippool.adoc rename to doc/antora/modules/reference/pages/raddb/mods-available/redis_ippool.adoc diff --git a/doc/antora/modules/raddb/pages/mods-available/rediswho.adoc b/doc/antora/modules/reference/pages/raddb/mods-available/rediswho.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/mods-available/rediswho.adoc rename to doc/antora/modules/reference/pages/raddb/mods-available/rediswho.adoc diff --git a/doc/antora/modules/raddb/pages/mods-available/redundant_sql.adoc b/doc/antora/modules/reference/pages/raddb/mods-available/redundant_sql.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/mods-available/redundant_sql.adoc rename to doc/antora/modules/reference/pages/raddb/mods-available/redundant_sql.adoc diff --git a/doc/antora/modules/raddb/pages/mods-available/rest.adoc b/doc/antora/modules/reference/pages/raddb/mods-available/rest.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/mods-available/rest.adoc rename to doc/antora/modules/reference/pages/raddb/mods-available/rest.adoc diff --git a/doc/antora/modules/raddb/pages/mods-available/smbpasswd.adoc b/doc/antora/modules/reference/pages/raddb/mods-available/smbpasswd.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/mods-available/smbpasswd.adoc rename to doc/antora/modules/reference/pages/raddb/mods-available/smbpasswd.adoc diff --git a/doc/antora/modules/raddb/pages/mods-available/smtp.adoc b/doc/antora/modules/reference/pages/raddb/mods-available/smtp.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/mods-available/smtp.adoc rename to doc/antora/modules/reference/pages/raddb/mods-available/smtp.adoc diff --git a/doc/antora/modules/raddb/pages/mods-available/sometimes.adoc b/doc/antora/modules/reference/pages/raddb/mods-available/sometimes.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/mods-available/sometimes.adoc rename to doc/antora/modules/reference/pages/raddb/mods-available/sometimes.adoc diff --git a/doc/antora/modules/raddb/pages/mods-available/sql.adoc b/doc/antora/modules/reference/pages/raddb/mods-available/sql.adoc similarity index 99% rename from doc/antora/modules/raddb/pages/mods-available/sql.adoc rename to doc/antora/modules/reference/pages/raddb/mods-available/sql.adoc index cc9b24198d..8e747f0631 100644 --- a/doc/antora/modules/raddb/pages/mods-available/sql.adoc +++ b/doc/antora/modules/reference/pages/raddb/mods-available/sql.adoc @@ -26,7 +26,7 @@ oracle, postgresql, sqlite and unixodbc. For authorization queries, the default schema mirrors the functionality of the `files` module, including check items and reply items. See the -xref:raddb:mods-config/files/users.adoc[users] file +xref:reference:raddb/mods-config/files/users.adoc[users] file documentation for information on the format of the check items and reply items. diff --git a/doc/antora/modules/raddb/pages/mods-available/sqlcounter.adoc b/doc/antora/modules/reference/pages/raddb/mods-available/sqlcounter.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/mods-available/sqlcounter.adoc rename to doc/antora/modules/reference/pages/raddb/mods-available/sqlcounter.adoc diff --git a/doc/antora/modules/raddb/pages/mods-available/sqlippool.adoc b/doc/antora/modules/reference/pages/raddb/mods-available/sqlippool.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/mods-available/sqlippool.adoc rename to doc/antora/modules/reference/pages/raddb/mods-available/sqlippool.adoc diff --git a/doc/antora/modules/raddb/pages/mods-available/sradutmp.adoc b/doc/antora/modules/reference/pages/raddb/mods-available/sradutmp.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/mods-available/sradutmp.adoc rename to doc/antora/modules/reference/pages/raddb/mods-available/sradutmp.adoc diff --git a/doc/antora/modules/raddb/pages/mods-available/stats.adoc b/doc/antora/modules/reference/pages/raddb/mods-available/stats.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/mods-available/stats.adoc rename to doc/antora/modules/reference/pages/raddb/mods-available/stats.adoc diff --git a/doc/antora/modules/raddb/pages/mods-available/tacacs.adoc b/doc/antora/modules/reference/pages/raddb/mods-available/tacacs.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/mods-available/tacacs.adoc rename to doc/antora/modules/reference/pages/raddb/mods-available/tacacs.adoc diff --git a/doc/antora/modules/raddb/pages/mods-available/totp.adoc b/doc/antora/modules/reference/pages/raddb/mods-available/totp.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/mods-available/totp.adoc rename to doc/antora/modules/reference/pages/raddb/mods-available/totp.adoc diff --git a/doc/antora/modules/raddb/pages/mods-available/unbound.adoc b/doc/antora/modules/reference/pages/raddb/mods-available/unbound.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/mods-available/unbound.adoc rename to doc/antora/modules/reference/pages/raddb/mods-available/unbound.adoc diff --git a/doc/antora/modules/raddb/pages/mods-available/unix.adoc b/doc/antora/modules/reference/pages/raddb/mods-available/unix.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/mods-available/unix.adoc rename to doc/antora/modules/reference/pages/raddb/mods-available/unix.adoc diff --git a/doc/antora/modules/raddb/pages/mods-available/unpack.adoc b/doc/antora/modules/reference/pages/raddb/mods-available/unpack.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/mods-available/unpack.adoc rename to doc/antora/modules/reference/pages/raddb/mods-available/unpack.adoc diff --git a/doc/antora/modules/raddb/pages/mods-available/utf8.adoc b/doc/antora/modules/reference/pages/raddb/mods-available/utf8.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/mods-available/utf8.adoc rename to doc/antora/modules/reference/pages/raddb/mods-available/utf8.adoc diff --git a/doc/antora/modules/raddb/pages/mods-available/wimax.adoc b/doc/antora/modules/reference/pages/raddb/mods-available/wimax.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/mods-available/wimax.adoc rename to doc/antora/modules/reference/pages/raddb/mods-available/wimax.adoc diff --git a/doc/antora/modules/raddb/pages/mods-available/winbind.adoc b/doc/antora/modules/reference/pages/raddb/mods-available/winbind.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/mods-available/winbind.adoc rename to doc/antora/modules/reference/pages/raddb/mods-available/winbind.adoc diff --git a/doc/antora/modules/raddb/pages/mods-available/yubikey.adoc b/doc/antora/modules/reference/pages/raddb/mods-available/yubikey.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/mods-available/yubikey.adoc rename to doc/antora/modules/reference/pages/raddb/mods-available/yubikey.adoc diff --git a/doc/antora/modules/raddb/pages/mods-config/files/users.adoc b/doc/antora/modules/reference/pages/raddb/mods-config/files/users.adoc similarity index 97% rename from doc/antora/modules/raddb/pages/mods-config/files/users.adoc rename to doc/antora/modules/reference/pages/raddb/mods-config/files/users.adoc index fea24db65f..ddacbd5f66 100644 --- a/doc/antora/modules/raddb/pages/mods-config/files/users.adoc +++ b/doc/antora/modules/reference/pages/raddb/mods-config/files/users.adoc @@ -1,8 +1,8 @@ = The users file -The `users` file is managed by the xref:raddb:mods-available/files.adoc[files] module. The format largely goes back to the original Livingston RADIUS server in 1991! +The `users` file is managed by the xref:reference:raddb/mods-available/files.adoc[files] module. The format largely goes back to the original Livingston RADIUS server in 1991! -While the format is still called `users` for historical reasons, the name of the file is controlled by the configuration of the xref:raddb:mods-available/files.adoc[files] module, and can therefore something other than `users`. +While the format is still called `users` for historical reasons, the name of the file is controlled by the configuration of the xref:reference:raddb/mods-available/files.adoc[files] module, and can therefore something other than `users`. == Format @@ -17,7 +17,7 @@ name ... check items ... ... reply items ... ---- -name:: The name of the entry. It must be an unquoted string such as `john`. The xref:raddb:mods-available/files.adoc[files] module configuration expands the `key` configuration item, and then uses the result to match the `name` of the entry. +name:: The name of the entry. It must be an unquoted string such as `john`. The xref:reference:raddb/mods-available/files.adoc[files] module configuration expands the `key` configuration item, and then uses the result to match the `name` of the entry. check items:: A comma-separated list of attributes to use for conditional matches, such as `Framed-IP-Address == 192.0.2.1`, or `NAS-IP-Address == 192.0.2.2, NAS-Port = 15`. Multiple conditions are matched with a logical "and". There is no way to use a logical "or" between conditions. + diff --git a/doc/antora/modules/raddb/pages/mods-config/index.adoc b/doc/antora/modules/reference/pages/raddb/mods-config/index.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/mods-config/index.adoc rename to doc/antora/modules/reference/pages/raddb/mods-config/index.adoc diff --git a/doc/antora/modules/raddb/pages/radclient.conf.adoc b/doc/antora/modules/reference/pages/raddb/radclient.conf.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/radclient.conf.adoc rename to doc/antora/modules/reference/pages/raddb/radclient.conf.adoc diff --git a/doc/antora/modules/raddb/pages/radiusd.conf.adoc b/doc/antora/modules/reference/pages/raddb/radiusd.conf.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/radiusd.conf.adoc rename to doc/antora/modules/reference/pages/raddb/radiusd.conf.adoc diff --git a/doc/antora/modules/raddb/pages/radrelay.conf.adoc b/doc/antora/modules/reference/pages/raddb/radrelay.conf.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/radrelay.conf.adoc rename to doc/antora/modules/reference/pages/raddb/radrelay.conf.adoc diff --git a/doc/antora/modules/raddb/pages/sites-available/abfab-tls.adoc b/doc/antora/modules/reference/pages/raddb/sites-available/abfab-tls.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/sites-available/abfab-tls.adoc rename to doc/antora/modules/reference/pages/raddb/sites-available/abfab-tls.adoc diff --git a/doc/antora/modules/raddb/pages/sites-available/abfab-tr-idp.adoc b/doc/antora/modules/reference/pages/raddb/sites-available/abfab-tr-idp.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/sites-available/abfab-tr-idp.adoc rename to doc/antora/modules/reference/pages/raddb/sites-available/abfab-tr-idp.adoc diff --git a/doc/antora/modules/raddb/pages/sites-available/arp.adoc b/doc/antora/modules/reference/pages/raddb/sites-available/arp.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/sites-available/arp.adoc rename to doc/antora/modules/reference/pages/raddb/sites-available/arp.adoc diff --git a/doc/antora/modules/raddb/pages/sites-available/bfd.adoc b/doc/antora/modules/reference/pages/raddb/sites-available/bfd.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/sites-available/bfd.adoc rename to doc/antora/modules/reference/pages/raddb/sites-available/bfd.adoc diff --git a/doc/antora/modules/raddb/pages/sites-available/buffered-sql.adoc b/doc/antora/modules/reference/pages/raddb/sites-available/buffered-sql.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/sites-available/buffered-sql.adoc rename to doc/antora/modules/reference/pages/raddb/sites-available/buffered-sql.adoc diff --git a/doc/antora/modules/raddb/pages/sites-available/challenge.adoc b/doc/antora/modules/reference/pages/raddb/sites-available/challenge.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/sites-available/challenge.adoc rename to doc/antora/modules/reference/pages/raddb/sites-available/challenge.adoc diff --git a/doc/antora/modules/raddb/pages/sites-available/channel_bindings.adoc b/doc/antora/modules/reference/pages/raddb/sites-available/channel_bindings.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/sites-available/channel_bindings.adoc rename to doc/antora/modules/reference/pages/raddb/sites-available/channel_bindings.adoc diff --git a/doc/antora/modules/raddb/pages/sites-available/check-eap-tls.adoc b/doc/antora/modules/reference/pages/raddb/sites-available/check-eap-tls.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/sites-available/check-eap-tls.adoc rename to doc/antora/modules/reference/pages/raddb/sites-available/check-eap-tls.adoc diff --git a/doc/antora/modules/raddb/pages/sites-available/coa-relay.adoc b/doc/antora/modules/reference/pages/raddb/sites-available/coa-relay.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/sites-available/coa-relay.adoc rename to doc/antora/modules/reference/pages/raddb/sites-available/coa-relay.adoc diff --git a/doc/antora/modules/raddb/pages/sites-available/coa.adoc b/doc/antora/modules/reference/pages/raddb/sites-available/coa.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/sites-available/coa.adoc rename to doc/antora/modules/reference/pages/raddb/sites-available/coa.adoc diff --git a/doc/antora/modules/raddb/pages/sites-available/control-socket.adoc b/doc/antora/modules/reference/pages/raddb/sites-available/control-socket.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/sites-available/control-socket.adoc rename to doc/antora/modules/reference/pages/raddb/sites-available/control-socket.adoc diff --git a/doc/antora/modules/raddb/pages/sites-available/copy-acct-to-home-server.adoc b/doc/antora/modules/reference/pages/raddb/sites-available/copy-acct-to-home-server.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/sites-available/copy-acct-to-home-server.adoc rename to doc/antora/modules/reference/pages/raddb/sites-available/copy-acct-to-home-server.adoc diff --git a/doc/antora/modules/raddb/pages/sites-available/cron.adoc b/doc/antora/modules/reference/pages/raddb/sites-available/cron.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/sites-available/cron.adoc rename to doc/antora/modules/reference/pages/raddb/sites-available/cron.adoc diff --git a/doc/antora/modules/raddb/pages/sites-available/decoupled-accounting.adoc b/doc/antora/modules/reference/pages/raddb/sites-available/decoupled-accounting.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/sites-available/decoupled-accounting.adoc rename to doc/antora/modules/reference/pages/raddb/sites-available/decoupled-accounting.adoc diff --git a/doc/antora/modules/raddb/pages/sites-available/default.adoc b/doc/antora/modules/reference/pages/raddb/sites-available/default.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/sites-available/default.adoc rename to doc/antora/modules/reference/pages/raddb/sites-available/default.adoc diff --git a/doc/antora/modules/raddb/pages/sites-available/detail.adoc b/doc/antora/modules/reference/pages/raddb/sites-available/detail.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/sites-available/detail.adoc rename to doc/antora/modules/reference/pages/raddb/sites-available/detail.adoc diff --git a/doc/antora/modules/raddb/pages/sites-available/dhcp.adoc b/doc/antora/modules/reference/pages/raddb/sites-available/dhcp.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/sites-available/dhcp.adoc rename to doc/antora/modules/reference/pages/raddb/sites-available/dhcp.adoc diff --git a/doc/antora/modules/raddb/pages/sites-available/dhcp.relay.adoc b/doc/antora/modules/reference/pages/raddb/sites-available/dhcp.relay.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/sites-available/dhcp.relay.adoc rename to doc/antora/modules/reference/pages/raddb/sites-available/dhcp.relay.adoc diff --git a/doc/antora/modules/raddb/pages/sites-available/dhcpv6.adoc b/doc/antora/modules/reference/pages/raddb/sites-available/dhcpv6.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/sites-available/dhcpv6.adoc rename to doc/antora/modules/reference/pages/raddb/sites-available/dhcpv6.adoc diff --git a/doc/antora/modules/raddb/pages/sites-available/dns.adoc b/doc/antora/modules/reference/pages/raddb/sites-available/dns.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/sites-available/dns.adoc rename to doc/antora/modules/reference/pages/raddb/sites-available/dns.adoc diff --git a/doc/antora/modules/raddb/pages/sites-available/dynamic-clients.adoc b/doc/antora/modules/reference/pages/raddb/sites-available/dynamic-clients.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/sites-available/dynamic-clients.adoc rename to doc/antora/modules/reference/pages/raddb/sites-available/dynamic-clients.adoc diff --git a/doc/antora/modules/raddb/pages/sites-available/eap-aka-sim.adoc b/doc/antora/modules/reference/pages/raddb/sites-available/eap-aka-sim.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/sites-available/eap-aka-sim.adoc rename to doc/antora/modules/reference/pages/raddb/sites-available/eap-aka-sim.adoc diff --git a/doc/antora/modules/raddb/pages/sites-available/example.adoc b/doc/antora/modules/reference/pages/raddb/sites-available/example.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/sites-available/example.adoc rename to doc/antora/modules/reference/pages/raddb/sites-available/example.adoc diff --git a/doc/antora/modules/raddb/pages/sites-available/index.adoc b/doc/antora/modules/reference/pages/raddb/sites-available/index.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/sites-available/index.adoc rename to doc/antora/modules/reference/pages/raddb/sites-available/index.adoc diff --git a/doc/antora/modules/raddb/pages/sites-available/inner-tunnel.adoc b/doc/antora/modules/reference/pages/raddb/sites-available/inner-tunnel.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/sites-available/inner-tunnel.adoc rename to doc/antora/modules/reference/pages/raddb/sites-available/inner-tunnel.adoc diff --git a/doc/antora/modules/raddb/pages/sites-available/ldap_sync.adoc b/doc/antora/modules/reference/pages/raddb/sites-available/ldap_sync.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/sites-available/ldap_sync.adoc rename to doc/antora/modules/reference/pages/raddb/sites-available/ldap_sync.adoc diff --git a/doc/antora/modules/raddb/pages/sites-available/load.adoc b/doc/antora/modules/reference/pages/raddb/sites-available/load.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/sites-available/load.adoc rename to doc/antora/modules/reference/pages/raddb/sites-available/load.adoc diff --git a/doc/antora/modules/raddb/pages/sites-available/originate-coa.adoc b/doc/antora/modules/reference/pages/raddb/sites-available/originate-coa.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/sites-available/originate-coa.adoc rename to doc/antora/modules/reference/pages/raddb/sites-available/originate-coa.adoc diff --git a/doc/antora/modules/raddb/pages/sites-available/proxy-inner-tunnel.adoc b/doc/antora/modules/reference/pages/raddb/sites-available/proxy-inner-tunnel.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/sites-available/proxy-inner-tunnel.adoc rename to doc/antora/modules/reference/pages/raddb/sites-available/proxy-inner-tunnel.adoc diff --git a/doc/antora/modules/raddb/pages/sites-available/radius-acct.adoc b/doc/antora/modules/reference/pages/raddb/sites-available/radius-acct.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/sites-available/radius-acct.adoc rename to doc/antora/modules/reference/pages/raddb/sites-available/radius-acct.adoc diff --git a/doc/antora/modules/raddb/pages/sites-available/resource-check.adoc b/doc/antora/modules/reference/pages/raddb/sites-available/resource-check.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/sites-available/resource-check.adoc rename to doc/antora/modules/reference/pages/raddb/sites-available/resource-check.adoc diff --git a/doc/antora/modules/raddb/pages/sites-available/robust-proxy-accounting.adoc b/doc/antora/modules/reference/pages/raddb/sites-available/robust-proxy-accounting.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/sites-available/robust-proxy-accounting.adoc rename to doc/antora/modules/reference/pages/raddb/sites-available/robust-proxy-accounting.adoc diff --git a/doc/antora/modules/raddb/pages/sites-available/status.adoc b/doc/antora/modules/reference/pages/raddb/sites-available/status.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/sites-available/status.adoc rename to doc/antora/modules/reference/pages/raddb/sites-available/status.adoc diff --git a/doc/antora/modules/raddb/pages/sites-available/tacacs.adoc b/doc/antora/modules/reference/pages/raddb/sites-available/tacacs.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/sites-available/tacacs.adoc rename to doc/antora/modules/reference/pages/raddb/sites-available/tacacs.adoc diff --git a/doc/antora/modules/raddb/pages/sites-available/test_load.adoc b/doc/antora/modules/reference/pages/raddb/sites-available/test_load.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/sites-available/test_load.adoc rename to doc/antora/modules/reference/pages/raddb/sites-available/test_load.adoc diff --git a/doc/antora/modules/raddb/pages/sites-available/tls-cache.adoc b/doc/antora/modules/reference/pages/raddb/sites-available/tls-cache.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/sites-available/tls-cache.adoc rename to doc/antora/modules/reference/pages/raddb/sites-available/tls-cache.adoc diff --git a/doc/antora/modules/raddb/pages/sites-available/tls.adoc b/doc/antora/modules/reference/pages/raddb/sites-available/tls.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/sites-available/tls.adoc rename to doc/antora/modules/reference/pages/raddb/sites-available/tls.adoc diff --git a/doc/antora/modules/raddb/pages/sites-available/virtual.example.com.adoc b/doc/antora/modules/reference/pages/raddb/sites-available/virtual.example.com.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/sites-available/virtual.example.com.adoc rename to doc/antora/modules/reference/pages/raddb/sites-available/virtual.example.com.adoc diff --git a/doc/antora/modules/raddb/pages/sites-available/vmps.adoc b/doc/antora/modules/reference/pages/raddb/sites-available/vmps.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/sites-available/vmps.adoc rename to doc/antora/modules/reference/pages/raddb/sites-available/vmps.adoc diff --git a/doc/antora/modules/raddb/pages/templates.conf.adoc b/doc/antora/modules/reference/pages/raddb/templates.conf.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/templates.conf.adoc rename to doc/antora/modules/reference/pages/raddb/templates.conf.adoc diff --git a/doc/antora/modules/raddb/pages/trigger.conf.adoc b/doc/antora/modules/reference/pages/raddb/trigger.conf.adoc similarity index 100% rename from doc/antora/modules/raddb/pages/trigger.conf.adoc rename to doc/antora/modules/reference/pages/raddb/trigger.conf.adoc diff --git a/doc/antora/modules/reference/pages/unlang/interpreter.adoc b/doc/antora/modules/reference/pages/unlang/interpreter.adoc index a80dad5667..c127921bcb 100644 --- a/doc/antora/modules/reference/pages/unlang/interpreter.adoc +++ b/doc/antora/modules/reference/pages/unlang/interpreter.adoc @@ -27,9 +27,9 @@ functions, etc. Despite these limitations, it has proven to be useful and powerful. While the server includes plugins for languages such as -xref:raddb:mods-available/lua.adoc[lua], -xref:raddb:mods-available/python.adoc[python], and -xref:raddb:mods-available/perl.adoc[perl], most policies can be done +xref:reference:raddb/mods-available/lua.adoc[lua], +xref:reference:raddb/mods-available/python.adoc[python], and +xref:reference:raddb/mods-available/perl.adoc[perl], most policies can be done in simple `unlang` statements. More general purpose programming languages are more powerful than `unlang`, but they are generally sustantially slower. @@ -53,8 +53,8 @@ recv foo { ---- The processing sections are defined in -xref:raddb:sites-available/index.adoc[virtual servers]. The -xref:raddb:sites-available/index.adoc[virtual server] documentation +xref:reference:raddb/sites-available/index.adoc[virtual servers]. The +xref:reference:raddb/sites-available/index.adoc[virtual server] documentation describes the larger context of which packets are recieved, and when they are received. This section concentrates on the more narrow topic `unlang` itself. @@ -86,7 +86,7 @@ process that list. One key difference between normal programming languages and Unlang is the concept of xref:unlang/module.adoc[modules]. The modules are treated as keywords in the language which contain complex behavior. -For example, the xref:raddb:mods-available/sql.adoc[sql] module has a +For example, the xref:reference:raddb/mods-available/sql.adoc[sql] module has a complex set of pre-defined behavior, depending on what kind of packet it is processing. @@ -108,16 +108,16 @@ recv Access-Request { The benefit of this approach is that the _policies_ are simple: "allocate an IP, if that doesn't work, send a reject". However, the _details_ of those policies are hidden behind the -xref:raddb:mods-available/sqlippool.adoc[sqlippool] configuration. +xref:reference:raddb/mods-available/sqlippool.adoc[sqlippool] configuration. This abstraction allows the underyling -xref:raddb:mods-available/sqlippool.adoc[sqlippool] configuration to +xref:reference:raddb/mods-available/sqlippool.adoc[sqlippool] configuration to be changed from MySQL to PostgreSQL without affecting any of the policies. The server includes dozens of -xref:raddb:mods-available/index.adoc[modules], each of which defines a +xref:reference:raddb/mods-available/index.adoc[modules], each of which defines a complex set of behavior. Please see the -xref:raddb:mods-available/index.adoc[modules] documentation for more +xref:reference:raddb/mods-available/index.adoc[modules] documentation for more information. === Algorithm diff --git a/doc/antora/modules/reference/pages/unlang/keywords.adoc b/doc/antora/modules/reference/pages/unlang/keywords.adoc index 1a39cccdb1..945abd6498 100644 --- a/doc/antora/modules/reference/pages/unlang/keywords.adoc +++ b/doc/antora/modules/reference/pages/unlang/keywords.adoc @@ -102,7 +102,7 @@ name of an instance of a pre-packaged module such as `sql`, or `ldap`, or The documentation below describes how to reference modules. That is, how to use `sql`, etc. in the policies. Please see the -xref:raddb:mods-available/index.adoc[module configuration] and the +xref:reference:raddb/mods-available/index.adoc[module configuration] and the xref:howto:modules/configuring_modules.adoc[configuring modules] howto pages for information on configuring and using the modules. diff --git a/doc/antora/modules/reference/pages/unlang/module_builtin.adoc b/doc/antora/modules/reference/pages/unlang/module_builtin.adoc index 4405455e39..9b8620727b 100644 --- a/doc/antora/modules/reference/pages/unlang/module_builtin.adoc +++ b/doc/antora/modules/reference/pages/unlang/module_builtin.adoc @@ -6,7 +6,7 @@ modules are named for the return codes given in the xref:unlang/module.adoc[modu section. In practice, these modules are implemented by the -xref:raddb:mods-available/always.adoc[always] module and exist so that a +xref:reference:raddb/mods-available/always.adoc[always] module and exist so that a success or failure can be forced during the processing of a policy. The names and behaviours of these modules are given below: diff --git a/doc/antora/modules/reference/pages/xlat/character.adoc b/doc/antora/modules/reference/pages/xlat/character.adoc index b4dd97f84d..d43d180650 100644 --- a/doc/antora/modules/reference/pages/xlat/character.adoc +++ b/doc/antora/modules/reference/pages/xlat/character.adoc @@ -3,7 +3,7 @@ The following are single letter expansions. The xref:xlat/builtin.adoc[builtin] `%time(...)` expansion and the -xref:raddb:mods-available/date.adoc[date] module should be used +xref:reference:raddb/mods-available/date.adoc[date] module should be used instead of these expansions. @@ -73,21 +73,21 @@ Request date in the format `YYYYMMDD`. Request timestamp in SQL format, `YYYY-mmm-ddd HH:MM:SS`. -The xref:raddb:mods-available/date.adoc[date] module should be used +The xref:reference:raddb/mods-available/date.adoc[date] module should be used instead. `%t()`:: Request timestamp in _ctime_ format, `Www Mmm dd HH:MM:SS YYYY`. -The xref:raddb:mods-available/date.adoc[date] module should be used +The xref:reference:raddb/mods-available/date.adoc[date] module should be used instead. `%T()`:: Request timestamp in ISO format, `YYYY-mm-ddTHH:MM:SS.000`. -The xref:raddb:mods-available/date.adoc[date] module should be used +The xref:reference:raddb/mods-available/date.adoc[date] module should be used instead. // Copyright (C) 2023 Network RADIUS SAS. Licenced under CC-by-NC 4.0. diff --git a/doc/antora/modules/tutorials/pages/final_group_project.adoc b/doc/antora/modules/tutorials/pages/final_group_project.adoc index 0aa7c9f04f..f0efc7c31d 100644 --- a/doc/antora/modules/tutorials/pages/final_group_project.adoc +++ b/doc/antora/modules/tutorials/pages/final_group_project.adoc @@ -66,9 +66,9 @@ multiple upstream home servers. *Files:* -- xref:raddb:mods-available/radius.adoc[`etc/raddb/mods-available/radius`] -- xref:raddb:sites-available/default.adoc[`etc/raddb/sites-available/default`] (optionally) -- xref:raddb:mods-available/linelog.adoc[`etc/raddb/mods-available/linelog`] (optionally) +- xref:reference:raddb/mods-available/radius.adoc[`etc/raddb/mods-available/radius`] +- xref:reference:raddb/sites-available/default.adoc[`etc/raddb/sites-available/default`] (optionally) +- xref:reference:raddb/mods-available/linelog.adoc[`etc/raddb/mods-available/linelog`] (optionally) *Time:* 20-30 minutes @@ -104,7 +104,7 @@ The local realm should not have "nostrip" set. *Files:* -- xref:raddb:clients.conf.adoc[`etc/raddb/clients.conf`] +- xref:reference:raddb/clients.conf.adoc[`etc/raddb/clients.conf`] *Time*: 15-20 minutes @@ -145,13 +145,13 @@ login, retrieve the user's password and store it in *Files:* -- xref:raddb:mods-available/suffix.adoc[`etc/raddb/mods-available/suffix`] -- xref:raddb:mods-available/files.adoc[`etc/raddb/mods-available/files`] +- xref:reference:raddb/mods-available/suffix.adoc[`etc/raddb/mods-available/suffix`] +- xref:reference:raddb/mods-available/files.adoc[`etc/raddb/mods-available/files`] - `etc/raddb/mods-config/files/authorize` -- xref:raddb:mods-available/ldap.adoc[`etc/raddb/mods-available/ldap`] -- xref:raddb:mods-available/redis.adoc[`etc/raddb/mods-available/redis`] -- xref:raddb:mods-available/rest.adoc[`etc/raddb/mods-available/rest`] -- xref:raddb:mods-available/sql.adoc[`etc/raddb/mods-available/sql`] +- xref:reference:raddb/mods-available/ldap.adoc[`etc/raddb/mods-available/ldap`] +- xref:reference:raddb/mods-available/redis.adoc[`etc/raddb/mods-available/redis`] +- xref:reference:raddb/mods-available/rest.adoc[`etc/raddb/mods-available/rest`] +- xref:reference:raddb/mods-available/sql.adoc[`etc/raddb/mods-available/sql`] *Time:* 20-60 minutes diff --git a/doc/antora/modules/tutorials/pages/unlang_return_codes.adoc b/doc/antora/modules/tutorials/pages/unlang_return_codes.adoc index 7f02287236..8321ace864 100644 --- a/doc/antora/modules/tutorials/pages/unlang_return_codes.adoc +++ b/doc/antora/modules/tutorials/pages/unlang_return_codes.adoc @@ -13,13 +13,13 @@ - xref:reference:unlang/condition/index.adoc[Conditional Expressions] - xref:reference:unlang/return_codes[Return Codes] - xref:reference:unlang/condition/return_codes.adoc[The Return Code Operator] -- xref:raddb:mods-available/always.adoc[The Always Module] -- xref:raddb:mods-available/sometimes.adoc[The Sometimes Module] +- xref:reference:raddb/mods-available/always.adoc[The Always Module] +- xref:reference:raddb/mods-available/sometimes.adoc[The Sometimes Module] include::partial$unlang_start.adoc[] The server includes a number of instances of the -xref:raddb:mods-available/always.adoc[always] module. These are used to set +xref:reference:raddb/mods-available/always.adoc[always] module. These are used to set return codes during policy evaluation. For example, if the `ok` always module instance is called, the `ok` return code @@ -30,7 +30,7 @@ One of the most common reasons for overriding return codes is to implement special behaviour on failure. To minimise external dependencies, for this exercise we will use the -xref:raddb:mods-available/sometimes.adoc[sometimes] module to simulate an +xref:reference:raddb/mods-available/sometimes.adoc[sometimes] module to simulate an unreliable external database. This module will return a specified xref:reference:unlang/return_codes[return code] 50% @@ -51,7 +51,7 @@ executing the `files` module to provide an alternative source of credentials. [TIP] ==== You may need to modify the return code priorities of the -xref:raddb:mods-available/sometimes.adoc[sometimes] module. +xref:reference:raddb/mods-available/sometimes.adoc[sometimes] module. ==== If the policies are correct you will see that FreeRADIUS returns an -- 2.47.3