README.md
1# [E2Guardian](http://e2guardian.org)
2
3This is the v5 production version - v5.3.4
4
5Note that large sections of the code has been re-written and there are
6significant changes to the configuration files in this release.
7
8Note: Configuration files in this version are not backward compatable
9with v4 configuration files.
10
11Please read notes/NEWIN_v5 before installing.
12
13**For copyright go to: http://e2guardian.org**
14
15e2guardian is a content filtering proxy that can work in
16explicit and transparent proxy mode or as a ICAP server mode.
17More information can be found in the "notes" subdirectory of the distribution,
18and the comments in the configuration and list files themselves.
19
20e2guardian is a fork of [DansGuardian](http://dansguardian.org) and the
21maintainers fully acknowledge the work carried out by and the copyright
22of Daniel Baron and other contributors to the Dansguardian project.
23
24Read the INSTALL for installation instructions.
25
26## Contributing
27
28Github: https://github.com/e2guardian
29
30* v5develop is used to develop new features
31* Bugfixes primarily occurs in the version branch
32
33## Bugs and Feature Requests
34
35Github: https://github.com/e2guardian/e2guardian/issues
36
37Codacy Badge:
38[](https://www.codacy.com/app/numsys/e2guardian?utm_source=github.com&utm_medium=referral&utm_content=e2guardian/e2guardian&utm_campaign=Badge_Grade)
39
40## Community
41
42* Join the [Community
43 Forum](https://groups.google.com/forum/#!forum/e2guardian).
44
45## License
46
47Copyright 2018, [Frederic Bourgeois](http://numsys.eu), [E2BN Protex](http://protex.e2bn.org) Ltd and others.
48
49This program is free software; you can redistribute it and/or modify
50it under the terms of the GNU General Public License version 2 as
51published by the Free Software Foundation.
52
53This program is distributed in the hope that it will be useful,
54but WITHOUT ANY WARRANTY; without even the implied warranty of
55MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
56GNU General Public License for more details.
57
58You should have received a copy of the GNU General Public License
59along with this program; if not, write to the Free Software
60Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
61
62In addition, as a special exception, the copyright holders
63of this work, give permission to link the code of its release of e2guardian
64with the OpenSSL project's "OpenSSL" library (or with modified versions of
65it that use the same license as the "OpenSSL" library), and distribute the
66linked executables. You must obey the GNU General Public License in all
67respects for all of the code used other than "OpenSSL". If you modify this
68file, you may extend this exception to your version of the file, but you are
69not obligated to do so. If you do not wish to do so, delete this exception
70statement from your version.
71