From: nolade Date: Wed, 29 Jan 2025 21:56:25 +0000 (-0500) Subject: Moved Installation module to under the Howto module X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=861c5c937a4b95703c66dba2b85c3380ceeaf968;p=thirdparty%2Ffreeradius-server.git Moved Installation module to under the Howto module Please enter the commit message for your changes. Lines starting Howto & Installation modules topo updates --- diff --git a/doc/antora/antora.yml b/doc/antora/antora.yml index 75e29ed5bf1..2ad8d6d9d50 100644 --- a/doc/antora/antora.yml +++ b/doc/antora/antora.yml @@ -13,6 +13,6 @@ nav: - modules/concepts/nav.adoc - modules/reference/nav.adoc - modules/howto/nav.adoc -- modules/installation/nav.adoc +#- modules/installation/nav.adoc - modules/tutorials/nav.adoc - modules/developers/nav.adoc diff --git a/doc/antora/modules/ROOT/pages/index.adoc b/doc/antora/modules/ROOT/pages/index.adoc index d04d192bb93..91b75bf000c 100644 --- a/doc/antora/modules/ROOT/pages/index.adoc +++ b/doc/antora/modules/ROOT/pages/index.adoc @@ -40,7 +40,7 @@ desired outcome. At a high level, the subject areas describe: * The xref:reference:raddb/index.adoc[configuration files] located in `/etc/raddb/`, or `/etc/freeradius/` * The syntax of the xref:reference:unlang/index.adoc[unlang] processing language * Various xref:howto:index.adoc[how-to] guides -* 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 * xref:developers:index.adoc[Developer documentation] This organization means that for example, the `ldap` module will have @@ -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 diff --git a/doc/antora/modules/developers/pages/index.adoc b/doc/antora/modules/developers/pages/index.adoc index 1fecdda0027..660c08d4467 100644 --- a/doc/antora/modules/developers/pages/index.adoc +++ b/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. diff --git a/doc/antora/modules/howto/nav.adoc b/doc/antora/modules/howto/nav.adoc index 49d7318f346..22d70ec8fdf 100644 --- a/doc/antora/modules/howto/nav.adoc +++ b/doc/antora/modules/howto/nav.adoc @@ -1,4 +1,15 @@ * xref:index.adoc[Howto Guides] + +** xref:howto:installation/index.adoc[Installing and upgrading] +*** xref:howto:installation/packages.adoc[Install from packages] +*** xref:howto:installation/dependencies.adoc[Dependencies] +*** xref:howto:installation/source.adoc[Build from source] +*** xref:howto:installation/upgrade.adoc[Upgrading from v3 to v4] +*** xref:howto:installation/attribute_names.adoc[Attribute name changes from v3 to v4] +*** Building Packages +**** xref:howto:installation/debian.adoc[Debian and Ubuntu] +**** xref:howto:installation/redhat.adoc[RedHat and CentOS] + ** Modules *** xref:modules/configuring_modules.adoc[Configuring Modules] *** xref:modules/chap/index.adoc[CHAP] diff --git a/doc/antora/modules/installation/pages/attribute_names.adoc b/doc/antora/modules/howto/pages/installation/attribute_names.adoc similarity index 100% rename from doc/antora/modules/installation/pages/attribute_names.adoc rename to doc/antora/modules/howto/pages/installation/attribute_names.adoc diff --git a/doc/antora/modules/installation/pages/debian.adoc b/doc/antora/modules/howto/pages/installation/debian.adoc similarity index 100% rename from doc/antora/modules/installation/pages/debian.adoc rename to doc/antora/modules/howto/pages/installation/debian.adoc diff --git a/doc/antora/modules/installation/pages/dependencies.adoc b/doc/antora/modules/howto/pages/installation/dependencies.adoc similarity index 100% rename from doc/antora/modules/installation/pages/dependencies.adoc rename to doc/antora/modules/howto/pages/installation/dependencies.adoc diff --git a/doc/antora/modules/installation/pages/index.adoc b/doc/antora/modules/howto/pages/installation/index.adoc similarity index 98% rename from doc/antora/modules/installation/pages/index.adoc rename to doc/antora/modules/howto/pages/installation/index.adoc index 4f9f726daa3..70e68ba34a8 100644 --- a/doc/antora/modules/installation/pages/index.adoc +++ b/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:howto:installation/packages.adoc[Network RADIUS packages] +* xref:howto:installation/source.adoc[Source code] * Many Operating System distributions We highly recommend using the official packages from Network diff --git a/doc/antora/modules/installation/pages/osx.adoc b/doc/antora/modules/howto/pages/installation/osx.adoc similarity index 100% rename from doc/antora/modules/installation/pages/osx.adoc rename to doc/antora/modules/howto/pages/installation/osx.adoc diff --git a/doc/antora/modules/installation/pages/packages.adoc b/doc/antora/modules/howto/pages/installation/packages.adoc similarity index 100% rename from doc/antora/modules/installation/pages/packages.adoc rename to doc/antora/modules/howto/pages/installation/packages.adoc diff --git a/doc/antora/modules/installation/pages/redhat.adoc b/doc/antora/modules/howto/pages/installation/redhat.adoc similarity index 100% rename from doc/antora/modules/installation/pages/redhat.adoc rename to doc/antora/modules/howto/pages/installation/redhat.adoc diff --git a/doc/antora/modules/installation/pages/redhat_faq.adoc b/doc/antora/modules/howto/pages/installation/redhat_faq.adoc similarity index 100% rename from doc/antora/modules/installation/pages/redhat_faq.adoc rename to doc/antora/modules/howto/pages/installation/redhat_faq.adoc diff --git a/doc/antora/modules/installation/pages/solaris.adoc b/doc/antora/modules/howto/pages/installation/solaris.adoc similarity index 100% rename from doc/antora/modules/installation/pages/solaris.adoc rename to doc/antora/modules/howto/pages/installation/solaris.adoc diff --git a/doc/antora/modules/installation/pages/source.adoc b/doc/antora/modules/howto/pages/installation/source.adoc similarity index 96% rename from doc/antora/modules/installation/pages/source.adoc rename to doc/antora/modules/howto/pages/installation/source.adoc index d43d4ebd48f..92242accf91 100644 --- a/doc/antora/modules/installation/pages/source.adoc +++ b/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:howto: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 diff --git a/doc/antora/modules/installation/pages/suse.adoc b/doc/antora/modules/howto/pages/installation/suse.adoc similarity index 100% rename from doc/antora/modules/installation/pages/suse.adoc rename to doc/antora/modules/howto/pages/installation/suse.adoc diff --git a/doc/antora/modules/installation/pages/upgrade.adoc b/doc/antora/modules/howto/pages/installation/upgrade.adoc similarity index 99% rename from doc/antora/modules/installation/pages/upgrade.adoc rename to doc/antora/modules/howto/pages/installation/upgrade.adoc index 1c01f08c488..00e75fb29aa 100644 --- a/doc/antora/modules/installation/pages/upgrade.adoc +++ b/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:howto: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. diff --git a/doc/antora/modules/installation/nav.adoc b/doc/antora/modules/installation/nav.adoc index 36fc56b6e2a..ed11fb9f82d 100644 --- a/doc/antora/modules/installation/nav.adoc +++ b/doc/antora/modules/installation/nav.adoc @@ -1,9 +1,9 @@ -* xref:index.adoc[Installing and upgrading] -** xref:packages.adoc[Install from packages] -** xref:dependencies.adoc[Dependencies] -** xref:source.adoc[Build from source] -** xref:upgrade.adoc[Upgrading from v3 to v4] -** xref:attribute_names.adoc[Attribute name changes from v3 to v4] +* xref:howto:installation/index.adoc[Installing and upgrading] +** xref:howto:installation/packages.adoc[Install from packages] +** xref:howto:installation/dependencies.adoc[Dependencies] +** xref:howto:installation/source.adoc[Build from source] +** xref:howto:installation/upgrade.adoc[Upgrading from v3 to v4] +** xref:howto:installation/attribute_names.adoc[Attribute name changes from v3 to v4] ** Building Packages -*** xref:debian.adoc[Debian and Ubuntu] -*** xref:redhat.adoc[RedHat and CentOS] +*** xref:howto:installation/debian.adoc[Debian and Ubuntu] +*** xref:howto:installation/redhat.adoc[RedHat and CentOS] diff --git a/doc/antora/modules/reference/pages/raddb/index.adoc b/doc/antora/modules/reference/pages/raddb/index.adoc index d20b94b4210..3da86cef9f8 100644 --- a/doc/antora/modules/reference/pages/raddb/index.adoc +++ b/doc/antora/modules/reference/pages/raddb/index.adoc @@ -98,7 +98,7 @@ Note that unlike v3, there are no longer any `authorize`, been renamed. This change was necessary in order to simplify the operation of the server, and to better support multiple protocols. -Please see the xref:installation:upgrade.adoc[upgrade] file for more +Please see the xref:howto:installation/upgrade.adoc[upgrade] file for more information about these changes. The `sites-available/` directory contains many files. Each file is a