Community Plugins / HAProxy - ditch outdated documentation without owner.

source/manual/how-tos/haproxy.rst

@@ -1,213 +0,0 @@
-=======
-HAProxy
-=======
-
-------------
-Installation
-------------
-
-First of all, you have to install the HAProxy plugin (os-haproxy) from the
-plugins view.
-
-.. image:: ../images/menu_plugins.png
-
--------------------------------------
-First Step: Configure Backend Servers
--------------------------------------
-
-.. image:: images/haproxy_servers.png
-
-On the "Servers" page, click `+` to open a dialog to create a new server.
-A server consist of a name, IP and port.
-Create an entry for every Server you want to load balance.
-
-.. image:: images/haproxy_edit_server.png
-
-For a HTTP Backend, configure like this:
-
-========================== ===========================
-**Name**                   Name of this server
-**Description**            Keep it empty
-**FQDN or IP**             Enter the IP of your Server
-**Port**                   Port of the Server
-**SSL**                    Keep the default (disabled)
-**Verify SSL Certificate** Keep the default (checked)
-**SSL Verify CA**          Keep the default (empty)
-========================== ===========================
-
---------------------------------
-Second Step: Configure a Backend
---------------------------------
-
-Now, as we have the backend services,
-we can build a backend by combining them to groups of
-servers, which will serve the same service.
-For example if you are hosting a Webservice and want to
-scale horizontally, every server in the cluster will be
-a "Server", but they will be combined to a so called
-"Backend", so HAProxy can load balance between them.
-
-To create a new Backend, click the `+`.
-
-
-.. image:: images/haproxy_backends.png
-
-And fill out the form:
-
-.. image:: images/haproxy_edit_backend.png
-
-.. Note::
-    The "Balancing Algorithm" field is important to care about as many
-    web applications depend on a state.
-    For example, if your web application stores session data on a local
-    disk, you may get some trouble when using an algorithm like Round
-    Robin. In such a case, the request of the same client always needs
-    to be sent to the same backend servers.
-    For example by default PHP stores session data in files while Ruby
-    on Rails stores session information in a cookie by default.
-    Please look up your web framework documentation for information how
-    this is handled. Consider writeing files as problematic as well if
-    there is no shared storage.
-
-======================= ===============================================
-**Enabled**             Enable the Backend (checked)
-**Name**                Enter a name for the Backend
-**Description**         Enter an optional description
-**Mode**                Select the mode HTTP as this is an HTTP backend
-**Balancing Algorithm** Select an load balancing algorithm
-**Servers**             Select the previously configured servers
-======================= ===============================================
-
---------------------------------
-Third Step: Configure Conditions
---------------------------------
-
-In this step an Condition will has to be created which is later used to decide
-which traffic from a frontend belongs to which backend.
-
-To create a new Condition, you have to go to "Rules & Checks -> Conditions" 
-and create one by clicking the `+` button:
-
-(Picture is from Previous Version but it still looks as good as the same)
-
-.. image:: images/haproxy_acls.png
-
-In the open modal dialog, the following form will show up:
-
-.. image:: images/haproxy_edit_acl.png
-
-==================== ================================================
-**Name**             Choose a name for this Condition
-**Description**      Keep it empty or choose one for your information
-**Expression**       Select "Host contains"
-**Negate condition** Keep it unchecked
-**Value**            Enter the (partial) hostname to compare
-==================== ================================================
-
-Click "Save changes".
-
----------------------------------------
-Fourth Step: Configure an Rule
----------------------------------------
-
-As promised in the previous step, the Conditions will be used. 
-A Rule can use multiple conditions to decide which Rule is going to be used.
-To create a new Rule, you have to go to "Rules & Checks -> Rules" 
-and create one by clicking the `+` button:
-
-(Picture is from Previous Version but it still looks as good as the same)
-
-.. image:: images/haproxy_actions.png
-
-A form dialog opens and we can fill it out like the following:
-
-(Picture is from Previous Version but it still looks as good as the same)
-
-.. image:: images/haproxy_edit_action.png
-
-.. Note::
-    You can map multiple Hostnames to the same Backend by adding multiple
-    ACLs and choosing the logical operator "OR".
-
-==================== ===================================
-**Name**             Choose a name for this Action
-**Description**      You can add an optional description
-**Test Type**        Keep it at the default ("IF")
-**Select ACLs**      Select the ACLs to be used
-**Logical operator** Keep the default ("AND")
-**Choose action**    Choose "Use Backend"
-**Use Server**       Keep the default ("none")
-==================== ===================================
-
--------------------------------
-Fifth Step Configure a frontend
--------------------------------
-
-Now its nearly done. The only thing that needs to be configured for HAProxy
-is a Public Service.
-A Public Service is a a group of bound ports which are used for incoming connections.
-From this Public Service we need to know which backend the request will routed to.
-For this, the previously configured action is needed.
-If you got multiple domains with the same port on one IP, you differentiate them with rules! 
-Don't create multiple Public Services. For example, if you only want to forward example.org:80 and example.com:80, just create one Public Service. If you want to forward example.org:80, example.org:443, example.com:80, and example.com:443, create only two Public Services, one for port 80 (example.org and example.com) and one for port 443 (example.org and example.com).
-
-To create a new Public Service, click the `+` button:
-
-(Picture is from Previous Version but it still looks as good as the same)
-
-.. image:: images/haproxy_frontends.png
-
-The following modal dialog opens and the frontend can be set up:
-
-.. image:: images/haproxy_edit_frontend.png
-
-.. Warning::
-    If you configure a port that is already in use, the configuration test
-    will be successful but the start of HAProxy will fail silently.
-    Please ensure that the used port is free - especially if the number
-    conflicts with the web configuration of OPNsense.
-
-    
-General Settings
-================
-
-=================== ===========================================================================
-**Enabled**          Checked
-**Name**             Use any name
-**Description**      You may keep it empty
-**Listen Address**   Enter one or more host:port combinations, use 0.0.0.0:80 for HTTP via IPv4
-**Type**             Choose HTTP / HTTPS
-**Default Backend**  Keep the default of "None"
-=================== ===========================================================================
-
-Advanced settings
-=================
-
-Enbable the X-Forwarded-For-header so the backend will know the real IP of
-the client.
-
-Actions (ACLs)
-==============
-
-Here you have to activate the previously configured actions, so HAProxy
-is going to operate based due the rules/conditions.
-
-All other Options
-=================
-
-Keep all other options at the default
-
-----------------------------
-Sixth step: Enable and start
-----------------------------
-
-This is the last step - on the General tab, we will enable the service
-after a config test.
-
-.. image:: images/haproxy_general.png
-
-For that, the "Enable HAProxy" checkbox needs to be checked.
-
-On this screen, check "Enable HAProxy" and click "Apply".
-If everything went OK HAProxy will start.
-Now you need to configure firewall rules for accessing your HAProxy instance.

