Versione 0.1 - 30/08/2004 -

INTRODUZIONE

Questa guida spiega come installare il f-serve OBSIDIAN sul programma di chat XChat su sistemi Linux-based. Se non avete ancora XChat, lo potete scaricare dal sito ufficiale http://www.xchat.org (seguite le istruzioni nel sito per l'installazione). Esistono anche versioni per MAC OS X di XChat (consultate la sezione 'Downloads' di www.xchat.org) e ho accertato che l'OBSIDIAN funziona anche con XChat-Aqua, tuttavia la procedura di installazione potrebbe variare leggermente.

SCARICAMENTO ED INSTALLAZIONE DELLO SCRIPT OBSIDIAN

La pagina web dove potete scaricare OBSIDIAN è http://homepages.hrz.tu-darmstadt.de/~awerth/obsidian/
Se avete una versione di XChat superiore o uguale alla 2.0.0, scaricate la versione di sviluppo (Obsidian 0.9.2-pre1, al momento in cui questa guida viene redatta).
Salvate il file in una cartella qualsiasi.
Aprite poi un terminale, recatevi nella cartella dove avete salvato il tar.gz che avete appena scaricato e digitate tar xzvf nome_file_scaricato.tar.gz (ad esempio se avete scaricato obsidian-0.9.2-pre2.tar.gz, digitate tar xzvf obsidian-0.9.2-pre2.tar.gz) e date Invio.
Assicuratevi ora che XChat non sia lanciato.
Entrate nella cartella che è stata creata col comando precedente col comando cd nome_cartella (ad es. cd obsidian-0.9.2 ) e copiate il file presente nella cartella .xchat2 della vostra home:

Ora siete pronti per aprire XChat!
Lanciate il programma e vi troverete davanti alla finestra per il collegamento al server.

Inserite il vostro nick principale e i nick secondari nelle caselle Nick Names, selezionate AzzurraNET in Networks.
In 'Join Channels' potete inserire #startrekitalia (così appena la connessione col server andrà a buon fine, entrerete automaticamente nel canale #startrekitalia).
In 'Connect Command' potete, ad esempio, inserire il comando per l'identificazione, se avete registrato il vostro nick (se la password è pippo, inserite ns identify pippo).
Ora cliccate su 'Connect'.

In alto dovreste vedere alcuni messaggi di obsidian, che testimoniamo che l'installazione è andata buon fine.

Ora attendete che si colleghi e poi procedemo alla configurazione di OBSIDIAN.

CONFIGURAZIONE DI OBSIDIAN

Nello spazio che si usa per digitare i vostri messaggi per la chat, digitate '/fs toggle'. Vi apparirà la seguente maschera:

[Obsidian FServe] Switch Current Value
[Obsidian FServe] ======== =============
[Obsidian FServe] debug 0
[Obsidian FServe] autoon 0
[Obsidian FServe] restorequeues 1
[Obsidian FServe] notice_as_msg 0
[Obsidian FServe] short_notice 0
[Obsidian FServe] ctcptrigger 1
[Obsidian FServe] raw_chnl_msg 1
[Obsidian FServe] raw_wlcm_msg 0
[Obsidian FServe] open_tab_early 1
[Obsidian FServe] close_tab_auto 0
[Obsidian FServe] case_cmd 0
[Obsidian FServe] case_file 0
[Obsidian FServe] fs_sensitive 0
[Obsidian FServe] priority_op 1
[Obsidian FServe] priority_voice 1
[Obsidian FServe] count_sends 1
[Obsidian FServe] send_small_now 1
[Obsidian FServe] ads_when_full 0

'0' sta per OFF e '1' sta per ON. Per settare questi switch digitate '/fs toggle nome_switch valore' (ad esempio se volete attivare lo switch 'debug' digitate '/fs toggle debug 0').
Se l'operazione è andata a buon fine, Obsidian confermerà con una stringa del genere
[Obsidian FServe] Setting 'debug' to '0'

