1
# $Id: OpenFT.conf.template,v 1.12 2004/09/03 01:06:12 hexwab Exp $
2
###############################################################################
4
###############################################################################
10
# Node classification. This value is very important and will determine your
11
# potential role on the network. The following settings are allowed:
15
# Basic class that all nodes implicitly belong to. This node will maintain
16
# very few TCP connections on the network and perform almost no tasks other
17
# than to upload to other users. Users who do not have direct Internet
18
# connections will be forced into this class.
22
# Responsible for manging indexes of a large group of directly connected
23
# children (run-time modifier for the USER class), responding to and
24
# forwarding search requests from peers, as well as directing push requests
25
# so that indirectly connected users may still share files.
27
# Please note that this class will require a much greater amount of both
28
# local and network resources. If you select this, pay very close attention
29
# to the database environment settings several configuration options down.
30
# For reference, there are several fully functioning search nodes on
31
# "average" broadband connections, such as 768/128kbit (my node *sigh*).
33
# Keeping your node up-to-date is absolutely essential for this node class.
34
# Please check for regular updates and be sure that you are always running
39
# Meta node used in favor of user nodes when attempting new connections to
40
# the network. This node class is also responsible for managing statistics
41
# information for the virtual clusters created by SEARCH nodes. Reliability
42
# is the largest requirement here.
44
# If you're unsure it is highly recommended that you select 1 (the default).
45
# A setting of 7 will select both a SEARCH and INDEX node.
50
# Core listening port. OpenFT uses a compacted binary protocol for the core
51
# communication with other nodes. If this machine is unable to provide both
52
# port and http_port to the outside directly (blocked by either by a firewall
53
# or a NAT setup) you should select 0 here.
56
# If you are unable to route this port (along with the HTTP port) you will be
57
# unable to download from other users with that same inability. You will,
58
# however, maintain the ability to upload to other non-firewalled users.
59
# Selecting non-zero when the port is not available to the outside will cause
60
# very broken behaviour, namely search results will be extremely unreliable.
62
# Default: random (1215, 2215)
67
# HTTP server port. OpenFT's implementation also makes use of HTTP for all
68
# file transfers. See above for more details. Please provide a valid port
69
# here regardless of your firewall state.
71
# Default: random (2216, 3216)
76
# Arbitrary name you'd like to associate with your node. This field is
77
# optional and it is NOT to be trusted. The name is not unique to the
78
# network. Please do not choose useless aliases.
82
###############################################################################
83
# SEARCH NODE SETTINGS
88
# Maximum number of "active" nodes that are allowed connection at any given
89
# time. The default value (-1) is used to calculate a suitable value for
90
# most search nodes based on their current max child configuration and other
91
# parameters. If you wish to take on additional connections, please note
92
# that you must set your maximum file descriptor limit accordingly (provided
93
# that the internal setrlimit() call is unable to sufficiently increase your
94
# current limits). Consult your shell's manual regarding ulimits for more
99
###############################################################################
100
# SEARCH NODE SETTINGS
105
# Boolean setting determining whether or not to print token search queries
106
# through the main logging facility. This can become quite noisy and may
107
# inflate the size of the log file enormously.
111
# Maximum number of "child" nodes you are able to support. If you
112
# feel that you have adequate processing power and memory, you may
113
# increase this value until the load is no longer acceptable. Please
114
# be sure to read the max_active and env_cache settings in this section
115
# before you change the default value.
119
# Absolute path where the search database environment should be
120
# stored. Make sure to provide a path with plenty of disk space
121
# (~100-300MB) and on a device with fast access time. If your OS
122
# supports a swap-backed RAM disk (e.g. tmpfs on Linux), this would be
123
# an ideal use for it.
125
# NOTE: As always, this path is in UNIX format, so Windows users will
126
# need to hack around this accordingly. If you aren't sure what I
127
# mean by this, you need to go back and read giftd.conf documentation.
129
env_path = ~/.giFT/OpenFT/db
131
# Total cache size for the entire search database environment. Units
132
# are specified in bytes, and as such you will not be allowed to
133
# specify 1GB or higher. Specifications less than 500MB (and we
134
# expect you will specify less than that) are subject to a 20%
135
# inflation due to some libdb implementation detail.
137
# Cache size depends mostly on the maximum number of children: the
138
# table below contains some sane defaults as a rough guide (assuming
139
# an average of 250 files shared per child). Note that the files you
140
# are sharing are also stored in the db, so if you're sharing
141
# significantly more than 250 files you may need to take this into
142
# account. Memory usage is the approximate increase over the usage of
145
# Cache size Memory usage Children Files
146
# =================================================
147
# 23592960 30Mb 80 20000
148
# 31457280 40Mb 120 30000
149
# 41943040 50Mb 160 40000
150
# 52428800 60Mb 200 50000
151
# 62914560 75Mb 240 60000
152
# 78643200 90Mb 360 90000
154
# Setting cache size too high has no adverse effects other than
155
# excessive memory usage. Setting cache size too low will result in a
156
# lot of disk usage (with a resultant drop in performance). While not
157
# a perfectly reliable indicator, if the size (actual disk usage - it's
158
# sparse) of tokens.index in the db environment (see above) is larger
159
# than the cache size, the cache size is probably set too low.
161
# Also bear in mind that the daemon itself should never need to be
162
# swapped out; OS-level swapping will render giFT almost unusable.
166
###############################################################################
167
# LAN MODE FACILITIES
172
# OpenFT offers a special configuration for users who wish to operate a
173
# network from within a local area network (LAN). This mode causes giFT to
174
# reject authorization from any non-local address as well as advertising it's
175
# presence via the local UDP broadcast. If this switch is non-zero you will
176
# not be able to contact the main network.
181
# When LAN mode is enabled, this configuration switch is used to verify
182
# which hosts are allowed connection to the core OpenFT port. It is
183
# highly recommended that you just don't touch this, regardless of what
184
# lan_mode's value is.
187
# This switch provides a very crude loophole that could allow you to create
188
# a "private" OpenFT network between a list of known nodes. Using this
189
# "feature" is going to be quite cumbersome as it is intended to be used
190
# by developers only. You have been warned.