readme.html

   1 <!DOCTYPE html>\r
   2 <html>\r
   3 <head>\r
   4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">\r
   5 <meta http-equiv="content-language" content="ja">\r
   6 <meta name="keywords" content="WebChat,マニュアル,使い方">\r
   7 <meta name="description" content="WebChatの使い方を解説しています">\r
   8 <meta name="robots" content="ALL" />\r
   9 <title>MANUAL</title>\r
  10 </head>\r
  11 <div id="content">\r
  12         <h2>動作環境</h2>\r
  13         <ul>\r
  14                 <li>node.js 0.8.x</li>\r
  15                 <li>redis 2.4.6以降</li>\r
  16         </ul>\r
  17         <h2>インストール方法</h2>\r
  18         <h3>Windows</h3>\r
  19         <ol>\r
  20                 <li><a href="https://github.com/rgl/redis/downloads">ここ</a>からRedis Serverダウンロードし、インストールする</li>\r
  21                 <li><a href="http://nodejs.org/">ここ</a>のDownloadページからをnode.jsダウンロードし、インストールする</li>\r
  22                 <li><a href="http://www-jp.mysql.com/">ここ</a>のダウンロードからMySQLをダウンロードし、インストールする</li>\r
  23                 <li>mysql -u root -p &lt; init.sqlを実行する</li>\r
  24                 <li>npm installを実行する</li>\r
  25                 <li>chat.jsの$usernameと$passwordを適切なものに変更する</li>\r
  26                 <li>redisを起動し、main.jsを起動する</li>\r
  27         </ol>\r
  28         <h3>CentOS系列</h3>\r
  29         <ol>\r
  30                 <li>yum groupinstall "Development Tools"を実行する</li>\r
  31                 <li>yum instlall gitを実行する</li>\r
  32                 <li>yum install wgetを実行する</li>\r
  33                 <li>yum install openssl-develを実行する</li>\r
  34                 <li><a href="http://redis.io/download">ここ</a>にアクセスし、redisをインストールする</li>\r
  35                 <li>redis-2.4.17/utils/install_server.shを実行する</li>\r
  36                 <li><a href="http://nodejs.org/dist/v0.8.14/node-v0.8.14.tar.gz">ここ</a>からダウンロードする</li>\r
  37                 <li>yum install mysql-serverを実行する</li>\r
  38                 <li>/etc/my.cnfのclient,mysql,mysqldumpセクションのdefault-character-setをutf8にする</li>\r
  39                 <li>chkconfig mysqld onを実行する</li>\r
  40                 <li>/etc/rc.d/init.d/mysqld startを実行する</li>\r
  41                 <li>tar xzf node-v0.8.14.tar.gzを実行する</li>\r
  42                 <li>cd node-v0.8.14を実行する</li>\r
  43                 <li>./configureを実行する</li>\r
  44                 <li>makeを実行し、make installも実行する</li>\r
  45                 <li>git clone git://git.sourceforge.jp/gitroot/webchat/WebChat.gitを実行する</li>\r
  46                 <li>npm installを実行する</li>\r
  47                 <li>chat.jsの$usernameと$passwordを適切なものに変更する</li>\r
  48                 <li>main.jsの$redisHost、$redisPort、$redisPasswordを変更する（ローカル内でRedisSeverを起動する場合は不要）</li>\r
  49                 <li>main.jsを起動する</li>\r
  50         </ol>\r
  51         <h2>管理サイト</h2>\r
  52         <p>[設置しているサーバー]/adminとアドレスバーに入力することで管理用のページにアクセスできます</p>\r
  53         <p>このページではログの削除、アクセスを禁止するIPアドレスの設定、ルームの設定を行うことができます。</p>\r
  54         <p>IPアドレスの設定時に「IPアドレス:r」とすることで読み取りを禁止し、「IPアドレス」だけを記述することで書き込みを禁止します。</p>\r
  55         <p>ルームの設定では「部屋番号:パスワード」とすることで固定パスワードを設定し、「部屋番号」と記載することで利用者にパスワードを設定させることができます。また、「部屋番号::true」とした場合はROMを禁止することができます</p>\r
  56         <h2>チャットルームへのアクセス</h2>\r
  57         <p>アドレスバーに[設置しているサーバー]/chatと入力することでチャットルームにアクセスできます。</p>\r
  58         <p>[設置しているサーバー]/admin_chatと入力した場合はIPアドレスが表示されます</p>\r
  59         <h2>複数のルームの設置</h2>\r
  60         <p>URLを[設置しているサーバー]/chat?rno=[ルーム番号]とすることで複数のチャットルームを使い分けることができます。</p>\r
  61         <p>なお、デフォルトではchatServer.jsの$max_room_numberの値が3になっているので、この値を設置したい個数にしてください。（設定を変えた後は再起動してください）</p>\r
  62         <h2>ルームごとにスタイル変える方法</h2>\r
  63         <p>&lt;link rel=&amp;quot;stylesheet&amp;quot; href=&amp;quot;stylesheets/&lt;%= rno %&gt;.css&amp;quot; type=&amp;quot;text/css&amp;quot; /&gt;</p>\r
  64         <p>この記述をchat.ejsファイルの&lt;head&gt;から&lt;/head&gt;の間に追加し、[ルーム番号].cssという名前のファイルを用意することで部屋ごとにデザインを変えることができます</p>\r
  65         <h2>プロファイルへのリンク方法</h2>\r
  66         <p>chatclient.jsの$profile_linkをプロファイルの設定に合わせてください。（%nはurlencodeされた名前を表します）</p>\r
  67         <p>例：$profile_link=http://localhost/profile.cgi?name=%n</p>\r
  68         <h2>コマンドの追加方法</h2>\r
  69         <p>WebChatでは必要に応じて外部コマンドを追加することができます。追加する場合はchat.ejsのcommandparser.jsを呼び出している行よりも後に追加してください。そうでない場合、正常に動作しないことがあります</p>\r
  70         <h2>トラブルシューティング</h2>\r
  71         <h3>500 Redis connection to [サイト名] failed - connect ECONNREFUSEDと表示される</h3>\r
  72         <p>Redisサーバーが起動していない。もしくは$redisHost,$redisPort,$redisPasswordの設定が間違っていることが考えられます</h3>\r
  73         <h3>\r
  74         <h2>不具合報告</h2>\r
  75         <p>不具合報告は<a href="http://sourceforge.jp/projects/webchat/">このサイト</a>にあるフォーラムもしくはチケットからお願いします</p>\r
  76         <h2>著作権</h2>\r
  77         <dl>\r
  78                 <dt>BellG@11.wav、BellG@11.mp3</dt>\r
  79                 <dd><a href="http://wwl.s-t-t.com/">WEB WAVE LIB</a>様</dd>\r
  80         </dl>\r
  81         <h2>ライセンス</h2>\r
  82         <p>著作権で定義されたものを除き、すべてのファイルはBSDライセンスにより提供されるものとします</p>\r
  83 </div>\r
  84 <div id="footer">\r
  85         <div id="copyright">Copyright (C) FooProject All Rights Reserved.</div>\r
  86 </div>\r
  87 <body>\r
  88 </body>\r
  89 </html>\r