Debian Codegraph @

notes/Upgrading_to_V5

raw
1 Upgrading to V5 from e2guardian v4
2
3 V5 introduces a completely new model for definition and handling of lists,
4 logic flow and support for two new modes - transparent(HTTP & HTTPS) and ICAP.
5
6 There are changes to the configuration files, mainly in list definition,
7 but also some other options have been replaced by storyboard options.
8
9 The e2guardian.conf is still used for global settings and
10 e2guardianfn.conf for settings specific to group 'n'.
11
12 Both these files contain revised list definitions. For comptability with
13 older versions the same list names and paths are retained, so you do
14 not need to alter your list file structure, unless you want to take
15 advantage of the new siteiplists. Details of revised list definition syntax
16 is in notes/V5_list_definition.pdf. Note that blanket block is now defined in
17 fn.story and dg style blanket blocks (*, *ip etc) in list files are ignored.
18
19 A number of settings have been moved into new Storyboard config files.
20 These are noted in the example e2guardian.conf and e2guardianf1.conf files.
21
22 For details on Storyboard syntax see notes/V5_Storyboard.pdf
23
24 The new Storyboard config files are:-
25
26 common.story - a library of storyboard functions - you will not need
27 to change this file, but you may need to refer to it if you need to
28 make more complex changes to the logic flow. This provides a logic
29 functionality as near as possible to v4 built-in logic.
30
31 pre-auth.story - actions to be taken before user is put into a filter
32 group. You may need to edit this.
33
34 site.story - site deployment modification of Storyboard library - you may
35 need to edit this in order to change the site-wide logic.
36
37 fn.story - one per filtergroup - an examplef1.story is provided - you
38 are likely to need to edit this.
39
40 UPGRADE PROCEDURE
41
42 Before upgrading make a backup of all your v4 configuration & lists. You will
43 need to refer to these after the install.
44
45 Install E2guardian V5 in a clean area.
46
47 Edit e2guardian.conf to your requirements. If you are going to use
48 transparent mode set the default group for transparent mode.
49 Leave proxy_ip commented out unless you need to use an upstream proxy.
50
51 Edit each e2guardianfn.conf to your requirements.
52
53 Using examplef1.story as a template create a fn.story for each filtergroup,
54 actioning any blanket block required.
55
56 If you want to use tranparent https mode redirect port 443 to 8443.