~ubuntu-branches/ubuntu/raring/maradns/raring

« back to all changes in this revision

Viewing changes to deadwood-2.4.10/doc/internals/CACHE.FILE

  • Committer: Bazaar Package Importer
  • Author(s): Kai Hendry
  • Date: 2010-01-24 12:17:40 UTC
  • mfrom: (1.1.13 upstream) (10.1.4 sid)
  • Revision ID: james.westby@ubuntu.com-20100124121740-a4e1fjobwaouz443
Tags: 1.4.02-1
New upstream release

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
It is now possible to write the contents of Deadwood-2's cache to a 
 
2
file, and to read the contents of said file to update the cache.  This 
 
3
is useful for people with intermittent online connections, who may wish 
 
4
to connect to sites even if their upstream DNS server is dodgy.
 
5
 
 
6
To enable this feature, add a line such as the following to your 
 
7
dwood2rc file:
 
8
 
 
9
        cache_file = "cache/dwood_cache"
 
10
 
 
11
The '/' is used to place the cache in a separate directory; the 
 
12
location of the filename is relative to the chroot_dir parameter; for 
 
13
example, if ones dwood2rc file has the two following lines:
 
14
 
 
15
        chroot_dir = "/etc/deadwood"
 
16
        cache_file = "cache/dwood_cache"
 
17
 
 
18
Then the cache file would be stored in the file 
 
19
"/etc/deadwood/cache/dwood_cache".
 
20
 
 
21
Note that, for security reasons, the cache_file can not have any 
 
22
characters besides lowercase letters, the '-' symbol, the '_' symbol, 
 
23
and the '/' symbol.  Any other symbols in the filename are converted to 
 
24
'_'; in particular, the '.' symbol is not allowed.
 
25
 
 
26
The user-id and group-id that the file is read as and written as are 
 
27
determined by the maradns_uid and maradns_gid parameters (the reason for 
 
28
these names is for maximum MaraDNS mararc compatibility).  For example, 
 
29
in some systems, the user-id and group-id '99' indicate the "nobody" 
 
30
user; this would be set up as follows in the dwood2rc file:
 
31
 
 
32
        maradns_uid = 99
 
33
        maradns_gid = 99
 
34
 
 
35
Note that you need to use the numeric user and group id values; like 
 
36
MaraDNS, Deadwood-2 doesn't look up usernames in /etc/passwd.
 
37
 
 
38
Optimally, one would create a "deadwood" user and group, which no other 
 
39
application shares, and have Deadwood's user and group ID be the user 
 
40
and group ID of the deadwood user.
 
41
 
 
42
Once this is done, one should ideally have Deadwood's chroot directory 
 
43
be a directory the deadwood user can *not* write in, and a subdirectory 
 
44
that the deadwood user can write in (ideally owned by Deadwood with 700 
 
45
permissions; the cache does list what web sites users go to, which has 
 
46
privacy implications).
 
47