Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Fetching contributors…

Cannot retrieve contributors at this time

file 345 lines (311 sloc) 15.902 kb
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345
  Installation

    Vous avez besoin de :

       * Un serveur Web (apache, IIS ...) avec le module php (4 ou 5)
       * Un acces en écriture sur ce serveur Web (ssh, FTP ou autre)

    Par défaut, vous n'avez pas besoin d'une base de donnée Mysql car des
    simples fichiers sont utilisés pour stoquer les informations.

       * En avant!
       * Configuration avancée

    En avant!

    Pour les feignants:

       1. Téléchargez le script d'installation auto-extractible :
          phpfreechat-x.x-setup.php[21] (la dernière version de préférence)
       2. Uploadez le script dans un répertoire accessible par votre
          navigateur (répertoire publique)
       3. Lancez votre navigateur et exécutez le script d'installation que
          vous venez d'uploader, ceci devrait lancer une interface
          d'installation, suivez alors les étapes !
          Astuce : supprimez le scripte d'installation une fois terminé pour
          des raisons de sécurité.

    Pour les utilisateurs avancés ou pour ceux qui n'ont pas gzip installé
    sur leur serveur:

       1. Téléchargez l'archive zip (ou tag.gz pour les utilisateurs linux) :
          phpfreechat-x.x.zip[22] (la dernière version de préférence)
       2. Décompressez l'archive localement et uploadez le résultat sur votre
          serveur dans un répertoire accessible par votre navigateur.
          Astuce: si vous avez un accès SSH, je vous conseil d'uploader
          l'archive tar.gz puis de la décompresser directement sur le serveur
          avec la commande tar xzf phpfreechat-x.x.tar.gz
       3. Donnez les droits en écriture aux répertoires
          phpfreechat-x.x/data/public et phpfreechat-x.x/data/private
          Si vous utilisez FTP, voici les commandes:
          CHMOD 777 phpfreechat-x.x/data/private
          CHMOD 777 phpfreechat-x.x/data/public

          Si vous utilisez SSH, voici les commandes:
          chmod a+w phpfreechat-x.x/data/*

       4. Pour terminer : lancez votre navigateur et ouvrez le répertoire
          phpfreechat-x.x sur votre serveur !

    Vous désirez certainement paramétrer votre propre chat, pour cela prenez
    exemple sur les scriptes du répertoire phpfreechat-x.x/demo.

    Voila le script minimum pour que le chat fonctionne (inspiré de demo1) :

    <?php

    require_once "src/phpfreechat.class.php"; // pensez à ajuster le chemin
    $params["serverid"] = md5(__FILE__); // permet d'identifier ce chat
    $chat = new phpFreeChat($params);

    ?>
    <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
           "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    <html>
      <head>
        <title>phpFreeChat demo</title>
        <?php $chat->printJavascript(); ?>
        <?php $chat->printStyle(); ?>
      </head>
      <body>
        <?php $chat->printChat(); ?>
      </body>
    </html>

    Configuration avancée

    Le chat fonctionne très bien en laissant les paramètres par défaut mais
    de nombreuses options peuvent être réglées. Par exemple, pour changer le
    temps de rafraichissement à 2 secondes (par défaut c'est 5 secondes),
    voila ce qu'il faut faire :

    <?php

    require_once "src/phpfreechat.class.php"; // ajustez le chemin
    $params["serverid"] = md5(__FILE__);
    $params["refresh_delay"] = 2000; // 2000ms = 2s
    $chat = new phpFreeChat($params);

    ?>
    [... copiez/coller le code HTML vu plus haut ...]

    Un autre exemple: vous souhaitez que vos utilisateur n'entrent pas de
    pseudonymes à leur arrivé sur le chat et qu'un pseudo "invité" leur oit
    assigné automatiquement (ceci est très utile pour integrer le chat dans
    un forum, un portail ou tout autre système l'utilisateur est déja
    authentifié), voila ce qu'il faut faire :

    <?php

    require_once "src/phpfreechat.class.php"; // ajustez le chemin
    $params["serverid"] = md5(__FILE__);
    $params["nick"] = "guest"; // ce pseudo peut-être récupéré depuis une base de données
    $chat = new phpFreeChat($params);

    ?>
    [... copiez/coller le code HTML vu plus haut ...]

    Maintenant voyons la liste exaustive des paramètres :

    serverid
         C'est leur seule paramètre obligatoire. C'est l'identifiant du chat,
         "son IP" (comparable à l'adresse (host) d'un serveur IRC) utilisé
         pour différencer ce chat d'un autre. Deux chats doivent avoir des
         serverid différents. Si vous ne savez pas quoi mettre, ceci
         fonctionnera dans la majorité des cas : $params["serverid"] =
         md5(__FILE__);
    nick
         Ce paramètre est très utile si vous connaissez à l'avance les
         pseudonymes des utilisateurs, par exemple si vous souhaitez intégrer
         le chat à un forum ou a un portail qui possède déjà un système
         d'authentification. Il suffit de renseigner le pseudonyme de
         l'utilisateur concerné dans cette option et l'utilisateur sera alors
         automatiquement connecté avec son pseudonyme, il n'aura pas à
         choisir son pseudo lors de la première connexion.
         Attention : Les pseudonymes doivent être encodés en UTF-8. Si par
         exemple vos pseudo viennent d'une base de donnée ils sont encodés
         en ISO-8859-1, vous devez les convertir : $params["nick"] =
         iconv("ISO-8859-1", "UTF-8", $bdd_nickname); (bien sur changez la
         variable $bdd_nickname à votre convenance)
         Remarque : Cette option peut-être utilisée conjointement à l'option
         frozen_nick pour empêcher l'utilisateur de changer de nom.
         ("" par défaut, signifie que les utilisateurs doivent choisir leur
         pseudonymes quand ils se connectent)
    title
         Permet de changer le titre du chat, c'est à dire le texte qui
         s'affiche en haut.
         ("My phpFreeChat" est la valeur par défaut)
    channel
         Permet de créer un salon. Techniquement, ce paramètre permet de
         choisir vont être stockés les messages et les pseudonymes du
         chat. Pour une explication plus détaillées voyez le paragraphe
         suivant[23] dans la FAQ.
         (par défaut, il est calculé automatiquement à partir du title)
    frozen_nick
         Mettre cette option à true va tout simplement empêcher les
         utilisateurs de changer leur pseudonymes. Cela sous entends que le
         pseudonyme à été automatiquement assigné (voir l'option nick)
         (false par défaut)
    max_nick_len
         C'est la longeur maximale que peut avoir un pseudonyme
         (15de caractères par défaut)
    max_text_len
         C'est la longeur maximale que peut avoir un message.
         ( 250 caractères par défaut)
    refresh_delay
         Ceci est le temps à attendre entre chaque rafrechissements. Un
         rafrechissement correspond à une requete HTTP demandant au serveur
         si il y a quelque chose de nouveau à afficher ou pas. S'il n'y a
         rien de nouveau alors la réponse HTTP est vide.
         ( 5000ms = 5s par défaut)
    timeout
         Ceci est le temps d'inactivité à attendre avant de déconnecter un
         utilisateur (en millisecondes).
         ( 20000ms = 20s par défaut)
    max_msg
         Ceci est la taille de l'historique, c'est à dire le nombre de
         messages gardés en mémoire. Quand un utilisateur se connect, il voit
         automatiquement les messages de l'historique. Le nombre de messages
         qu'il voit est définit par ce paramètre
         (20 lignes par défaut)
    connect_at_startup
         Mettre cette option à false obligera les utilisateurs à cliquer sur
         l'icone de connexion pour tchater.
         (true par défaut, signifie que les utilisateurs sont automatiquement
         connectés lorsque la page du chat est ouverte)
    start_minimized
         Mettre cette option à true minimizera le chat au premier chargement
         de la page.
         (false par défaut)
    height
         Hauteur de la zone de chat
         (440px par défaut)
    width
         Largeur de la zone de chat
         ("" par défaut, signifie que la valeur est assignées dans les CSS)
    shownotice
         Trois valeurs sont possibles : 0 pour ne rien afficher (ni les
         notices de connexion/deconnexion, ni les changements de pseudo), 1
         pour afficher seulement les changements de pseudo, 2 pour afficher
         les changements de pseudo et les connexions/deconnexions.
         (2 par défaut)
    nickmarker
         Mettre cette option à false désactivera la colorisation des
         pseudonymes.
         (true par défaut)
    clock
         Mettre cette option à false désactivera l'affichage de la date et de
         l'heure.
         (true par défaut)
    openlinknewwindow
         Mettre cette option à true permettra d'ouvrire les liens des
         convertations dans une nouvelle fenêtre. Techniquement cela rajoute
         l'attribut target="_blank" dans la balise du lien.
         (true par défaut)
    showwhosonline
         Permet de cacher/montrer la liste des utilisateurs connectés lors du
         premier affichage du chat.
         Utilisez btn_sh_whosonline pour désactiver complètement la
         possibilité de voir la liste des pseudonymes.
         (true par défaut)
    showsmileys
         Permet de cacher/montrer la liste des smileys lors du premier
         affichage du chat.
         Utilisez btn_sh_smileys pour désactiver complètement la possibilité
         de voir la liste des smileys.
         (true par défaut)
    btn_sh_whosonline
         Permet de cacher ou montrer le bouton showwhosonline (celui qui
         permet de cacher/montrer la liste des pseudonymes)
         (true par défaut)
    btn_sh_smileys
         Permet de cacher ou montrer le bouton showsmileys (celui qui permet
         de cacher/montrer la liste des smileys)
         (true par défaut)
    themeurl
         Permet de spécifier l'url à utiliser pour acceder aux themes (très
         utile pour la réécriture d'url)
         (ce paramètre est automatiquement calculé en fonction de themepath
    themepath
         Le chemin vers les themes. Les sous répertoires sont les différents
         thems disponibles.
         (dirname(__FILE__)."/../themes" par défaut)
    theme
         Ce peramètre permet de spécifier quelle theme utiliser. La liste des
         themes possible sont les nom des sous répertoires de themepath.
         ("default" par défaut)
    language
         Permet d'afficher le chat dans une langue donnée. Les valeurs
         possibles sont les nom des sous répertoires de i18n.
         (par défaut la langue est celle du serveur qui héberge le chat)
    output_encoding
         Permet de spécifier l'encodage à utiliser pour afficher les labels.
         Concretement ce paramètre doit correspondre à l'encodage de la page
         Web contenant le chat.
         (par défaut UTF-8, c'est à dire aucun transcodage car les messages
         sont stoqués en UTF-8 par défaut)
    container_type
         Permet de spéficier le conteneur à utiliser. Pour le moment, seul le
         conteneur File (système de fichier) est disponible mais dans le
         future de nombreux conteneurs existerons surrement (mysql, irc, msn,
         jabber...).
         ("File" par défaut)
    server_script_path et server_script_url
         Ces paramètres permettent de spécifier un script externe qui sera
         chargé des communication client/serveur du chat. Ce paramètre est
         très utile lorsque le script du chat (client) consomme beaucoup de
         ressources (voyez la demo3 pour un exemple concret). Le premier
         paramètre spécifie l'endroit du fichier lui même, le second
         paramètre indique l'url est situé le fichier (utile pour la
         réécriture d'url)
         (par défaut on utilise le même scripte que le script client pour les
         communications)
    client_script_path et client_script_url
         Ces paramètres sont utilisés pour spécifier le chemin du script qui
         va afficher le chat (script client). Ces options peuvent être utile
         lorsque la configuration du serveur est peu commune. Le premier
         paramètre spécifie l'endroit du fichier lui même, le second
         paramètre indique l'url est situé le fichier (utile pour la
         réécriture d'url)
         (par défaut pfc va essayer d'auto-detecter le script client en
         fonction des variables globales du serveur)
    useie7
         Mettre ce paramètre à false désactivera l'ajout des scripts IE7[24]
         permettant un meilleur affichage dans Internet Explorer.
         (true par défaut)
    ie7path
         Spécifie le répertoire vers la librairie IE7. Ce paramètre est utile
         si vous avez déjà installé une librairie smarty et que vous voulez
         économiser des octets sur votre serveur.
         (dirname(__FILE__)."/../lib/IE7_0_9" par défaut)
    jspath
         Spécifie le répertoire vers les librairies javascript (md5, cookie
         ...).
         (dirname(__FILE__)."/../lib/javascript" par défaut)
    usecsstidy
         Mettre ce paramètre à false désactivera l'utilisation de la
         librairie CSSTidy utilisée pour optimiser (en taille) la génération
         des CSS.
         (false par défaut car sur certains serveur la librarie CSSTidy pose
         des problèmes)
    csstidypath
         Spécifie le répertoire vers la librairie CSS Tidy[25]. Ce paramètre
         est utile si vous avez déjà installé une librairie csstidy et que
         vous voulez économiser des octets sur votre serveur.
         (dirname(__FILE__)."/../lib/csstidy-1.1" par défaut)
    xajaxpath
         Spécifie le répertoire vers la librairie xajax[26]. Ce paramètre est
         utile si vous avez déjà installé une librairie xajax et que vous
         voulez économiser des octets sur votre serveur.
         (dirname(__FILE__)."/../lib/xajax_0.2_stable" par défaut)
    data_private_path
         Ce répertoire est utilisé pour stoqué les données du chat ainsi que
         les templates compilés de smarty. Astuce: vous pouvez optimisez les
         performances coté serveur en spécifiant un répertoire en mémoire
         vive (RAM disk, tmpfs), voyez cette section dans la FAQ[27].
         (dirname(__FILE__)."/../data/private" par défaut)
    data_public_path et data_public_url
         Ce répertoire doit être impérativement accessible par votre serveur
         Web. Les scripts IE7 et xajax necessaires au chat y seront stockés.
         Le premier paramètre indique le répertoire absolue au niveau système
         de fichier, et le second indique l'url pour y acceder depuis le
         navigateur (utile pour la réécritude d'url)
         (dirname(__FILE__)."/../data/public" par défaut, data_public_url lui
         est calculé automatiquement)
    debug
         Cette option est très utile pour les développeurs. La mettre à true
         va activer les messages de log et la console de debug.
         (false par défaut)
    debugxajax
         Cette option est très utile pour découvrire les bug cachés (warning
         php lors d'une requete xajax par exemple) . Mettre cette option à
         true va activer les popup javascript de xajax pour tracer la
         communication client/serveur.
         (false par défaut)
    prefix
         Ce prefix est utilisé pour chaques fonctions javascript, chaque id
         CSS et chaques classes CSS de façon à éviter les recouvrements de
         variables entre phpfreechat et votre site web.
         ("phpfreechat_" par défaut)



    ©2006 phpFreeChat



--------------------------------------------------------------
List of References

Document's URL: http://www.phpfreechat.net/install.fr.html
[23] faq.fr.html#multiple-channels
[24] http://dean.edwards.name/IE7/
[25] http://csstidy.sourceforge.net/index.php
[26] http://www.xajaxproject.org/
[27] faq.fr.html#tmpfs
Something went wrong with that request. Please try again.