Skip to content

Commit

Permalink
move raddb to reference
Browse files Browse the repository at this point in the history
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
  • Loading branch information
alandekok committed Jan 14, 2025
1 parent 3966099 commit 6da6765
Show file tree
Hide file tree
Showing 151 changed files with 183 additions and 182 deletions.
8 changes: 4 additions & 4 deletions doc/all.mk
Original file line number Diff line number Diff line change
Expand Up @@ -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))
Expand Down Expand Up @@ -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]+$$//' $^
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions doc/antora/modules/ROOT/pages/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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].
Expand Down Expand Up @@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -121,15 +121,15 @@ 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.

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
Expand Down
4 changes: 2 additions & 2 deletions doc/antora/modules/howto/pages/modules/chap/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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
Expand Down
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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[]
Expand All @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion doc/antora/modules/howto/pages/modules/ldap/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
====

Expand Down
4 changes: 2 additions & 2 deletions doc/antora/modules/installation/pages/upgrade.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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:
Expand Down
122 changes: 0 additions & 122 deletions doc/antora/modules/raddb/nav.adoc

This file was deleted.

Loading

0 comments on commit 6da6765

Please sign in to comment.