Difference between revisions of "J2J:AdminGuide"

From JaWiki (Jabber/XMPP wiki)
Jump to: navigation, search
(Зависимости: новый twisted с исправленными ошибками)
(Настройка компонента: новый конфиг)
Line 41: Line 41:
 
=== Настройка компонента ===
 
=== Настройка компонента ===
  
Необходимо получить конфигурационный файл для компонента с именем config.py. Для этого скопируем пример такого файла и отредактируем его:
+
Необходимо получить конфигурационный файл для компонента. По умолчанию, пути поиска для конфигурационного файла - ./j2j.conf, ~/.j2j/j2j.conf, /etc/j2j/j2j.conf. Для этого скопируем пример такого файла и отредактируем его:
  cp config.py.example config.py
+
  cp j2j.conf.example j2j.conf
  nano -w config.py
+
  nano -w j2j.conf
  
 
Параметры:
 
Параметры:
* JID - JID компоненты. Например,  
+
* Секция component:
 +
** JID - JID компоненты. Например,  
 
  JID=u"j2j.server.com"
 
  JID=u"j2j.server.com"
* HOST - IP или доменное имя сервера, к которому необходимо присоединить компонент. Например,
+
** Host - IP или доменное имя сервера, к которому необходимо присоединить компонент. Например,
  HOST="127.0.0.1"
+
  Host="127.0.0.1"
* PORT - порт на сервере, к которому необходимо подключаться. Должен совпадать с аналогичным, прописанным в конфигурации Вашего Jabber-[[server|сервера]].
+
** Port - порт на сервере, к которому необходимо подключаться. Должен совпадать с аналогичным, прописанным в конфигурации Вашего Jabber-[[server|сервера]].
* DB_HOST - IP или доменное имя сервера БД.
+
** Password - пароль на сервере, к которому необходимо подключаться. Должен совпадать с аналогичным, прописанным в конфигурации Вашего Jabber-[[server|сервера]].
* DB_USER - имя пользователя БД (в нашем примере - j2j)
+
* Секция database:
* DB_NAME - имя базы данных (в нашем примере - j2j)
+
** Host - IP или доменное имя сервера БД, оставьте пустым для использования UNIX-сокета Postgres
* DB_PASS - пароль от БД для данного пользователя БД.
+
** Type - тип используемой СУБД - postgres или mysql
* DB_PREFIX - в общем случае остается без изменений.
+
** User - имя пользователя БД (в нашем примере - j2j)
* ADMINS - список [[JID]]ов, на которые будут приходить уведомления о новых регистрациях. Пример:
+
** Name - имя базы данных (в нашем примере - j2j)
  ADMINS=[u"vasya@server.ru",u"zhenya@server.com"]
+
** Password - пароль от БД для данного пользователя БД.
 +
** Prefix - в общем случае остается без изменений.
 +
* Секция admins
 +
** List - список [[JID]]ов, на которые будут приходить уведомления о новых регистрациях. Пример:
 +
  List=vasya@server.ru,zhenya@server.com
 +
* Секция debug
 +
** logfile - путь к лог-файлу
 +
** registrations - помещать ли в лог-файл сообщения, связанные с регистрацией пользователей на сервисе
 +
** logins - помещать ли в лог-файл сообщения, связанные с входом-выходом пользователей
 +
 
 +
** xml_logging - путь к xml-логу
 +
** component_xml - помещать ли в xml-лог данные от сервиса
 +
** clients_xml - помещать ли в xml-лог данные по клиентам
 +
** clients_jids_to_log - список JIDов, станзы которых помещать в xml-лог или All, если помещать все.
 +
 
 +
Конфигурационный файл должен быть в кодировке UTF-8.
  
 
=== Запуск ===
 
=== Запуск ===

Revision as of 08:59, 21 April 2008

Руководство по установке и администрированию транспорта J2J (Jabber-to-Jabber).

Установка и настройка

Зависимости

Для работы J2J необходимо:

Загрузка исходного кода

Необходимо получить исходный код транспорта. Это можно сделать, пройдя по ссылке, либо с помощью SVN:

svn co https://svn.jrudevels.org/j2j/trunk j2j/

Настройка базы данных

Необходимо настроить базу данных (БД) на работу с J2J-компонентом:

Создаем пользователя:

createuser -P j2j

Ключ -P означает, что пользователь создается с указанием пароля. Запомните его, он понадобится для дальнейшей настройки.

Создадим базу данных:

createdb j2j

Импортируем структуру БД:

psql -U j2j j2j
\i pgsql.schema

Настройка компонента

Необходимо получить конфигурационный файл для компонента. По умолчанию, пути поиска для конфигурационного файла - ./j2j.conf, ~/.j2j/j2j.conf, /etc/j2j/j2j.conf. Для этого скопируем пример такого файла и отредактируем его:

cp j2j.conf.example j2j.conf
nano -w j2j.conf

Параметры:

  • Секция component:
    • JID - JID компоненты. Например,
JID=u"j2j.server.com"
    • Host - IP или доменное имя сервера, к которому необходимо присоединить компонент. Например,
Host="127.0.0.1"
    • Port - порт на сервере, к которому необходимо подключаться. Должен совпадать с аналогичным, прописанным в конфигурации Вашего Jabber-сервера.
    • Password - пароль на сервере, к которому необходимо подключаться. Должен совпадать с аналогичным, прописанным в конфигурации Вашего Jabber-сервера.
  • Секция database:
    • Host - IP или доменное имя сервера БД, оставьте пустым для использования UNIX-сокета Postgres
    • Type - тип используемой СУБД - postgres или mysql
    • User - имя пользователя БД (в нашем примере - j2j)
    • Name - имя базы данных (в нашем примере - j2j)
    • Password - пароль от БД для данного пользователя БД.
    • Prefix - в общем случае остается без изменений.
  • Секция admins
    • List - список JIDов, на которые будут приходить уведомления о новых регистрациях. Пример:
List=vasya@server.ru,zhenya@server.com
  • Секция debug
    • logfile - путь к лог-файлу
    • registrations - помещать ли в лог-файл сообщения, связанные с регистрацией пользователей на сервисе
    • logins - помещать ли в лог-файл сообщения, связанные с входом-выходом пользователей
    • xml_logging - путь к xml-логу
    • component_xml - помещать ли в xml-лог данные от сервиса
    • clients_xml - помещать ли в xml-лог данные по клиентам
    • clients_jids_to_log - список JIDов, станзы которых помещать в xml-лог или All, если помещать все.

Конфигурационный файл должен быть в кодировке UTF-8.

Запуск

Теперь все готово к запуску:

python main.py

Администрирование транспорта

ToDo: Информация пока отсутствует