Iroffer Tutorial: Unterschied zwischen den Versionen

Aus Fansub-Wiki
Zur Navigation springen Zur Suche springen
Keine Bearbeitungszusammenfassung
Keine Bearbeitungszusammenfassung
Zeile 443: Zeile 443:
##                                    End                                  ##
##                                    End                                  ##
##############################################################################</pre>
##############################################################################</pre>
Anhand der Informationen der einzelnen Punkt kann nun die Konfiguration Punkt für Punkt abgearbeitet werden. Wichtig:
*pidfile
*server
*channel
*filesdir
*adminhost
*adminpass
Diese sind die wichtigen Optionen, die für eine Minimalconfig gesetzt werden sollten. Alles weitere kann später noch nachkonfigurert werden (wobei es alles in einem Schritt zu erledigen ist besser ;).
=== Dinoex Mod spezifische Zusätze ===
<pre>
##############################################################################
###                    - xdcc listing group only  -                      ###
### Sorgt dafür, das die XDCC-Liste nur noch mit den Gruppen und dem      ###
### Inhalt der Maingruppe exportiert wird.                                ###
#xdcclist_grouponly
##############################################################################
###                          - admin job file -                            ###
### Wenn diese Datei definiert ist, sucht Iroffer alle 10 sek nach ihr.    ###
### Sollte diese vorhanden sein, werden in ihr enthaltene Kommandos aus-  ###
### geführt, und eventuelle Rückgaben in die Datei                        ###
### <dateiname_der_jobdatei>.done geschrieben.                            ###
#admin_job_file mybot.job
### Zur "channel"-Option kommt ein möglicher Parameter hinzu.              ###
### Mit -headline kann für jeden Channel eine alternative XDCC List Über-  ###
### schrift gesetzt werden.                                                ###
##############################################################################
###                      - automatic dcc ip translation -                  ###
### Hole die externe IP vom Server und nutze sie für usenatip. In diesem  ###
### Fall kann usenatip auf einen Standartwert gesetzt werden.              ###
#getipfromserver
WIRD FORTGEFÜHRT... BITTE VORLÄUFIG NICHT ÄNDERN! VIELEN DANK!
TheDeath</pre>

Version vom 20. Dezember 2005, 05:53 Uhr

Iroffer ist eine weitverbreitete Software zum Anbieten von Dateien über sog. XDCC-Bots. Hier wird im folgenden auf die Vorbereitung, Installation und Konfiguration eines solchen XDCC-Bots eingegangen.

Was ist Iroffer ?

Iroffer ist eine Software die als sog. Fileserver (Dateiserver) im IRC agiert. Man kann es etwa mit einem Webserver oder einem FTP vergleichen, nur das hier nicht das HTTP- bzw FTP-Protokoll verwendet wird. Für den Transfer wird hier das DCC-Protokoll, welches ein Teil des IRC's ist benutzt. Im Gegensatz zu ähnlichen Programmen ist Iroffer kein Script, sondern ein eigenständiges ausführbares Programm. Es ist auf sehr hohe Leistungfähigkeit bei kleinem Systemresourcenverbraucht (CPU, RAM, HDD) ausgelegt. Iroffer ist für die Betriebsysteme Windows sowie Unix bzw. Linux erhältlich.

Was brauche ich für meinen Bot und wo bekomme ich es ?

Man benötigt einen Computer mit breitbandigem Anschluss (DSL sollte es mindestens sein), der über genügend Uploadbandbreite verfügt (>=16 kb/s) oder einen vServer/Rootserver. Auf diesem PC sollte ein *nix bzw. Windows laufen, sowie je nach Menge der zu sharenden Datei entsprechend Speicherplatz. Für Iroffer selbst kann man etwa 3 MB rechnen, der Rest sind nur die zu sharenden Dateien. Wenn dies alles vorhanden ist, brauchen wir noch die entsprechende Irofferversion für unser Betriebsystem.

Iroffer original:

Iroffer Dinoex Mod:

