albino
/
ngircd-tor
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Updated documentation.

This commit is contained in:
Alexander Barton 2003-03-10 00:23:34 +00:00
parent b6999f10c0
commit 10bb43c66e
2 changed files with 65 additions and 63 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
INSTALL
View File

@ -118,15 +118,18 @@ In the sample configuration file, there are comments beginning with "#" OR
";" -- this is only for the better understanding of the file. ";" -- this is only for the better understanding of the file.
The file is separated in four blocks: [Global], [Operator], [Server], and The file is separated in four blocks: [Global], [Operator], [Server], and
[Channel]. In the [Global] part, there is the main configuration, like the [Channel].
server-name and the ports, on which the server should be listening. In the
[Operator] section, the server-operators are defined and [Server] is the In the [Global] section, there is the main configuration like the server
section, where the server-links are configured. Use [Channel] blocks to name and the ports, on which the server should be listening. IRC operators
of this server are defined in [Operator] blocks. [Server] is the section
where server links are configured. And [Channel] blocks are used to
configure pre-defined ("persistent") IRC channels. configure pre-defined ("persistent") IRC channels.
The meaning of the variables in the configuration file is explained in the The meaning of the variables in the configuration file is explained in the
"doc/sample-ngircd.conf", which is used as sample configuration file in "doc/sample-ngircd.conf", which is used as sample configuration file in
/usr/local/etc after running "make install" (if you don't already have one). /usr/local/etc after running "make install" (if you don't already have one)
and in the "ngircd.conf" manual page.
IV. Command line options IV. Command line options
@ -154,4 +157,4 @@ number. In both cases the server exits after the output.
-- --
$Id: INSTALL,v 1.13 2003/03/09 22:03:58 alex Exp $ $Id: INSTALL,v 1.14 2003/03/10 00:23:34 alex Exp $

113
doc/sample-ngircd.conf
View File