source/manual/how-tos/haproxy_howtos.rst

@@ -1,85 +0,0 @@
-HAProxy How-Tos
-===============
-
-Redirect Root directory
------------------------
-
-Create a condition:
-
-.. image:: images/haproxy_root_path_condition.png
-
-============== ==============
-name           root
-Condition type Path matches
-Path matches   /
-============== ==============
-
-Create a Rule:
-
-.. image:: images/haproxy_forward_to_dir_rule.png
-
-======================= ===================================================
-name                    forward_to_dir
-Test type               IF
-conditions              root
-Logical ops             none
-Execute function        http-request redirect
-HTTP Redirect parameter code 301 location http://www.example.net/directory/
-======================= ===================================================
-
-Please note that 301 is for a permanent redirect. If you want to do it teporary,
-you will have to use another status code.
-
-
-
-Under Public Services edit your frontend and add "forward_to_dir" to Select Rules.
-
-.. image:: images/haproxy_forward_to_dir_service.png
-
-
-Add Basic Authentication to a Service
--------------------------------------
-
-I have a Webapplication which have to be exposed to the outside and doesn't allow authentication.
-So HAProxy with basic auth would be just fine to get a mininum of security.
-
-* Go to "Rules & Conditions" - "Conditions" and Add a new one:
-
-.. image:: images/haproxy_condition_add_authentication.png
-
-=================== =================
-name                choose a name
-Condition type      Custom
-option pass-through http_auth(admins)
-=================== =================
-
-* Add a rule:
-
-.. image:: images/haproxy_edit_rule_authentication.png
-
-================ =================================
-name             a name for your rule
-Test type        UNLESS
-condition        select the previously created one
-Logical operator none
-Execute function http-request auth"
-================ =================================
-
-* Go to your frontend and add the ACL to it.
-
-.. image:: images/haproxy_frontend_add_authentication.png
-
-
-* Go to :menuselection:`Settings --> Global Parameters`, enable the advanced mode (top left), and add your users to configuration
-  via the "Custom options"
-
-.. image:: images/haproxy_settings_global_params_auth.png
-
-
-.. code-block:: none
-
-    userlist admins
-    user test1 insecure-password pw1
-    user test2 insecure-password pw2
-
-

source/manual/reverse_proxy.rst

@@ -207,7 +207,6 @@ Basic Reverse Proxy Setup
 -------------------------
 * :doc:`how-tos/nginx`
 * :doc:`how-tos/nginx_streams`
-* :doc:`how-tos/haproxy`
 * :doc:`how-tos/mailgateway`
 
 

source/plugins.rst

@@ -58,8 +58,6 @@ Web
    manual/antivirus
    manual/how-tos/c-icap
    manual/how-tos/clamav
-   manual/how-tos/haproxy
-   manual/how-tos/haproxy_howtos
    manual/how-tos/nginx
    manual/how-tos/nginx_header_hardening
    manual/how-tos/nginx_hosting