Die Dinoex Mod enthält verschiedene Modifikationen gegenüber dem originalen Iroffer, die wahrscheinlich am herrausrangenste ist die Möglichkeit, Dateigruppen anzulegen und damit die Datein auf dem Bot zu sortieren. Aber des ist nicht alles, wer es genau wissen möchte, kann sich die Readme durchlesen. Diese Mod ist neben der Originalversion die am häufigsten anzutreffende Modifikation in der deutschen Fansubscene.


Installation

Linux

Wenn wir die Sourcen heruntergeladen haben von der gewünschten Version, geht es weiter wie folgt:

  • Entpacken der Sourcen & wechseln ins neue Verzeichnis:
tar -xzvf <name der heruntergelandenen datei>
cd <name des entstandenen verzeichnisses> 
  • Starten des Konfigurationsscripts, welches uns eine make-Datei für unser System erstellt:
./Configure
  • Starten des Kompilationsprozesses, wenn keine Fehler beim durchlaufen des Konfigurationsscripts auftraten:
make
  • Wenn gewünscht, können wir nun die auführbare Datei systemweit verfügbar in /usr/local/bin installieren (optional und es werden hierfür root Previlegien benötigt):
make install
  • Wenn Iroffer nicht systemweit installiert wird, bitte die ausführbare Datei "iroffer" aus dem Sourcenverzeichnis zum gewünschten Ausführungsort verschieben.

Damit ist die Installation von Iroffer unter Linux abgeschlossen und wir können uns der Konfiguration unseres Bots zuwenden.

Windows

Wenn wir die Binary von der gewünschten Version heruntergeladen haben, gehen wir bei und entpacken mit einem Packer die .zip-Datei in ein Verzeichnis unserer Wahl auf der Festplatte. Damit ist unter Windows die Installation abgeschlossen, und wir können mit der Konfiguration des Bots fortfahren.

Konfigurieren von Iroffer

Allgemeine Konfiguration

So sieht die mit Iroffer Original 1.3 ausgelieferte Konfigurationsdatei aus, die einzigen Änderungen gegenüber dem Original sind die Übersetzungen der Beschreibungen der einzelnen Optionen:

##############################################################################
##                       iroffer 1.3.b09 config file                        ##
##            lines starting with "#" or are blank are ignored              ##
##############################################################################

# Version of this file:
#
# @(#) sample.config 1.114@(#)
# pmg@wellington.i202.centerclick.org|sample.config|20040823145918|21802
#

##############################################################################
##                                  FILES                                   ##
##############################################################################


##############################################################################
###                             - pid file -                               ###
### Schreibt die Prozess-ID beim Start in diese Datei                      ###
pidfile mybot.pid

##############################################################################
###                             - log file -                               ###
### logfile gibt die Logfile für den Bot vor. logstats sendet statistische ###
### Informationen an einen eventuell aktiven DCC-Chat. Mögliche Werte yes  ###
### (ja) und no (nein). logrotate gibt den Zeitraum vor, nach dem die Log- ###
### Datei gewechselt wird, mögliche Werte monthly (monatlich), weekly      ###
### (wöchentlich) und daily (täglich).                                     ###
logfile mybot.log
logstats yes
logrotate weekly

##############################################################################
###                             - state file -                             ###
### Diese Datei dient als temporäres Datenlager für statistische Daten     ###
### zwischen den Neustarts von Iroffer                                     ###
statefile mybot.state

##############################################################################
###                         - xdcc listing file -                          ###
###  In diese Datei wird ein vollständiges XDCC-Listing exportiert, umzb.  ###
###  als Packliste auf einer Webseite zu dienen, oder für andere Zwecke    ###
#xdcclistfile mybot.txt


##############################################################################
##                                   IRC                                    ##
##############################################################################

##############################################################################
###                          - connection method -                         ###
### Wie Iroffer sich zum IRC-Server verbinden soll, möglich ist:           ###
###  direct                     - verbindet direkt zum Server (normalfall) ###
###  bnc <ip> <port> <password> <vhost>                                    ###
###                             - verbindet zum IRC-Server über eine BNC   ###
###                               verbinden über <ip>:<port> unter         ###
###                               Verwendung von <password>                ###
###                               <vhost> ist optional                     ###
###  wingate <ip> <port>        - verbindet den Bot zum Server via einem   ###
###                               Wingate Gateway an <ip>:<port>           ###
###  custom <ip> <port>         - verbindet den Bot zum Server durch       ###
###                               anwendung benutzerdefiniert Kommandos    ###
###                               mehr dazu weiter unten bei proxyinfo     ###
### die meisten leute werden im Normalfall "direct" benutzen               ###
connectionmethod direct


