Skip to content

Commit

Permalink
Update docs and remove unsupported download manager options from conf…
Browse files Browse the repository at this point in the history
…igure
  • Loading branch information
philipianpearce committed Jan 16, 2018
1 parent 826b0e7 commit 3f0b8eb
Show file tree
Hide file tree
Showing 5 changed files with 56 additions and 56 deletions.
2 changes: 1 addition & 1 deletion configs/e2guardian.conf.in
Expand Up @@ -324,7 +324,7 @@ maxcontentfiltersize = 256

# Max content ram cache scan size
# This is only used if you use a content scanner plugin such as AV
# This is the max size of file that DG will download and cache
# This is the max size of file that e2g will download and cache
# in RAM. After this limit is reached it will cache to disk
# This value must be less than or equal to maxcontentfilecachescansize.
# The size is in Kibibytes - eg 10240 = 10Mb
Expand Down
52 changes: 0 additions & 52 deletions configure.ac
Expand Up @@ -498,58 +498,6 @@ AC_SUBST(COMMANDLINESUPPORT)
AM_CONDITIONAL(NEED_CSLISTS, test "x$cslists" = "xtrue")
AM_CONDITIONAL(NEED_CSCONFIGS, test "x$csconfigs" = "xtrue")

# asking user if they want fancy downloadmanager support
AC_MSG_CHECKING(for fancy download manager support)
AC_ARG_ENABLE(
fancydm,
[AC_HELP_STRING([--enable-fancydm@<:@=yes@:>@], [Enable support for the fancy download manager])],
[ if test "x$enableval" = "xno"; then
fancydm=false
FANCYSUPPORT="#!! Not compiled !! "
AC_MSG_RESULT(no)
else
AC_MSG_RESULT(yes)
fancydm=true
dmlists=true
FANCYSUPPORT=""
AC_DEFINE([ENABLE_FANCYDM],[],[Define to enable fancy download manager])
fi],
[
fancydm=true
dmlists=true
FANCYSUPPORT=""
AC_MSG_RESULT(yes)
AC_DEFINE([ENABLE_FANCYDM],[],[Define to enable fancy download manager])
]
)
AM_CONDITIONAL(ENABLE_FANCYDM, test "x$fancydm" = "xtrue")
AC_SUBST(FANCYSUPPORT)

# asking user if they want trickle downloadmanager support
AC_MSG_CHECKING(for trickle download manager support)
AC_ARG_ENABLE(
trickledm,
[AC_HELP_STRING([--enable-trickledm@<:@=no@:>@], [Enable support for the trickle download manager])],
[ if test "x$enableval" = "xno"; then
trickledm=false
TRICKLESUPPORT="#!! Not compiled !! "
AC_MSG_RESULT(no)
else
AC_MSG_RESULT(yes)
trickledm=true
dmlists=true
TRICKLESUPPORT=""
AC_DEFINE([ENABLE_TRICKLEDM],[],[Define to enable trickle download manager])
fi],
[
trickledm=false
TRICKLESUPPORT="#!! Not compiled !! "
AC_MSG_RESULT(no)
]
)
AM_CONDITIONAL(ENABLE_TRICKLEDM, test "x$trickledm" = "xtrue")
AC_SUBST(TRICKLESUPPORT)

# install DM lists if necessary
AM_CONDITIONAL(NEED_DMLISTS, test "x$dmlists" = "xtrue")

Expand Down
8 changes: 6 additions & 2 deletions notes/NEWIN_v5
Expand Up @@ -118,6 +118,12 @@ INCLUDE FILES IN e2guardianf1.conf
repeats ignored. This allows the overwriting of single options and
re-definion of lists in a structured way.

LIST INPUT VIA STDIN
--------------------

This replaces the totalblocklist in previous versions allowing multiple
lists to be loaded via stdin. See notes/lists_via_stdin.

TESTING -
---------

Expand All @@ -137,8 +143,6 @@ TODO - for this release.
TODO - for next releases.
-----------------------

Multiple total blocks list and revised input format.

Transparent HTTP/HTTPS on ports other than 80/443

POST content filtering
Expand Down
48 changes: 48 additions & 0 deletions notes/lists_via_stdin
@@ -0,0 +1,48 @@
Lists via stdin

This option replaces the totalblocklist feature in previous versions.

It allows lists to be read via stdin on e2guardian start-up. To activate use
the -i option.

List syntax is as normal but with added directives to define lists and indicate
the end of a list. Only sitelist and urllist types are currently supported.

To define a site list use the #SITELIST: directive followed by the list
definition, then a list of sites, terminated with an #ENDLIST line.

#SITELIST:name=list_name, path=memory:psuedo_path_name [ other_modifiers ]

site1
site2
siteN

#ENDLIST

To define a url list use the #URLLIST: directive followed by the list
definition, then a list of urls, terminated with an #ENDLIST line.

#SITELIST:name=list_name, path=memory:psuedo_path_name [ other_modifiers ]

url1
url2
urlN

#ENDLIST

Where list_name is a label as defined in V5_list_definition,
psuedo_path_name is a unique label for this list and
other_modifiers are any optional parameters of a list definition.

These lists are added to any lists defined in e2guardian.conf and can used in
pre-auth.story storyboard.










2 changes: 1 addition & 1 deletion src/e2guardian.cpp
Expand Up @@ -172,7 +172,7 @@ int main(int argc, char *argv[])
std::cout << " -r reloads lists and group config files by issuing a HUP," << std::endl;
std::cout << " but this does not reset the httpworkers option (amongst others)." << std::endl;
std::cout << " -g same as -r (Issues a USR1)" << std::endl;
std::cout << " -i read total block list from stdin" << std::endl;
std::cout << " -i read lists from stdin" << std::endl;
#ifdef __BENCHMARK
std::cout << " --bs benchmark searching filter group 1's bannedsitelist" << std::endl;
std::cout << " --bu benchmark searching filter group 1's bannedurllist" << std::endl;
Expand Down

0 comments on commit 3f0b8eb

Please sign in to comment.