Topology Change

doc/antora/antora.yml

@@ -10,10 +10,10 @@ prerelease: Devel
 start_page: ROOT:index.adoc
 nav:
 - modules/ROOT/nav.adoc
-- modules/reference/nav.adoc
-- modules/raddb/nav.adoc
-- modules/installation/nav.adoc
 - modules/concepts/nav.adoc
+- modules/reference/nav.adoc
+#- modules/reference/raddb/nav.adoc
+#- modules/installation/nav.adoc
 - modules/howto/nav.adoc
 - modules/tutorials/nav.adoc
 - modules/developers/nav.adoc

doc/antora/modules/ROOT/pages/index.adoc

@@ -37,7 +37,7 @@ The documentation is split into sections by subject area, oganized by
 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.
+* xref:howto:installation/index.adoc[Installing] and xref:howto:installation:upgrade.adoc[upgrading] FreeRADIUS.
 * The syntax of the xref:reference:unlang/index.adoc[unlang] processing language.
 * The xref:reference:raddb/index.adoc[configuration files] located in `/etc/raddb/`, or `/etc/freeradius/`
 * Various xref:howto:index.adoc[how-to] guides.
@@ -111,7 +111,7 @@ All of these limitations and more have been removed. The downside of
 these changes is that the some of the configuration has been changed.
 
 Administrators who have version 3 and wish to upgrade to version 4
-should read the xref:installation:upgrade.adoc[upgrading] documentation.
+should read the xref:howto:installation/upgrade.adoc[upgrading] documentation.
 That documentation explains the differences between the two versions, and
 how an existing configuration can be reproduced in the latest
 release. We do _not_ recommend using version 3 configuration files
@@ -128,7 +128,7 @@ has been released.  Packages for older releases are also available for
 historical purposes.
 
 FreeRADIUS can also be installed from the source code.  Please see the
-xref:installation:index.adoc[installation guide] for instructions.
+xref:howto:installation/index.adoc[installation guide] for instructions.
 
 WARNING: Many Operating System distributions ship versions of FreeRADIUS
 which are years out of date. Those versions may contain bugs which have

doc/antora/modules/developers/pages/index.adoc