##############################################################################
###                       - custom connection info -                       ###
### wenn "connectionmethod custom" verwendet wird, kann mittels proxyinfo  ###
### die nötige Befehlszeile für die Verbindung mit dem Proxy/Gateway/etc   ###
### angegeben werden, als Platzhalter für Server und Port sehen $s und $p  ###
### zur verfügung                                                          ###
#proxyinfo connect $s:$p
#proxyinfo blah blah


##############################################################################
###                         - onjoin information -                         ###
### Mittels server_join_raw, server_connected_raw und channel_join_raw     ###
### können RAW-IRC-Commands an den Server zu verschiedenen Zeitpunkten     ###
### während des Verbindungsaufbaus übergebene werden.                      ###
### server_join_raw wird ausgeführt wenn NICK, USER gesendet, vor MODE     ###
### server_connected wird ausgeführt wenn MODE gesendet, vor JOIN          ###
### channel_join_raw wird ausgeführt wenn ein channel gejoint wird         ###
### alle 3 Kommandos können mehrfach eingesetzt werden                     ###
#server_join_raw
#server_connected_raw
#channel_join_raw


##############################################################################
###                             - nickserv -                               ###
### Wenn der Nick gegen den NickServ registriert ist, kann hier das Pass-  ###
### wort eingetragen werden, damit er sich beim joinen des Server von      ###
### selbst identifiziert
#nickserv_pass <mein_botnickpassword>


##############################################################################
###                         - server information -                         ###
### Liste der Server und Ports im Aufbau: "server irc.domain.com 6667".    ###
### Die Angabe des Ports ist optional, Standart ist 6667.                  ###
### Mehrere Server können (und sollten) angegeben werden                   ###
server irc.efnet.net

##############################################################################
###                         - channels (upto 50) -                         ###
### Channelformat:                                                         ###
### "channel <channel> [-plist <time>] [-plistoffset <time>]               ###
###    [-pformat <full|minimal|summary>] [-key <key>] "                    ###
### plist: Zeit (min) zwischen den einzelnen Announcen                     ###
### plistoffset: Zeit (min) um die die Announce versetzt wird              ###
### pformat: full zeigt alle Packs auf dem Bot und stellt den Standart     ###
###          minimal stellt eine kleine Announce zusammen (ca. 5 zeilen)   ###
###          summary zeigt eine 2-Zeilen-Zusammenfassung an                ###
### key:     für Channels die den Modus +k (Key) haben, definiert das      ###
###          nötige Passwort für das Joinen des Channel                    ###
#channel #chan01
#channel #chan02 -plist 14
#channel #chan03 -plist 28 -pformat minimal
#channel #chan04 -plist 14 -pformat summary -key thekey


##############################################################################
###                          - user information -                          ###
### user_nick definert den Nicknamen des Bots                              ###
### user_realname definiert den text, den man mit /whois abfragen kann     ###
### user_modes definiert die Modi, die für den User gesetzt werden solln   ###
user_nick mybotDCC
user_realname My Bot
user_modes +i


##############################################################################
###                            - virtual hosts -                           ###
### Wenn der Computer/Server mehr als eine lokale IP-Adresse hat kann,     ###
### mit local_vhost <ip> angegeben werden, welche genutzt werden soll.     ###
### Wenn Iroffer selbst wählen soll, einfach Option deaktivert belassen.   ###
### Wichtig, es muss eine IP angegeben werden, kein Domainname!!!          ###
#local_vhost 123.456.789.123

##############################################################################
###                      - incoming TCP connections -                      ###
### Wenn Iroffer hinter einer Firewall gestartet werden soll, und die mög- ###
### lichkeit besteht, Ports zu öffnen bzw zu forwarden, kann mittels       ###
### tcprangestart der erste Port des Bereiches für Iroffer angegeben       ###
### werden. Die Menge nötiger Ports entspricht der maximalen Zahl Send-    ###
### slots. Wenn nichts defniert ist, wählt das OS selbstständig die Ports  ###
### für eintreffende TCP-Verbindungen.                                     ###
#tcprangestart 4000

