Difference between revisions of "Eng:J2J:AdminGuide"

Latest revision as of 07:02, 18 January 2015

Эта страница доступна в версии на русском языке.

This page is also available in Russian.

Pages in English • Translated pages • Pages that have an english version

Installation and operation guide for J2J (Jabber-to-Jabber) gateway.

Installation and configuring[edit]

Dependencies[edit]

For J2J you will need:

Python >=2.3
Twisted >=10.2.0 (patch http://twistedmatrix.com/trac/attachment/ticket/4771/twisted-ticket-4771.patch is needed for 10.2.0)
PostgreSQL >=8.2
PyGreSQL >=3.8
PyOpenSSL >=0.6

(Note: there is experimental Mysql with mysql-python support in 1.1.8 and beyond, see Changelog.txt)

Any Jabber-server (for example ejabberd, jabberd2 or Openfire), that supports:
- XEP-0114: Jabber Component Protocol
- XEP-0030: Service Discovery

Source code downloads[edit]

You need to get sources of J2J. You can do it at JRuDevels Downloads, or with help of SVN:

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

Database setup[edit]

You need to setup a database to work with J2J:

Let's create a database for J2J:

postgresql:

createdb j2j

mysql

mysql -h localhost -u root -p -e "CREATE DATABASE j2j;"

Let's create a DB user:

postgresql:

createuser -P j2j

A -P key means, that user is created with a password-prompt. Store it, because it will be needed for next steps. Same with yourpassword in mysql:

mysql:

mysql -h localhost -u root -p -e "GRANT SELECT, INSERT, UPDATE, DELETE, CREATE, DROP ON j2j.* TO 'j2j'@'localhost' IDENTIFIED BY 'yourpassword';"

And import a database structure:

postgresql:

psql -U j2j j2j
\i pgsql.schema

mysql

mysql -h localhost -u root -p -e "use j2j; \. mysql.schema"

Gateway configuration[edit]

Configuration file is needed for J2J. Default search paths for it is: ./j2j.conf, ~/.j2j/j2j.conf and /etc/j2j/j2j.conf; also you can use "-c /path/j2j.conf" in main.py, see later. Let's copy example of this and edit it:

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

Parameters:

Section component
- JID - JID of gateway. For example,

JID=j2j.server.com

- Host - IP or domain-name of your Jabber-server. For example,

Host="127.0.0.1"

- Port - port on Jabber-server to which J2J will be connected. It must be the same as it specified in your Jabber-server's configuration.
- Password - password on Jabber-server to which J2J will be connected.
Section database
- Host - IP or Domain-name of your database server. Leave it blank to use postgres' UNIX-socket.
- Type - Type of your database server: postgres or mysql
- User - Database username (in our example is j2j)
- Name - Database name (in our example is j2j)
- Password - Password for this database username.
- Prefix - pass it as is.
Section admins
- List - a list of JIDs, for a notifications of new users registrations. For example,

List=vasya@server.ru,zhenya@server.com

Section debug
- Pass it as is. If you will get errors in J2J's work try to turn on logging in it section.

Running[edit]

Let's start the gateway:

python main.py

it should spit "Connected", see also your jabber server log.

Problems[edit]

If you see:

Exception exceptions.AttributeError: "database instance has no attribute 'dbCursor'" in <bound method
 database.__del__ of <database.database instance at 0x85f1bec>> ignored

Check if you have installed python db access support ( i.e. python-pygresql, python-mysqldb in debian) and if it is up to date. Otherwise, is postgresql/mysql rdbms accesible with the parameters in [database] section in your j2j.conf? is it up?

If you see :

Traceback (most recent call last):
  File "/usr/src//j2j/main.py", line 11, in ?
    import j2j
  File "/usr/src/j2j/j2j.py", line 14, in ?
    from client import Client
  File "/usr/src/j2j/client.py", line 10, in ?
    from twisted.names.error import DNSNameError
ImportError: No module named error

In debian etch twisted is too old: required twisted 8.01 is in etch+1; ubuntu 8.04 is ok too. And with FreeBSD you need also py-twistedNames, it's not installed with twisted.

Sometimes main.py doesn't spit nothing, check your jabber server log, maybe there is an authentication password problem so recheck [component] section in j2j.conf
In j2j.conf are declared some paths to log files, do these files exist? do they have write permissions?

Command line options[edit]

Start J2J with the --help key to get help about command-line options.

@@ Line 1: / Line 1: @@
-Installation and operation guide for [[J2J|J2J (Jabber-to-Jabber)]] [[gateway]].
+{{EnglishVersion|J2J:AdminGuide}}
+Installation and operation guide for [[Eng:J2J|J2J]] (Jabber-to-Jabber) gateway.
 == Installation and configuring ==
@@ Line 6: / Line 7: @@
 For J2J you will need:
-* [[Python]] >=2.3
+* [http://python.org Python] >=2.3
-* [http://www.postgresql.org/ PostgreSQL] >=7.4.7
+* [http://twistedmatrix.com/ Twisted] >=10.2.0 (patch http://twistedmatrix.com/trac/attachment/ticket/4771/twisted-ticket-4771.patch is needed for 10.2.0)
+* [http://www.postgresql.org/ PostgreSQL] >=8.2
 * [http://www.pygresql.org/ PyGreSQL] >=3.8
-* [[Twisted]] >=2.4.0
+* [http://pyopenssl.sourceforge.net/ PyOpenSSL] >=0.6
-* Any Jabber-[[server]] (for example, [[ejabberd]] or [[Wildfire]]), that supports:
+(Note: there is experimental [http://www.mysql.com/ Mysql] with [http://mysql-python.sourceforge.net/ mysql-python] support in 1.1.8 and beyond, see Changelog.txt)
+* Any Jabber-server (for example ejabberd, jabberd2 or Openfire), that supports:
 ** {{xep|0114|Jabber Component Protocol}}
-** [[Service Discovery|XEP-0030: Service Discovery]]
+** {{xep|0030|Service Discovery}}
-=== Загрузка исходного кода ===
+=== Source code downloads ===
+You need to get sources of [[Eng:J2J|J2J]]. You can do it at [http://jrudevels.org/index.php?pg=downloads.php&dir=J2J JRuDevels Downloads], or with help of [http://subversion.tigris.org/ SVN]:
-Необходимо получить исходный код транспорта. Это можно сделать, пройдя по [http://jrudevels.org/index.php?pg=downloads.php&dir=J2J ссылке], либо с помощью [http://subversion.tigris.org/ SVN]:
+ <nowiki>svn co svn://svn.jrudevels.org/j2j/trunk j2j/</nowiki>
- <nowiki>svn co https://svn.jrudevels.org/j2j/trunk j2j/</nowiki>
+=== Database setup ===
-=== Настройка базы данных ===
+You need to setup a database to work with [[Eng:J2J|J2J]]:
-Необходимо настроить базу данных (БД) на работу с J2J-компонентом:
+Let's create a database for [[Eng:J2J|J2J]]:
+* postgresql:
+ createdb j2j
+* mysql
+ mysql -h localhost -u root -p -e "CREATE DATABASE j2j;"
-Создаем пользователя:
+Let's create a DB user:
+* postgresql:
   createuser -P j2j
+A -P key means, that user is created with a password-prompt. Store it, because it will be needed for next steps. Same with yourpassword in mysql:
+* mysql:
+ mysql -h localhost -u root -p -e "GRANT SELECT, INSERT, UPDATE, DELETE, CREATE, DROP ON j2j.* TO 'j2j'@'localhost' IDENTIFIED BY 'yourpassword';"
-Ключ -P означает, что пользователь создается с указанием пароля. Запомните его, он понадобится для дальнейшей настройки.
+And import a database structure:
+* postgresql:
-Создадим базу данных:
- createdb j2j
-Импортируем структуру БД:
   psql -U j2j j2j
   \i pgsql.schema
+* mysql
+ mysql -h localhost -u root -p -e "use j2j; \. mysql.schema"
-=== Настройка компонента ===
+=== Gateway configuration ===
-Необходимо получить конфигурационный файл для компонента с именем config.py. Для этого скопируем пример такого файла и отредактируем его:
+Configuration file is needed for [[Eng:J2J|J2J]]. Default search paths for it is: ./j2j.conf, ~/.j2j/j2j.conf and /etc/j2j/j2j.conf; also you can use "-c /path/j2j.conf" in main.py, see later. Let's copy example of this and edit it:
-  cp config.py.example config.py
+  cp j2j.conf.example j2j.conf
-  nano -w config.py
+  nano -w j2j.conf
-Параметры:
+Parameters:
-* JID - JID компоненты. Например,
+* Section component
-  JID=u"j2j.server.com"
+** JID - JID of gateway. For example,
-* HOST - IP или доменное имя сервера, к которому необходимо присоединить компонент. Например,
+  JID=j2j.server.com
-  HOST="127.0.0.1"
+** Host - IP or domain-name of your Jabber-server. For example,
-* PORT - порт на сервере, к которому необходимо подключаться. Должен совпадать с аналогичным, прописанным в конфигурации Вашего Jabber-[[server|сервера]].
+  Host="127.0.0.1"
-* DB_HOST - IP или доменное имя сервера БД.
+** Port - port on Jabber-server to which J2J will be connected. It must be the same as it specified in your Jabber-server's configuration.
-* DB_USER - имя пользователя БД (в нашем примере - j2j)
+** Password - password on Jabber-server to which J2J will be connected.
-* DB_NAME - имя базы данных (в нашем примере - j2j)
+* Section database
-* DB_PASS - пароль от БД для данного пользователя БД.
+** Host - IP or Domain-name of your database server. Leave it blank to use postgres' UNIX-socket.
-* DB_PREFIX - в общем случае остается без изменений.
+** Type - Type of your database server: postgres or mysql
-* ADMINS - список [[JID]]ов, на которые будут приходить уведомления о новых регистрациях. Пример:
+** User - Database username (in our example is j2j)
-  ADMINS=[u"vasya@server.ru",u"zhenya@server.com"]
+** Name - Database name (in our example is j2j)
+** Password - Password for this database username.
+** Prefix - pass it as is.
+* Section admins
+** List - a list of JIDs, for a notifications of new users registrations. For example,
+  List=vasya@server.ru,zhenya@server.com
+* Section debug
+** Pass it as is. If you will get errors in J2J's work try to turn on logging in it section.
-=== Запуск ===
+=== Running ===
-Теперь все готово к запуску:
+Let's start the gateway:
   python main.py
+it should spit "Connected", see also your jabber server log.
+=== Problems ===
+* If you see:
+ <nowiki>Exception exceptions.AttributeError: "database instance has no attribute 'dbCursor'" in <bound method
+ database.__del__ of <database.database instance at 0x85f1bec>> ignored</nowiki>
+Check if you have installed python db access support ( i.e. python-pygresql, python-mysqldb in debian) and if it is up to date. Otherwise, is postgresql/mysql rdbms accesible with the parameters in [database] section in your j2j.conf? is it up?
+* If you see :
+ Traceback (most recent call last):
+   File "/usr/src//j2j/main.py", line 11, in ?
+     import j2j
+   File "/usr/src/j2j/j2j.py", line 14, in ?
+     from client import Client
+   File "/usr/src/j2j/client.py", line 10, in ?
+     from twisted.names.error import DNSNameError
+ ImportError: No module named error
-== Администрирование транспорта ==
+In debian etch twisted is too old: required twisted 8.01 is in etch+1; ubuntu 8.04 is ok too.
+And with FreeBSD you need also py-twistedNames, it's not installed with twisted.
+* Sometimes main.py doesn't spit nothing, check your jabber server log, maybe there is an authentication password problem so recheck [component] section in j2j.conf
+* In j2j.conf are declared some paths to log files, do these files exist? do they have write permissions?
-{{todo|Информация пока отсутствует}}
+=== Command line options ===
+Start [[Eng:J2J|J2J]] with the --help key to get help about command-line options.
 [[Category:Documentation]]
+[[Category:English]]

Difference between revisions of "Eng:J2J:AdminGuide"

Latest revision as of 07:02, 18 January 2015

Contents

Installation and configuring[edit]

Dependencies[edit]

Source code downloads[edit]

Database setup[edit]

Gateway configuration[edit]

Running[edit]

Problems[edit]

Command line options[edit]

Navigation menu

Views

Personal tools

JaWiki

Описания

разработчику

Ссылки

Search

Tools