Passiamo velocemente in rassegna cosa significano i vari switch.
- DEBUG: Se attivato, vedrete molte più scritte a video generate dall'Obsidian. Verrà inoltre creato nella directory .xchat2 un file chiamato 'obsidian.debug'. Tutto ciò serve sopratutto agli sviluppatore per risolvere i problemi. (Posizione raccomandata 0)
- AUTOON: Se attivato, il file server si attiverà in modo automatico appena effettuato il collegamento col server e dopo ogni cambiamento. (Posizione raccomandata 1)
- RESTOREQUEUES: Se attivato, salva automaticamente le code quando l'fserve viene chiuso e le carica quando l'fserve viene riattivato. (Posizione raccomandata 1)
- NOTICE_AS_MSG: Se attivo, la pubblicità del vostro server viene spedita tramite messaggi. Così pubblicizzerete il vostro server in qualsiasi finestre dove potete chattare. (Posizione raccomandata 0)
- SHORT_NOTICE: Se attivo, invia solo avvisi brevi. (Posizione raccomandata 0)
- CTCPTRIGGER: Se attivo, il triggere viene visualizzato come /ctcp vostro_nick trigger. (Posizione raccomandata 1)
- RAW_CHNL_MSG: Se disattivato, manda pubblicità in query agli utenti del chan. (Posizione raccomandata 1)
- RAW_WLCM_MSG: Manda il mesaggi di benvenuto tramite mesaggio privato invece che DCC Chat. Questo può far sì che voi veniate meno disturbati (meno finestre aperte), ma causa un maggiore intasamente del server IRC e potrebbe essere considerato flooding. (Posizione raccmandata 0)
- OPEN_TAB_EARLY: Obsidian gestisce l'apertura di nuove finestre. In questo modo i mesaggi di benvenuto non si visualizzando nel vostro schermo, disturbandovi meno. In un certo qual modo, qusto switch rende obsoleto raw_wlcm_msg. (Posizione raccomandata 1).
- CLOSE_TAB_AUTO: Funzione SPERIMENTALE, ancora non ben funzionate. Potrebbe causare crash di XChat. (Posizione raccomanda 0, per ulteriori info digitate '/fs help close_tab_auto').
- CASE_CMD: Se attivo, i comandi digitati saranno case sensitive (ovvero Dir non viene accettato). (Posizione Raccomandata 0).
- CASE_FILE: Se attivo, il file server considererà i file come case sensitive (ad es. star_trek.avi e Star_Trek.avi saranno due file diversi) (Posizione raccomandata 0).
- FS_SENSITIVE: Se attivo mostra un messaggio che il file server è case sensitive (Posizione raccomandata 0, se case_cmd e case_file sono 0)
- PRIORITY_OP: Se attivo, gli OP (+o) avranno la priorità negli accodamenti dei file. (Posizione raccomandata 1)
- PRIORITY_VOICE: Se attivo, i VOICE (+v) avranno la priorità negli accodamenti dei file. (Posizione raccomandata 1)
- COUNT_SENDS: Nel conteggio dei files in coda, i sends vengoino contati anche come file accodati. (Posizione raccomandata 1)
- SENDS_SMALL_NOW: Manda i file piccoli direttamente, senza accodarli (Posizione raccomandata 1)
- ADS_WHEN_FULL: Manda pubblicità del vostro server anche quando è pieno (Posizione raccomandata 0)

Configuratati gli switch, per sicurezza salvate le modifiche col comando /fs save e procediamo con le ultime configurazioni.

Digitate '/fs vars' per fare comparire la lista delle variabili. Comparirà:

[Obsidian FServe] Variable Current Value
[Obsidian FServe] ======== =============
[Obsidian FServe] max_users 1
[Obsidian FServe] max_sends 1
[Obsidian FServe] max_queues 5
[Obsidian FServe] slots_big 1
[Obsidian FServe] slots_med 4
[Obsidian FServe] slots_small 10
[Obsidian FServe] size_big 30000000
[Obsidian FServe] size_med 1000000
[Obsidian FServe] idle_time 180
[Obsidian FServe] max_fails 5
[Obsidian FServe] min_speed 1000
[Obsidian FServe] auto_backup 0
[Obsidian FServe] trigger !vitto84
[Obsidian FServe] serve_no_notify #startrekitalia
[Obsidian FServe] serve_hidden #testchnl3
[Obsidian FServe] notify_to_voice #testchnl2
[Obsidian FServe] notify_channels #testchnl
[Obsidian FServe] notify_timeout 0
[Obsidian FServe] root_dir /home/vittorio/obsidian
[Obsidian FServe] hilite_color %C13
[Obsidian FServe] text_color %C14
[Obsidian FServe] dir_color %C13
[Obsidian FServe] file_color %C15
[Obsidian FServe] logo [Obsidian FServe]
[Obsidian FServe] note =/\= Il gestore del fs non è responsabile di cosa facciate coi files! =/\=