##############################################################################
###                       - override unix loginname -                      ###
### Überschreibt den Unixlogin in der Ident, funktioniert nur ohne OIdent. ###
#loginname fakelogin


##############################################################################
###                      - manual dcc ip translation -                     ###
### if you are behind a NAT (Network Address Translation) device which     ###
### _does_ _not_ intercept and translate dcc commands but _does_ do port   ###
### forwarding place the ip address of the NAT below if unsure, leave      ###
### commented                                                              ###
### NOTE:  You must use the IP address in x.x.x.x format not a DNS name.   ###
#usenatip 123.456.789.123


##############################################################################
##                                   xdcc                                   ##
##############################################################################

##############################################################################
###                         - maximum xdcc slots -                         ###
### Menge gleichzeitiger Dateiübertragungsverbindungen.                    ###
slotsmax 20

##############################################################################
###                         - Queue Information -                          ###
### Grösse der Warteschlange, 0 bedeutet keine Warteschlange.              ###
queuesize 10

##############################################################################
###                      - max transfers per person -                      ###
### maximale Anzahl gleichzeitiger Übertragungen pro Person                ###
maxtransfersperperson 1

##############################################################################
###                     - max queued items per person -                    ###
### Maximale Anzahl gleichzeitiger Warteschlangeneinträge                  ###
maxqueueditemsperperson 2

##############################################################################
###                 - add/chfile command helper directory -                ###
### Hier kann ein optionales Dateiverzeichnis angegeben werden, wo Iroffer ###
### nach Dateien sucht, die mittels add/chfile hinzugefügt werden.         ###
### Standartmässig sucht Iroffer im Verzeichnis in dem es ausgeführt wird. ###
#filedir /home/me/files
#c:\iroffer\files

##############################################################################
###                  - restrict xdcc list and xdcc send -                  ###
### Wenn restrictlist gesetzt wird, kann xdcc list und xdcc info nur von   ###
### jemanden ausgeführt werden, der sich auch im channel befindet.         ###
### Wenn restrictprivlist gesetzt wird, kann der bot nicht mehr via xdcc   ###
### list gelistet werden, und gibt, falls es jemand versucht, die mit      ###
### restrictprivlistmsg gesetzte Mitteilung aus.                           ###
### restrictsend bedeutet das nur wer im Channel ist, Dateien vom Bot      ###
### empfangen kann, sobald er ihn verlässt, wird der Send abgebrochen.     ###
#restrictlist
#restrictprivlist
#restrictprivlistmsg Wait for public list in the channel.
#restrictsend

##############################################################################
###                      - channel xdcc commands -                         ###
### wenn respondtochannelxdcc gesetzt ist, reagiert der Bot auf Kommandos  ###
### die in den Channel gepostet werden.
respondtochannelxdcc

##############################################################################
###                      - channel !list command -                         ###
### wenn respondtochannellist gesetzt wird, reagiert der bot auf !list     ###
#respondtochannellist

##############################################################################
###                   - bypass queue for small files -                     ###
### Wenn jemand eine Datei anfordert, die kleiner oder gleich dem          ###
### definierten Wert (in KB) entspricht, wird diese unabhänig von der      ###
### Slotseinstellung gesendet.
#smallfilebypass 0

##############################################################################
###                      - authorized download hosts -                     ###
### Hiermit kann eingeschränkt werden, wer vom Bot downloaden darf. Ange-  ###
### geben werden Hostmasken. Um allen den Download zu erlauben, einfach    ###
### *!*@* als Hostmask einsetzen.                                          ###
### Jokerzeichen sind:                                                     ###
###  * = 0 oder mehr Zeichen,  ? = 1 Zeichen,  # = jede positive Zahl      ###
#downloadhost *!~me@*.domain.com
#downloadhost *!me@192.168.10.#
downloadhost *!*@*

##############################################################################
##                               Network Usage                              ##
##############################################################################

