Requirements 
 License 

 Installation 
 IRC usage 
 Server connects 
 DCC sends 
 Logging 

 Format 
 Reference 
 Example 

 Roadmap 
 Download 
 Config parser 
 Visions & ideas 

Example configuration file

#
# $Id: config_example.html 115 2006-08-09 17:32:09Z pief $
#
# MetalServe sample configuration file
#
# Please see metalserve.conf(5) for explanations.
#

# LOGGING SETTINGS

# Filename for logfile
logfile /var/log/metalserve.log

# Log verbosity level (critical, error, warning, notice, info or debug)
loglevel notice

# FILES / LIST GENERATION

# Server root
serverroot /space/music

# Filetypes to include
include_extensions .mp3 .mpg .avi .wmv .asf .rm .mov

# Optional auxiliary list header to be included
list_header /var/lib/metalserve/header.txt

# Generate directory overview?
dir_overview on

# List compression command (%a: archive filename w/ ext, %l: list filename)
compress_command zip -9 -l "%a" "%l"

# IRC-PRESENCE SETTINGS

# Nickname (and alternatives) to use on the IRC network(s)
nickname MyNick MyNick2

# Real name to use on the IRC network
realname "John Doe"

# Usually an EMail address is supplied here
email_address my@email.com

# Default settings for channels
channel default
{
	# Delay between server advertisements
	advertise_delay 900
	
	# React to @find and @locator commands
	find_trigger on
}

# Default properties for servers
server default
{
	# Continous port range the server is listening on
	ports 6660-6669
	
	# Priority within IRC network (higher = better)
	priority 0

	# No password
	password ""
}

# Undernet (excerpt)
network Undernet
{
	channel #heavy
	{
		# Reduced delay for heavily-visited channel
		advertise_delay 600
		
		# Make sure we join this channel
		priority 3
	}

	channel #alsogood
	{
		# We want this one as well
		priority 2
	}

	channel #metoo
	{
		# We serve Metal, so we want Metal, right?
		priority 1
	}

	channel #join

	server geneva.ch.eu.undernet.org
	{
		ports 6661-6669
		priority 1
	}
	server graz.at.eu.undernet.org
	server flanders.be.eu.undernet.org
	server brussels.be.eu.undernet.org
	server caen.fr.eu.undernet.org
	server paris.fr.eu.undernet.org
	{
		ports 6662-6668
	}
	server diemen.nl.eu.undernet.org
	server haarlem.nl.eu.undernet.org
	server oslo.no.eu.undernet.org
	server stockholm.se.eu.undernet.org
	server surrey.uk.eu.undernet.org
	server sandiego.ca.us.undernet.org
	{
		ports 6660-6670
		priority -1
	}
	server washington.dc.us.undernet.org
	{
		priority -1
	}
	server arlington.va.us.undernet.org
	{
		priority -1
	}
}

# EFNet (excerpt)
network EFNet
{
	channel #musicunlimited
	{
		# Reduced delay for heavily-visited channel
		advertise_delay 600
	}

	server irc.homelien.no
	{
		ports 6666
		priority 0
	}
	server efnet.vuurwerk.nl
	{
		ports 6667
		priority 1
	}
}

# HardNet (single known server)
network HardNet
{
	channel #goshmp3
	channel #mp3speed

	server hardnet1.hardrock-metal.org
	{
		ports 6667
	}
}

# Timeout in seconds for connect() to IRC servers
server_connect_timeout 30

# Timeout in seconds for established IRC server connections
server_timeout 300

# Period in seconds a user may be missing from a channel (eg. netsplit)
part_timeout 120

# After part_timeout, try to finish ongoing DCC sends? (instead of cancel)
part_finishdccs on

# Resolve IP address of connecting users to hostnames?
client_lookups on

# Users to be ignored
ignored_users DumbAss

# MESSAGE/FLOOD PROTECTION SETTINGS

# Delay in milliseconds after a newline (to prevent flood detection)
message_linedelay 100

# Maximum number of results sent in response to @find/@locator queries
max_find_results 10

# DCC SETTINGS

# Port range to use for DCC sends
dcc_ports 1024-1100

# Timeout for DCC sends in seconds
dcc_timeout 120

# Maximum number of parallel DCC sends (except lists) / Slots
dcc_maxxfers 2

# Maximum queue length for DCC sends (except lists)
dcc_maxqueue 30

# Maximum number of parallel DCC sends (except lists) per user
dcc_maxuserxfers 1

# Maximum queue length for DCC sends (except lists) per user
dcc_maxuserqueue 3

# Maximum number of parallel DCC sends of file list
dcc_maxlistxfers 2

# Maximum queue length for DCC sends of file list
dcc_maxlistqueue 20

# Minimum CPS required for DCC sends
dcc_mincps 500

# Files larger than the specified threshold (in KBytes) are considered
# large files and have a seperate minimum CPS limit
dcc_largefiles_threshold 10240
dcc_largefiles_mincps 1000