Documentation

Documentation is organised by product:

The manuals are extracted from the master branch, so if you are on an older version and experience problems with missing features, it is a good idea to check the documentation that shipped with your version.

In addition we have:

FireHOL

If you are a new user, first read:

There is also reference information:

A complete list of guides and tutorials for FireHOL is in this table:

Guide Level Description
FireHOL Welcome Guide Beginner Introduction to the most important concepts in FireHOL.
FireHOL New User Beginner Tutorial to set up your first FireHOL firewall.
FireHOL IPv6 Setup Beginner Add IPv6 functionality to your new firewall.
FireHOL Rules by Goal Beginner Learn to translate your firewalling objectives into FireHOL rules.
Firewall Testing Beginner Links to tools which help you check your firewall is doing what you want.
Firewall Troubleshooting Beginner Firewall not behaving as you want? Learn how read the logs to work out why.
FireHOL QuickStart Intermediate For the impatient. Ask FireHOL to guess a configuration which you then customise.
Upgrading FireHOL Intermediate When you change major versions of FireHOL (e.g. 1.x to 2.x), read this guide.
Adding Services to FireHOL Intermediate How to extend FireHOL with your own service definitions.
FireHOL Support for ipset Intermediate FireHOL can make use of ipset to manage lists of IP addresses and allow dynamic changes without restarting the firewall.
When FireHOL Runs Intermediate How FireHOL goes about its work. Important to understanding the different phases and what protection is offered at each.
FireHOL Border Router Advanced How to use FireHOL on a border router with multiple routes.
ICMPv6 recommendations Advanced Learn about the RFC 4890 recommendations and how FireHOL helps you implement them.
Language Features Advanced How you can use BASH in your configuration.

You can still access the original v1.x new user guide.

Got an idea for a guide or willing to write one? See here.

FireQOS

If you are a new user, first read:

There is also reference information:

A complete list of guides and tutorials for FireHOL is in this table:

Guide Level Description
FireQOS New User Beginner Tutorial to set up your first FireQOS traffic control configuration.

Got an idea for a guide or willing to write one? See here.