##############################################################################
###                      - Allow with low bandwidth -                      ###
### Wenn Packete in der Warteschlange sind, und der Verbrauch der Band-    ###
### breite den vorgegebenen Wert unterschreitet, wird ein zusätzlicher     ###
### Send gestartet für einen Nutzer aus der Warteschlange.                 ###
### Achtung, Wert nicht unsinnig niedrig oder hochsetzten!
#lowbdwth 15

##############################################################################
###                         - transfer min speed -                         ###
### Mindestgeschwindigkeit beim Downloaden, sonst wird der Download abge-  ###
### brochen.                                                               ###
#transferminspeed 10

##############################################################################
###                         - transfer max speed -                         ###
### Maximalgeschwindigtkeit beim Downloaden, sonst wird künstlich gebremst ###
#transfermaxspeed 50

##############################################################################
###                        - bandwidth limiting -                          ###
### Is your sysadmin complaining about you using up too much bandwidth?    ###
### You can set a maximum KB/sec that will be sent to the network.         ###
### You can define two different limits depending on time of day,          ###
### overallmaxspeed is the general limit, overallmaxspeeddayspeed is the   ###
### limit during the hours defined by overallmaxspeeddaytime (0 ... 23)    ###
### (no looping) and durring days of week ( MTWRFSU )                      ###
#overallmaxspeed 300
#overallmaxspeeddayspeed 100
#overallmaxspeeddaytime 9 17
#overallmaxspeeddaydays MTWRF


##############################################################################
##                                   Other                                  ##
##############################################################################

##############################################################################
###                          - autosend feature -                          ###
### Wenn autosendpack gesetzt wird, schickt bei der Bot sobald ein         ###
### Schlüsselwort im Channel aufkommt, das definierte Pack an die Person.  ###
###           === DIE MEISTEN WERDEN DIES NICHT BENÖTIGEN! ===             ###
###         === HOLT EUCH ERST VOM CHANNEL OP DIE ERLAUBNIS! ===           ###
#autosendpack <packnr> <schlüsselwort> <mitteilung>
#autosendpack 1 !rules Sending you the rules.

##############################################################################
###                             - headline -                               ###
### Überschrift für alle XDCC-Lists                                        ###
#headline New Stuff Just Added!!

##############################################################################
###                           - credit line -                              ###
### Fussnote für alle XDCC-Lists                                           ###
#creditline Brought to you by me

##############################################################################
###                         - index bot notify -                           ###
### Wenn iroffer periodisch jemanden eine Mitteilung schicken soll für     ###
### Indizierungszwecke oder anderen bedarf, kann perdidocmsg verwendet     ###
### werden:                                                                ###
### "periodicmsg <nick> <zeit in min> <mitteilung>
#periodicmsg nick 10 index me

##############################################################################
###                        - remote admin info -                           ###
### Die Admincommands können nur von jemanden ausgeführt werden, dessen    ###
### hostmaske auf die Vorgabe passt, und der das nötige Kennwort kennt.    ###
### Diese Kommandos kännen endweder via DCC-Chat oder aber via             ###
### /msg <botnick> admin <adminpass> <kommando> ausgeführt werden.         ###
### adminhost benötigt eine komplette hostmask im aufbau nick!ident@host   ###
### Falls kein identd benutzt wird, nicht vergessen ein "~" hinzuzufügen.  ###
### Jokerzeichen sind:                                                     ###
###  * = 0 oder mehr Zeichen,  ? = 1 Zeichen,  # = jede positive Zahl      ###
### Aus Sicherheitsgründen wird das Adminpasswort verschlüsselt in der     ###
### Konfigurationsdatei hinterlegt. Um ein Password zu generieren, bitte   ###
### Iroffer mit Option "-c" ausführen und den Instruktionen folgen.        ###
adminpass add_your_encrypted_password_here
adminhost *!~me@*.domain.com
adminhost *!me@192.168.10.#