[Obsidian FServe] All time values are in seconds, if notify_timeout,
[Obsidian FServe] min_speed or auto_backup is set to zero, the
[Obsidian FServe] the function is disabled...

Per modificare la variabili, digitare /fs set variabile valore (ad esempio se volete settare max_users a 2, digitate /fs set max_users 2). Obsidian confermerà con la stringa:

[Obsidian FServe] Setting 'max_users' to '2'

Passiamo velocemente in rassegna il significato della varie variabili:
- MAX_USERS: numero massimo di utenti ammessi in contemporanea nel vostro file server. (per gli ADSL 640/256 consigliamo 1 o 2, i fibra ne possono mettere di più)
- MAX_SENDS: numero massimo di sends attivi in contemporanea (per ADSL 640/256 consigliamo max 2 sends, i fibra anche 7 o 8)
- MAX_QUEUES: Numero di code totali. Dipende molto dalle policy dei vari canali e dal tipo di file che condividete (consiglio da 5 a 10 per file grandi)
- SLOTS_BIG: Decide quanti file più grandi di size_big un singolo utente può accodare.
- SLOTS_MED: Decide quanti file più grandi di size_med un singolo utente può accodare.
- SLOTS_SMALL: Decide quanti file più piccoli di size_med un singolo utente può accodare.
- SIZE_BIG: tutti i files con dimensione almeno size_big bytes vengono considerati files 'grandi'.
- SIZE_MED: tutti i files con dimensione almeno size_med bytes vengono considerati files 'medi'. I file con dimensioni minori sono considerati files 'piccoli'.
- IDLE_TIME: Dopo idle_time secondi di inattività (=l'utente non digita nessun comando nel file serve), viene chiusa la connessione DCC (consiglio 180)
- MAX_FAILS: Quante volte un file viene rimandato (utile se la connessione di blocca). Il valore 0 disabilita tutti i re-invii. (consiglio 5)
- MIN_SPEED: Tutti gli utenti con una velocità di upload inferiore a min_speed verranno disconnessi. Serve per evitare che connessioni molto molto lente, blocchino gli altri utenti per tantissimo tempo.
- AUTO_BACKUP: E' possibile inserire il valore di secondi dopo i quali Obsidian fa un backup di tutte le code. L'utilizzo dello switch restorequeues (vedi sopra) è, di solito, più che sufficiente. (consiglio 0, se restorequeues è a 1)
- TRIGGER: quando qualcuno digita questo valore in canale o qualcuno ti manda questo valore via CTCP, Obsidian rispondere con il messaggio di benvenuto ed accetterà i comandi dell'utente
- SERVE_NO_NOTIFY: alcuni canali (come #startrekitalia) accettano fserve ma non i loro avvisi di presenza. Inseriteli in questa variabile. L'fserve non manderà alcune nofica tranne a coloro che digita !list. Per inserire più canali, mettere uno spazio fra i vari canali.
- SERVE_HIDDEN: Nei canali che inserirete qua, il server non manderà avvisi nè risponderà a @find e a !list. Per inserire più canali, mettere uno spazio fra i vari canali.
- NOTIFY_TO_VOICE: comando ancora non implementato
- NOTIFY_CHANNELS: Inserire in canali in cui il server sarà attivo e dove verrà inviato un avviso ogni notify_timeout secondi. Per inserire più canali, mettere uno spazio fra i vari canali.
- NOTIFY_TIMEOUT: Ogni notify_timeout secondi viene inviato in messaggio di notifica ai canali in notify_channels.
- ROOT_DIR: Inserite qua il percorso completo (ad esempio /home/utente/share ) della cartella dove avete i file da condividere. (maggiori info digitando '/fs help root_dir')
- HILITE_COLOR, TEXT_COLOR, DIR_COLOR, FILE_COLOR: colori in cui vengono visualizzate le varie parti del file server (consiglio di lasciare tutto così com'è).
- LOGO: Marchio del fserve (potete lasciarlo benissimo com'è).
- NOTE: Inserite un vostro mesaggio personalizzato che verrà visualizzato nel !list e in ogni avviso. Potete metterci cosa c'è nel vostro server.

Finite anche queste configurazione, digitare un bel '/fs save' per salvare la configurazione e digitare '/fs on': ora il vostro fserver obsidian è attivato e funzionante!

ALTRI COMANDI UTILI
Potete visualizzare tutti i comandi dell'Obsidian digitando /fs help. Eccone la lista (tradotta in italiano):
[Obsidian FServe] Command Parameters Description
[Obsidian FServe] ======= ========== ===========
[Obsidian FServe] on attiva il server
[Obsidian FServe] off disabilita il server
[Obsidian FServe] load carica il file di configurazione
[Obsidian FServe] save salve il file di configurazione
[Obsidian FServe] saveq salva le code di send e le queues
[Obsidian FServe] loadq carica le code di send e le queues
[Obsidian FServe] load_backup carica il backup delle code send e queues
[Obsidian FServe] update_files Aggiorna la cache dei files (quando aggiungete un file in root_dir, digitate questo comando)
[Obsidian FServe] show_files mostra i files nella cache
[Obsidian FServe] queuef <nick> <file> accoda un file ad un utente
[Obsidian FServe] sendf <nick> <file> manda un file ad un utente
[Obsidian FServe] send_queue #a manda adesso un file nelle queues
[Obsidian FServe] reset_sends resettta i sends
[Obsidian FServe] clr_queues cancella tutte le queues
[Obsidian FServe] clr_fqueues cancella le queues dei resend
[Obsidian FServe] dequeue #a cancella lo slot #a delle queues
[Obsidian FServe] move #a #b sposta i file dallo slot #a allo slot #b
[Obsidian FServe] stats mostra le statistiche
[Obsidian FServe] notify [channel] manda l'avviso ai canali adesso
[Obsidian FServe] sends mostra sends attivi
[Obsidian FServe] queues mostra la lista delle queues attuali
[Obsidian FServe] vars mostra le variabili
[Obsidian FServe] toggle mostre gli switch
[Obsidian FServe] toggle <switch> <0|1> setta uno switch
[Obsidian FServe] set <var> <data> setta una variabile
[Obsidian FServe] help <keyword> aiuto a proposito di un comando (keyword)
[Obsidian FServe] who mostra utenti connessi al fserve
[Obsidian FServe] about informazioni su questo fserve
[Obsidian FServe] gpl mostra la licenza del fserve

Per usare questi comandi dovete digitare '/fs nome_comando' (ad esempio, per mostrare le statistiche, digitate '/fs stats')

PROBLEMI NOTI

- Lo sviluppo di Obsidian è fermo da un bel pezzo ed ha ancora diversi bug e non si sa quando verranno risolti.
- Obsidian si ostina a mandare il file come resend anche se il file è già stato spedito completamente (almeno fino alla 0.9.2-pre1 nella pre2 sembra sia stato risolto).
- E' possibile inserire *un solo* trigger. (Mentre, ad esempio, Sysreset per mIRC supporta trigger multipli)

RINGRAZIAMENTI

Ringrazio trekfan1 e i canali #startrekitalia, #startrekitalia.com, #sezione31 per il supporto, l'aiuto e la magnifica compagnia.
Ringrazio fra74 che è stato l'autore delle primissima guida allo script Obsidian e che mi ha aiutato molto nei miei "esperimenti linuxiani".
Ringrazio OmegaVibes per i test su MacOs X.

Per segnalare ulteriori problemi o parti non chiare, mi trovate col nick vitto84 su #startrekitalia oppure a vittoso@email.it