FreeRADIUS · aBainbridge11 · Jul 23, 2024 · Jul 23, 2024 · Jul 23, 2024 · Jul 23, 2024
diff --git a/Home.md b/Home.md
@@ -1,48 +1 @@
-# Wiki Home
-
-If you are new to FreeRADIUS, or wondering if it will be suitable for your requirements, please see **[[the overview and features|Overview-and-Features]]** that it provides.
-
-## Documentation
-
-**Beginners are strongly recommended to read these two pages first:**
-
-* **The [[concepts|guide/Concepts]] page**, which provides a very light overview of how the server works.
-* **The [[getting started|guide/Getting Started]] page**, which gives an introduction to installing and configuring the server.
-
-A short introduction to RADIUS concepts, and to FreeRADIUS itself, is also available [[in the technical guide|http://networkradius.com/doc/FreeRADIUS%20Technical%20Guide.pdf]] (PDF).
-
-This wiki collects a large amount of documentation relating to [[glossary|glossary/RADIUS]] together in one place. Pages of particular interest to newcomers will be the [[FAQ|guide/FAQ]] and [[HOWTO|guide/HOWTO]] sections, although the [[Traditional FreeRADIUS docs page|http://www.freeradius.org/doc/]] the [[docs|https://github.com/FreeRADIUS/freeradius-server/tree/master/doc]] folder included in the server distribution also include "man" pages, and other documentation.
-
-There are many third-party web sites and HOWTO's that give advice on FreeRADIUS.  They are usually years out of date, and refer to old versions. The advice that they give is also wrong.  We **strongly** recommend that you avoid most third-party documentation.
-
-The following is an overview of the types of information available:
-
-* [[Building and installing|building/Home]]
-* [[The User's mailing list|guide/Users Mailing List]]
-* [[Interpreting debug mode output (radiusd -X)|guide/radiusd-X]] 
-* [[Configuration|config/Configuration files]]
-* [[Base Modules|project/List of Modules]]
-* [[Radius Clients|glossary/Radius Clients]]
-* [[FAQ|guide/FAQ]]
-* [[HOWTO|guide/HOWTO]] example setups, vendor docs, and cookbooks.
-* [[glossary|glossary/RADIUS]]
-* [[Upgrading|upgrading/Home]]
-
-## Contributing
-FreeRADIUS is an open source project and as such depends on contributions from its users. Even if you don't know C you can still contribute to the project by editing documentation on the wiki, posting bugs on [[GitHub|https://github.com/FreeRADIUS/freeradius-server/issues]] or helping out on the [[users mailing list|Mailing-list#Users+list]].
-
-If you are comfortable coding in C and have a patch or new module you'd like to see included in the main distribution, please see the [[submitting patches via GitHub|contributing/GitHub]] page for instructions on generating a 'pull request'. See also:
-
-* [[API and internal functions|http://doc.freeradius.org]]
-* Creating your own [[Modules for FreeRADIUS Version 3|contributing/Modules3]]
-* [[Coding standards|contributing/coding-standards]]
-* [[Design documents|design/Home]]
-
-For major refactoring and new modules, add an issue to [[GitHub|https://github.com/FreeRADIUS/freeradius-server/issues]], so that the core project team can comment on the proposed work.
-
-## Bug reports
-If you find an issue in the server please report it so that it can be fixed in a future release. The procedure for reporting defects can be found [[here|project/bug-reports]].
-
-## This Wiki
-This Wiki is now hosted on a FreeRADIUS project server, with a gollum front end backed by "git".  It is now easier to login and make changes.  Please see the [[New Wiki]] Page for details.
-
+/doc/antora/modules/ROOT/pages/index.adoc
diff --git a/Mediawiki Renderer Issues.mediawiki b/Mediawiki Renderer Issues.mediawiki
@@ -1,17 +1 @@
-== Foo title ==
-* Bullet one
-* Bullet two
-* Bullet three
-
-== [[Foo title]] ==
-
-== Broken table ==
-{| border="2" cellpadding="3" style="border-collapse:collapse"
-!Radius Attribute!!Times used!!Description!!Value String!!Value 
-|-
-|Tunnel-Type||1||Type of tunnel||VLAN||13
-|-
-|Tunnel-Medium-Type||1||Tunnel transport medium||IEEE-802||6
-|-
-|Tunnel-Private-Group-ID||1||Numeric ingress/egress VLAN ID to be assigned||-||<VLAN_ID>
-|}
+/doc/antora/modules/ROOT/pages/index.adoc
diff --git a/New Wiki.md b/New Wiki.md
@@ -1,62 +1 @@
-## But what was wrong with the old wiki?
-
-One of the largest complaints with FreeRADIUS is the lack of comprehensive documentation.
-
-The previous wiki  has served its purpose, but has ultimately failed to provide an up-to-date, well organised source of documentation.
-
-The major problems with the previous wiki were:
-
-* spam users - which meant we had to lock registration, and discouraged new users from contributing
-* exporting information - all pages are stored in an sql lite instance, which made it hard to automatically roll pages into releases
-* formatting information - Information stored in the wiki was/is in the Media wiki format, whereas the documentation bundled with FreeRADIUS is either unformatted or in rst format.
-
-To try and solve these issues and glue everything together a bit more, we setup this new wiki based on Gollum. Gollum is a ruby on rails application which exposes a git repository as wiki site. Gollum can render files in many markup languages including plaintext, RST and Mediawiki format, which means we can import all current server documentation, all current wiki documentation and have them neatly presented in a single wiki site. Neat huh?
-
-But what about spam and registration? Well by default gollum doesn't authenticate anyone. But because it's a rails application we can drop in a library called 'OmniAuth' which uses Oauth to authenticate a bunch of providers.
-
-This allows us to leverage authentication and spam account prevention services of providers like GitHub, Facebook and Twitter.
-
-## Helping out
-Unfortunately the new wiki needs some fixes. The mediawiki page format renderer in gollum isn't perfect, so we need to convert the pages which don't render correctly to RST as a priority.
-
-If you want to help out, please do the following:
-
-1. Sign up for GitHub (or anything that supports oAuth)
-2. Pick a page where the MediaWiki format doesn't render correctly
-3. Click the 'Edit page' button
-4. Change edit mode from MediaWiki to reStructuredText or Markdown
-5. Convert markup to [Markdown](http://daringfireball.net/projects/markdown/syntax#precode) ([Tables](http://www.justatheory.com/computers/markup/markdown-table-rfc.html), [Cheat sheet](http://hw.libsyn.com/p/8/3/3/8339a864bb8faa83/Markdown_Cheat_Sheet.pdf))
-6. Save the page
-7. Get warm fuzzy glow from contributing to open source
-
-Also please report any bugs here:
-[gollum issue tracker](https://github.com/github/gollum/issues?_pjax=true&state=open)
-
-## Known Issues
-* The majority of links are now broken, you can help by editing pages and fixing the links. The pages are now in a directory hierarchy and the links need to be updated. Links are in the format ``[[name|path/page]]``. You'll have to search to figure out where the pages now live.
-
-## Pages that need converting as a priority (please mark here when converted)
-
-### Pages to convert to markdown
-* http://wiki.freeradius.org/Build - ACB 29/05/11
-* http://wiki.freeradius.org/Modules1
-* http://wiki.freeradius.org/RADIUS-Clients
-* http://wiki.freeradius.org/Cisco - JC 01/06/11
-* http://wiki.freeradius.org/PopTop
-* http://wiki.freeradius.org/Attribute%20support%20by%20processing%20list
-* http://wiki.freeradius.org/Attrs - JC 01/06/11
-
-### Pages to convert from RST to markdown
-* http://wiki.freeradius.org/Modules2
-* http://wiki.freeradius.org/Operators - DONE Michael P 07/09/16
-* http://wiki.freeradius.org/FreeRADIUS Active Directory Integration HOWTO
-
-## Todo
-* Enable renaming wiki pages - Arran CB - Done at some point in the distant past.
-* Fix external links - Arran CB - Done 31/05/11 (see here https://github.com/github/gollum/pull/166)
-* Fix per page committer info - Arran CB - Done 22/06/11 
-* Add google as omniauth provider - Arran CB
-* Implement proper fix for page creation - Arran CB - Done 20/06/11
-* Fix TOC for markdown pages - Arran CB - Done 20/06/11
-* Set up anonymous git access for wiki - Alan D
-* Set up commit log to user mailing list - Alan D
+/doc/antora/modules/ROOT/pages/index.adoc
diff --git a/Overview-and-Features.md b/Overview-and-Features.md
@@ -1,41 +1 @@
-Overview
---------
-FreeRADIUS is a modular, high performance and feature-rich [[RADIUS|glossary/RADIUS]] suite including [[server|config/radiusd]], [[radius client|Radclient]], development libraries and numerous additional [[RADIUS|glossary/RADIUS]] related utilities.
-
-As the premiere open source RADIUS suite it is included as a [[standard package|building/packages]] with numerous Operating Systems, has binary packages for many others and has source available which is known to [[build|building/build]] on almost anything. Production deployments include large scale installations comprising multiple [[AAA|glossary/AAA]] servers with over ten million users and millions of requests per day. It supports request [[proxying|config/proxy]], with [[fail-over|config/fail-over]] and [[load balancing|config/load balancing]], as well as the ability to access many types of back-end databases. Different classes of [[authentication|glossary/Authentication]] requests can trigger access of different [[authentication|glossary/Authentication]] and [[authorization|glossary/Authorization]] databases (with cascaded fall back), and [[Accounting|glossary/Accounting]] records can be simultaneously recorded in multiple different storage databases and directories.
-
-[[Other RADIUS Servers|glossary/Other RADIUS Servers]] are available.
-
-We also keep a list of [[acknowledgements|project/Acknowledgements]] of contributions to FreeRADIUS development.
-
-Features
---------
-
-* Complete support for RFC 2865 and RFC 2866 attributes.
-* [[EAP|protocol/EAP]] with EAP-MD5, EAP-SIM, EAP-TLS, EAP-TTLS, [[EAP-PEAP|protocol/EAP-PEAP]], and Cisco [[LEAP|protocol/LEAP]] EAP sub-types
-* [[Vendor Specific Attributes|glossary/Vendor-Specific Attributes]] for almost one hundred vendors, including BinTec, Foundry, [[Cisco|vendor/Cisco]], Juniper, Lucent/Ascend, [[HP ProCurve|vendor/HP]], Microsoft, USR/3Com, Acc/Newbridge and many more.
-
-All known [[RADIUS Clients|glossary/RADIUS Clients]] are supported.
-
-* [[RADIUS Clients|glossary/RADIUS Clients]] 
-* [[EAP Clients|guide/EAP Clients]]
-
-Flexible Configuration
-----------------------
-
-FreeRADIUS provides a wide range of methods to select user configurations. The server can select a configuration based on any of the following criteria : 
-
-* [[attributes|protocol/Attributes]] which have a given value
-* [[attributes|protocol/Attributes]] which do not have a given value
-* [[attributes|protocol/Attributes]] which are in the request (independent of their value)
-* [[attributes|protocol/Attributes]] which are not in the request
-* String [[attributes|protocol/attributes]] which match a regular expression
-* Integer [[attributes|protocol/attributes]] which match a range (e.g. , =)
-* Source IP address of the request. (This can be different from the NAS-IP-Address)
-* Shortname defined for a NAS box. (This can be different from the NAS-Identifier)
-* Group of NAS boxes. (These may be grouped based on Source IP address, NAS-IP-Address, or any other configuration)
-* User-Name
-* DEFAULT template configuration
-* multiple cascading DEFAULT template configurations
-
-In addition, FreeRADIUS supports [[virtual servers|config/virtual server]] which allow several separate sets of configuration data to coexist inside the same server instance.
+doc/antora/modules/concepts/pages/overview.adoc
diff --git a/_Sidebar.md b/_Sidebar.md
@@ -1,12 +1,2 @@
-## Quick Links
-* [[Wiki Home|Home]]
-* [[Concepts for beginners|guide/Concepts]]
-* [[Basic Configuration|guide/Basic configuration Howto]]
-* [[Pre-built packages|building/Pre-built-Packages]]
-* [[Building from source code|building/Home]]
-* [[Troubleshooting|guide/Troubleshooting]]
-* [[Contributing with GitHub|contributing/GitHub]]
-* [[Browse the Source|https://github.com/FreeRADIUS/freeradius-server]]
-* [[Main web site|http://freeradius.org]]
+/doc/antora/modules/ROOT/pages/index.adoc
 
-Always use ``radiusd -X`` when debugging!
diff --git a/building/Building-Ubuntu-packages-from-source.md b/building/Building-Ubuntu-packages-from-source.md
@@ -1,135 +1 @@
-## 2 Ways of installing FreeRadius on Ubuntu 
-
-* Installing from repositories 
-* Installing from source 
-
-### Installing from repositories :
-
-This is usually the easiest solution, but at the moment of writing (2016-06) both Ubuntu 16.04 and Ubuntu 14.04.4 contain packages which are EOL and which are not the latest in their own main version. So building from source is recommended as it will contain the latest version, which probably got most of the bugs sorted.
-
-To Install :
-
-Get the latest info about packages from Ubuntu :
-
-      sudo apt-get update 
-
-Then make sure the system is fully upgraded before installing freeradius :
-
-      sudo apt-get upgrade
-
-or
-
-      sudo apt-get dist-upgrade
-
-After that has been done we can use _apt_ to 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        
-
-The 'apt install freeradius' command will list all the suggested packages.
-
-If all went well freeradius should now be installed and started. You can start or stop the server with :
-
-     sudo service freeradius stop
-
-or
-
-     sudo service freeradius start
-
-Suggested is to stop the service and until all is working use freeradius in debug mode.
-
-      sudo freeradius -X
-
-Right now your config files are in  :
-
-      cd /etc/freeradius
-
-Documentation and files for creation of certificates are in : 
-
-      cd /usr/share/doc/freeradius
-
-
-### Installing from source :
-
-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_.
-
-Make sure unzip or any other utility that can extract the zip is installed. If not :
-
-     sudo apt-get install unzip
-
-Here I download and extract the source to a temporary directory: (I'm using here a directory in my home folder.) Make sure the filename is the same as your downloaded one.
-
-     cd /home/myusername/
-     mkdir freeradius
-     cd freeradius
-     wget https://github.com/FreeRADIUS/freeradius-server/archive/v3.0.x.zip
-
-     unzip v3.0.x.zip
-
-or (depending on type of archive)
-
-      tar zxf freeradius-server-W.X.Y.tar.gz
-
-Now we need to go into the directory containing the source.
-
-      cd freeradius-server-W.X.Y/
-
-And run the following :
-
-      fakeroot dpkg-buildpackage -b -uc
-
-It will probably error out on a clean system. Because the build tools are not installed or because not all dependencies are installed.
-
-Make sure fakeroot and build tools are installed (read the error message!!):
-
-     sudo apt-get install fakeroot dpkg-dev quilt debhelper
-
-In the file _debian/rules_ we might need to make some changes depending on other packages we might not have installed or support that we do (not) need. In one of my own installs, there was no iodbc database support required as I'm using ldap as a database backend. If I build it will give an error and fail to build because of that. You can modify your install in the following way to prevent the error.
-
-     pico debian/rules
-
-And just before 
-
-     --without-rlm_eap_ikev2 \
-
-I create a new line :
-
-     --without-rml_sql_iodbc \
-
-You can remove and add any module that you (do not) require this way.
-
-It might also error with more unmet dependencies to be able to build. When you run the command to build the package but it errors out with a dependencies/conflict abortion, install them as well.
-
-In my clean Ubuntu 16.04 install that meant :
-
-     sudo apt-get install libcurl4-openssl-dev libcap-dev libgdbm-dev libiodbc2-dev libjson0-dev libkrb5-dev libldap2-dev libpam0g-dev libpcap-dev libperl-dev libmysqlclient-dev libpq-dev libreadline-dev libsasl2-dev libsqlite3-dev libssl-dev libtalloc-dev libwbclient-dev libyubikey-dev libykclient-dev libmemcached-dev libhiredis-dev python-dev samba-dev
-
-After that we try again to build.
-
-     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 :
-
-     cd /home/myusername/freeradius
-     rm -R freeradius-server-W.X.Y
-
-And unpack the archive again. I.e.
-
-     unzip v3.0.x.zip
-
-And edit the debian/rules commenting out or adding depending on the error it gave you at the end of the build.
-
-After build has completed without any errors we can finally install.
-
-     cd /home/myusername/freeradius
-     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 )
+/doc/antora/modules/installation/pages/Debian and Ubuntu