##############################################################################
###                          - upload directory -                          ###
### Soll der Bot DCC-Uploads akzeptieren, müssen hier die Uploadhosts,     ###
### ein Uploadverzeichnis und die maximale Grösse in MB für einen Upload   ###
### definiert werden (0 entspricht keinem Limit bei der Uploadgrösse).     ###
### Jokerzeichen sind:                                                     ###
###  * = 0 oder mehr Zeichen,  ? = 1 Zeichen,  # = jede positive Zahl      ###
### ACHTUNG!! Für das Uploaden sollte ein eigenes Verzeichnis angelegt     ###
### ACHTUNG!! werden, um überschreiben bzw. erweitern wichtiger Dateien zu ###
### ACHTUNG!! verhindern, bzw Missbrauch und Explolits nicht zu ermöglichen###
#uploadhost *!~me@*.domain.com
#uploadhost *!me@192.168.10.#
#uploaddir /home/me/upload
#uploaddir c:\iroffer\upload
#uploadmaxsize 10

##############################################################################
###                          - hide OS information-                        ###
### Wenn Iroffer in den Versionsangaben und in seine Quitmitteilung nicht  ###
### das Betriebsystem nennen soll, dann bitte diese Option anstellen.      ###
#hideos

##############################################################################
###                              - log notices -                           ###
### Wenn aktiviert, zeichnet Iroffer alle Notices im Nachichtenspeicher auf###
#lognotices

##############################################################################
###                           - timestamp console -                        ###
### Wenn definiert, setzt Iroffer eine Zeitmarke in der Konsole            ###
#timestampconsole

##############################################################################
###                           - timestamp console -                        ###
### Wenn definiert, unterdrückt Iroffer die meisten Info meldungen         ###
#quietmode

##############################################################################
###                       - periodic notify time -                         ###
### Legt fest, wie regelmässig Iroffer Nutzer über aktuelle Platzierung in ###
### der Warteschlange informiert bzw über die verbrauchte Bandbreite.      ###
### Standart ist 5 min, um es vollständig zu deaktiveren, setzt man es auf ###
### 0.
#notifytime 5

##############################################################################
###                         - punish slow users -                          ###
### Wenn ein Nutzer unter den Minimaldownloadspeed fällt, wird er bestraft ###
### indem alle Sends abgebrochen und er aus der Warteschlange entfernt.    ###
### durch diese Option kann er noch zusätzliche um die definierte Zeit (in ###
### min) vom Bot ignoriert werden.
#punishslowusers 10

##############################################################################
###                      - disable md5sum of files -                       ###
### Standartmässig berechnet Iroffer für alle angebotenen Dateien die MD5- ###
### Prüfsumme. Zum Abstellen von diesem, diese Option setzen.
#nomd5sum

##############################################################################
##                                    End                                   ##
##############################################################################

Anhand der Informationen der einzelnen Punkt kann nun die Konfiguration Punkt für Punkt abgearbeitet werden. Wichtig:

  • pidfile
  • server
  • channel
  • filesdir
  • adminhost
  • adminpass

Diese sind die wichtigen Optionen, die für eine Minimalconfig gesetzt werden sollten. Alles weitere kann später noch nachkonfigurert werden (wobei es alles in einem Schritt zu erledigen ist besser ;).

Dinoex Mod spezifische Zusätze

##############################################################################
###                     - xdcc listing group only  -                       ###
### Sorgt dafür, das die XDCC-Liste nur noch mit den Gruppen und dem       ###
### Inhalt der Maingruppe exportiert wird.                                 ###
#xdcclist_grouponly

##############################################################################
###                          - admin job file -                            ###
### Wenn diese Datei definiert ist, sucht Iroffer alle 10 sek nach ihr.    ###
### Sollte diese vorhanden sein, werden in ihr enthaltene Kommandos aus-   ###
### geführt, und eventuelle Rückgaben in die Datei                         ###
### <dateiname_der_jobdatei>.done geschrieben.                             ###
#admin_job_file mybot.job

### Zur "channel"-Option kommt ein möglicher Parameter hinzu.              ###
### Mit -headline kann für jeden Channel eine alternative XDCC List Über-  ###
### schrift gesetzt werden.                                                ###

##############################################################################
###                      - automatic dcc ip translation -                  ###
### Hole die externe IP vom Server und nutze sie für usenatip. In diesem   ###
### Fall kann usenatip auf einen Standartwert gesetzt werden.              ###
#getipfromserver


WIRD FORTGEFÜHRT... BITTE VORLÄUFIG NICHT ÄNDERN! VIELEN DANK!

TheDeath