@@ -57,5 +57,5 @@ RFC2139(http://www.freeradius.org/rfc/rfc2139.txt)
 ** xref:sbuff-parsing.adoc[Parsing with string buffers]
 ** xref:sbuff-ng.adoc[Sbuff issues]
 
-Also see the xref:installation:dependencies.adoc[build
+Also see the xref:howto:installation/dependencies.adoc[build
 dependencies] page.

doc/antora/modules/howto/nav.adoc

@@ -1,4 +1,14 @@
 * xref:index.adoc[Howto Guides]
+** xref:installation/index.adoc[Installing and upgrading]
+*** xref:installation/packages.adoc[Install from packages]
+*** xref:installation/dependencies.adoc[Dependencies]
+*** xref:installation/source.adoc[Build from source]
+*** xref:installation/upgrade.adoc[Upgrading from v3 to v4]
+*** xref:installation/attribute_names.adoc[Attribute name changes from v3 to v4]
+*** Building Packages
+**** xref:installation/debian.adoc[Debian and Ubuntu]
+**** xref:installation/redhat.adoc[RedHat and CentOS]
+
 ** Modules
 *** xref:modules/configuring_modules.adoc[Configuring Modules]
 *** xref:modules/chap/index.adoc[CHAP]
@@ -7,7 +17,6 @@
 *** xref:modules/krb5/index.adoc[Krb5]
 
 *** xref:modules/ldap/index.adoc[LDAP]
-
 **** xref:modules/ldap/bootstrap_openldap/index.adoc[Installing and Configuring OpenLDAP]
 ***** xref:modules/ldap/bootstrap_openldap/docker.adoc[Docker]
 ***** xref:modules/ldap/bootstrap_openldap/packages.adoc[Packages]

doc/antora/modules/installation/pages/debian.adoc → doc/antora/modules/howto/pages/installation/debian.adoc

@@ -1,7 +1,7 @@
-= 2 Ways of installing FreeRadius on Ubuntu 
+= 2 Ways of installing FreeRadius on Ubuntu
 
-* Installing from repositories 
-* Installing from source 
+* Installing from repositories
+* Installing from source
 
 == Installing from repositories :
 
@@ -11,7 +11,7 @@ To Install :
 
 Get the latest info about packages from Ubuntu :
 ----
-sudo apt-get update 
+sudo apt-get update
 ----
 
 Then make sure the system is fully upgraded before installing freeradius :
@@ -26,12 +26,12 @@ sudo apt-get dist-upgrade
 
 After that has been done we can use _apt_ to install freeradius :
 ----
-sudo apt-get install freeradius 
+sudo apt-get install freeradius
 ----
 
 This will install the common,utils, ssl-cert, libdbi-perl, and libfreeradius2 packages. As you probably going to connect to a database or use perl, you should probably also install (some of) the suggested packages. Such as: freeradius-ldap, freeradius-postgresql and freeradius-mysql.
 ----
-sudo apt-get install freeradius-ldap        
+sudo apt-get install freeradius-ldap
 ----
 
 The 'apt install freeradius' command will list all the suggested packages.
@@ -55,7 +55,7 @@ Right now your config files are in :
 ----
 cd /etc/freeradius
 ----
-Documentation and files for creation of certificates are in : 
+Documentation and files for creation of certificates are in :
 ----
 cd /usr/share/doc/freeradius
 ----
@@ -64,10 +64,9 @@ cd /usr/share/doc/freeradius
 
 Installing from source can be daunting for people who never did it but as long as you read the output of the building process, it should tell you what went wrong or what is missing.
 
-First step is to get the source. 2 places that currently offer the material :
-* freeradius.org : http://freeradius.org/download.html(http://freeradius.org/download.html)
-* GitHub : https://github.com/FreeRADIUS/freeradius-server(https://github.com/FreeRADIUS/freeradius-server)
-On GitHub select the branch you wish to install and press clone or download.
+Your first step is to download the source files which can be found on one of the following sites:
+    http://freeradius.org/download.html[Freeradius.org] - Select the latest release by pressing the relevant button.
+    https://github.com/FreeRADIUS/freeradius-server[Github] - Select the branch you wish to install and press clone or download.
 
 Make sure unzip or any other utility that can extract the zip is installed. If not :
 ----
@@ -113,7 +112,7 @@ In the file _debian/rules_ we might need to make some changes depending on other
 pico debian/rules
 ----
 
-And just before 
+And just before
 ----
 --without-rlm_eap_ikev2 \
 ----
@@ -133,7 +132,7 @@ sudo apt-get install libcurl4-openssl-dev libcap-dev libgdbm-dev libiodbc2-dev l
 
 After that we try again to build.
 ----
-fakeroot dpkg-buildpackage -b -uc	 
+fakeroot dpkg-buildpackage -b -uc
 ----
 
 If it errors out after it has already started building the deb files, you are sometimes better off starting anew. If that happens :
@@ -157,15 +156,6 @@ sudo dpkg -i *freeradius*_W.X.Y*_*.deb
 The install might show errors. Read the error !! Ask questions on freeradius list if you cannot figure it out. v2 will fail install often on open_ssl issues. Quick thing to change to prevent just that error is to edit a config file so freeradius will not complain about ssl that might be vulnerable. ( /etc/freeradius/eap.conf (v2) or /etc/freeradius/modules-enabled/eap )
 
 
-
-
-
-
-
-
-
-
-
 = Building on Debian or Ubuntu
 
 Building Debian packages (including Ubuntu) of FreeRADIUS from source is kept as simple as possible.
@@ -230,7 +220,7 @@ sudo apt-get install g++-4.9
 
 # Then select GCC 4.9
 sudo update-alternatives --install /usr/bin/gcc gcc /usr/bin/gcc-4.8 100 --slave /usr/bin/g++ g++ /usr/bin/g++-4.8
-sudo update-alternatives --install /usr/bin/gcc gcc /usr/bin/gcc-4.9 50 --slave /usr/bin/g++ g++ /usr/bin/g++-4.9 
+sudo update-alternatives --install /usr/bin/gcc gcc /usr/bin/gcc-4.9 50 --slave /usr/bin/g++ g++ /usr/bin/g++-4.9
 sudo update-alternatives --config gcc
 
 # Choose option 3 from the dialogue

doc/antora/modules/installation/pages/index.adoc → doc/antora/modules/howto/pages/installation/index.adoc

@@ -2,8 +2,8 @@
 
 FreeRADIUS is available from multiple sources:
 
-* Official xref:packages.adoc[Network RADIUS packages]
-* xref:source.adoc[Source code]
+* Official xref:installation/packages.adoc[Network RADIUS packages]
+* xref:installation/source.adoc[Source code]
 * Many Operating System distributions
 
 We highly recommend using the official packages from Network
@@ -33,9 +33,8 @@ Once you have learnt how FreeRADIUS works, it is then highly
 recommended to move to the latest released stable version before
 moving into production.
 
-If you need to install it yourself, the Wiki
-building and installing(http://wiki.freeradius.org/building/Home)
-page contains detailed instructions for a number of platforms.
+If you need to install it yourself, the http://wiki.freeradius.org/building/Home[FreeRADIUS Wiki]
+building and installing page contains detailed instructions for a number of platforms.
 
 Otherwise, we assume that you can install the server via something like
 `yum install freeradius`, or `apt-get install freeradius`.
@@ -107,7 +106,7 @@ from another terminal window:
 
 You *should* see the server respond with an `Access-Accept`. If it
 doesn't, the debug log will show why. In version 2, you can paste the
-output into the [debug form](http://networkradius.com/freeradius-debugging/),
+output into the http://networkradius.com/freeradius-debugging/[debug form] ,
 and a colorized HTML version will be produced. In version 3, the
 output will already be colorized in the terminal. Look for red or
 yellow text, and read the relevant messages. They should describe
@@ -185,13 +184,13 @@ steps:
         or `warning`. These messages usually contain descriptions of
         what went wrong, and suggestions for how it can be fixed.
         Also see [an explanation of the debug output](/radiusd-X) and
-        the [debug form](http://networkradius.com/freeradius-debugging/);
+        the http://networkradius.com/freeradius-debugging/[debug form];
     -   try replacing your configuration with a saved copy of a "known
         working" configuration, and start again. This process can clean
         up errors caused by temporary edits, or edits that you have
         forgotten about;
     -   ask for help on the
-        [freeradius-users](http://freeradius.org/support/) mailing
+         http://freeradius.org/support/[freeradius-users] mailing
         list. Include a description of what you are trying to do, and
         the *entire debugging output*, especially output showing the
         server receiving and processing test packets. You may want to
@@ -222,8 +221,8 @@ available from https://networkradius.com/[Network RADIUS].
 
 A number of guides are available from Network
 RADIUS. In particular, we recommend
-the Technical
-Guide(http://networkradius.com/doc/FreeRADIUS%20Technical%20Guide.pdf),
+the http://networkradius.com/doc/FreeRADIUS%20Technical%20Guide.pdf[Technical
+Guide] ,
 which should be read by every new RADIUS administrator. It explains
 RADIUS concepts, and covers how to perform introductory administation
 and maintenance. More in-depth guides are available on the same page.

doc/antora/modules/installation/pages/redhat.adoc → doc/antora/modules/howto/pages/installation/redhat.adoc

@@ -35,7 +35,7 @@ RHE7 ships with GCC 4.8.5 but we require GCC >= 4.9.0 for FreeRADIUS >= v4.0.x.
 
 Fortunately, the ``devtoolset-3`` series of packages provides a later version of GCC.
 
-Follow the instructions here to enable the [devtoolset-3 repository](https://www.softwarecollections.org/en/scls/rhscl/devtoolset-3/).
+Follow these instructions to enable the https://www.softwarecollections.org/en/scls/rhscl/devtoolset-3/[devtoolset-3 repository].
 
 To install:
 

doc/antora/modules/installation/pages/source.adoc → doc/antora/modules/howto/pages/installation/source.adoc

@@ -1,10 +1,10 @@
 == Building from Source
 
-We recommend xref:packages.adoc[installing from packages] if
+We recommend xref:installation/packages.adoc[installing from packages] if
 possible. Full instructions on building and installing from source
 code follow.
 
-The mandatory xref:installation:dependencies.adoc[dependencies]
+The mandatory xref:howto:installation/dependencies.adoc[dependencies]
 must be installed before FreeRADIUS can be built. These dependencies
 are `libtalloc` and `libkqueue`, which FreeRADIUS uses for memory
 management, and platform-independent event handling.
@@ -75,7 +75,7 @@ this may cause undesired behavior and failure to operate correctly.
 
 The initial output from running in debugging mode (`radiusd -X`)
 will tell you which configuration files are being used. See
-xref:installation:upgrade.adoc[Upgrading] for information about
+xref:howto:installation/upgrade.adoc[Upgrading] for information about
 upgrading from older versions. There _may_ be changes in the
 dictionary files which are required for a new version of the
 software. These files will not be installed over your current
@@ -104,7 +104,7 @@ major versions of the server. (For example - version 2 to version 3, or
 version 3 to version 4.
 
 For details on what has changed between the version, see the
-xref:installation:upgrade.adoc[upgrade] guide.
+xref:howto:installation/upgrade.adoc[upgrade] guide.
 
 We _strongly_ recommend that new major versions be installed in a
 different location than any existing installations. Any local policies

doc/antora/modules/installation/pages/upgrade.adoc → doc/antora/modules/howto/pages/installation/upgrade.adoc

@@ -36,7 +36,7 @@ the next change.  If the changes do not work, either keep at it, or
 move to a different portion of the configuration
 
 All of the attribute names used in v3 have been changed in v4.  Please
-see the xref:attribute_names.adoc[attribute names] document for more
+see the xref:installation/attribute_names.adoc[attribute names] document for more
 information.  This change was necessary in order to support the new
 "grouped" attributes, which are required for DHCPv6 and other
 protocols.

doc/antora/modules/howto/pages/modules/rest/index.adoc

@@ -23,7 +23,7 @@ data in that format the REST module expected.
 == xref:modules/rest/custom_data.adoc[Calling REST endpoints with a custom data format]
 
 The REST module can also communicate with arbitrary REST endpoints,
-and versions ≥ v4.0.x include a JSON module xref:raddb/mods-available/json[JSON]
+and versions ≥ v4.0.x include a JSON module xref:reference/raddb/mods-available/json.adoc[JSON]
 which allows mapping elements of a JSON response to FreeRADIUS.
 
 If you're attempting to integrate an existing REST API, this section will provide

doc/antora/modules/howto/pages/os/letsencrypt.adoc

@@ -27,7 +27,7 @@ The instructions here depend on the following criteria:
   certificate for your RADIUS server, and are aware of the
   security considerations in doing so.
 
-- You wish to use [LetsEncrypt[(https://letsencrypt.org/) for this
+- You wish to use https://letsencrypt.org/[LetsEncrypt] for this
   purpose, and want certificate renewals (usually every 2-3 months) to
   be automatic.
 
@@ -47,7 +47,7 @@ but that configuration is beyond the scope of this document.
 
 == Set up process
 
-The instructions here use LetsEncrypt's [certbot](https://certbot.eff.org/) tool to generate
+The instructions here use LetsEncrypt's https://certbot.eff.org/[certbot] tool to generate
 certificates and renew them when necessary. Other alternative
 tools can be used based on the following instructions.