@ -1,8 +1,8 @@
# $Id: sample-ngircd.conf,v 1.19 2003/03/09 22:03:58 alex Exp $ # $Id: sample-ngircd.conf,v 1.20 2003/03/10 00:23:34 alex Exp $
# #
# This is a sample configuration for the ngIRCd, which must adept to the # This is a sample configuration file for the ngIRCd, which must adept to
# local preferences and needs. # the local preferences and needs.
# #
# Comments are started with "#" or ";". # Comments are started with "#" or ";".
# #
@ -12,56 +12,56 @@
[Global] [Global]
# In the [global] section of this file, there is the place of the # The [Global] section of this file is used to define the main
# main server configuration. Needed is only the variable "Name", # configuration of the server, like the server name and the ports
# Info you can adjust, if you like to. For all the others variables, # on which the server should be listening.
# you can use the defaults, this means you can leave it by default.
# Server name in the IRC-network # Server name in the IRC-network
Name = irc.the.net Name = irc.the.net
# Info-text of the server. This will be shown i.e. by a WHOIS- or # Info text of the server. This will be shown by WHOIS and
# LINKS-request. # LINKS requests for example.
Info = Server Info Text Info = Server Info Text
# Information about the server and administrator in the ADMIN-request # Information about the server and the administrator, used by the
# ADMIN command.
;AdminInfo1 = Description ;AdminInfo1 = Description
;AdminInfo2 = Location ;AdminInfo2 = Location
;AdminEMail = admin@irc.server ;AdminEMail = admin@irc.server
# Ports, on which the server will listen. There may be more than # Ports on which the server should listen. There may be more than
# one port, separated with ";". (Default: 6667) # one port, separated with ";". (Default: 6667)
;Ports = 6667, 6668, 66694 ;Ports = 6667, 6668, 66694
# Text file with the "message of the day" (MOTD). This will be shown # Text file with the "message of the day" (MOTD). This message will
# on a user connection with the server. # be shown to all users connecting to the server:
;MotdFile = /usr/local/etc/ngircd.motd ;MotdFile = /usr/local/etc/ngircd.motd
# User-ID, under which the server is started (for that the server # User ID under which the server should run; you can use the name
# must be started with root-rights). You can use the name of the # of the user or the numerical ID. ATTENTION: For this to work the
# user or the numerical ID. # server must have been started with root privileges! In addition,
# ATTENTION: the configuration and the MOTD file must be readable # the configuration and MOTD files must be readable by this user,
# by this user, otherwise RESTART won't work! # otherwise RESTART and REHASH won't work!
;ServerUID = 65534 ;ServerUID = 65534
# Group-ID, under which the server is running (for that the server # Group ID under which the ngircd should run; you can use the name
# must be started with root-rights). You can use the name of the # of the group or the numerical ID. ATTENTION: For this to work the
# group or the numerical ID. # server must have been started with root privileges!
;ServerGID = 65534 ;ServerGID = 65534
# After <PingTimeout> seconds, the server will send a ping after # After <PingTimeout> seconds of inactivity the server will send a
# inactivity of this client. # PING to the peer to test whether it is alive or not.
;PingTimeout = 120 ;PingTimeout = 120
# If there is an answer of a client, to which the ping was sent, # If a client fails to answer a PING with a PONG within <PongTimeout>
# not after <PongTimeout> seconds, it will be disconnected. # seconds, it will be disconnected by the server.
;PongTimeout = 20 ;PongTimeout = 20
# The server tries every <ConnectRetry> seconds, not yet connected # The server tries every <ConnectRetry> seconds to establish a link
# or not anymore connected servers to connect. # to not yet (or no longer) connected servers.
;ConnectRetry = 60 ;ConnectRetry = 60
# Should IRC-operators be allowed to use the MODE command even if # Should IRC Operators be allowed to use the MODE command even if
# they are not(!) channel-operators? # they are not(!) channel-operators?
;OperCanUseMode = no ;OperCanUseMode = no
@ -73,39 +73,37 @@
;MaxJoins = 10 ;MaxJoins = 10
[Operator] [Operator]
# In this [operator]-section, there will be the configuration of # [Operator] sections are used to define IRC Operators. There may be
# the name and password of an IRC operator. There may be more than # more than one [Operator] block, one for each local operator.
# one operator-block (for each operator one).
# ID of the operator (may be different of the nick) # ID of the operator (may be different of the nick name)
;Name = TheOper ;Name = TheOper
# Password of the operator # Password of the IRC operator
;Password = ThePwd ;Password = ThePwd
[Server] [Server]
# In this [Server] section, there is the configuration of the # Other servers are configured in [Server] sections. If you
# servers, which are allowed to connect to your own server. # configure a port for the connection, then this ngircd tries to
# There may be more than one server-block. # connect to to the other server on the given port; if not it waits
# If you configured a port for the connection, then the ngIRCd # for the other server to connect.
# tries to connect to this port. If not, it waits for the other # There may be more than one server block.
# server.
# #
# Server-groups: # Server Groups:
# The ngIRCd allows "server-groups": that means, that you can assign # The ngIRCd allows "server groups": You can assign an "ID" to every
# server-groups for every server, to which you want the ngIRCd to # server with which you want this ngIRCd to link. If a server of a
# connect to. If one server of a server-group won't answer, the # group won't answer, the ngIRCd tries to connect to the next server
# ngIRCd tries the next one of this group. # in the given group. But the ngircd never tries to connect to two
# ATTENTION: Server-groups will only work if you defined a port! # servers with the same group ID.
# IRC-name of the server # IRC name of the server
;Name = irc2.the.net ;Name = irc2.the.net
# Hostname of the server # Internet host name of the peer
;Host = connect-to-host.the.net ;Host = connect-to-host.the.net
# Port of the server, to which the ngIRCd should connect. If you # Port of the server to which the ngIRCd should connect. If you
# assign no port, the ngIRCd waits for an answer of that server. # assign no port the ngIRCd waits for incoming connections.
;Port = 6666 ;Port = 6666
# Own password for the connection. This password has to be configured # Own password for the connection. This password has to be configured
@ -116,23 +114,24 @@
# configured as "MyPassword" on the other server. # configured as "MyPassword" on the other server.
;PeerPassword = PeerSecret ;PeerPassword = PeerSecret
# Group of that server (optional) # Group of this server (optional)
;Group = 123 ;Group = 123
[Channel] [Channel]
# In the [Channel] there can be defined "persistent channels". This # Pre-defined channels can be configured in [Channel] sections.
# means, that the server creates the channel and even if all users # Such channels are created by the server when starting up and even
# left this channel, it will persist. There may be more than one # persist when there are no more members left.
# block. Signed with the mode "P", which can be set or unset, like # Persistent channels are marked with the mode 'P', which can be set
# normal modes. # and unset by IRC operators like other modes on the fly.
# There may be more than one [Channel] block.
# Name of the channel # Name of the channel
;Name = #TheName ;Name = #TheName
# Topic for the channel # Topic for this channel
;Topic = a great topic ;Topic = a great topic
# Channel-modes # Initial channel modes
;Modes = tn ;Modes = tn
# -eof- # -eof-