Инструкции и руководства ИБ Коми НЦ УрО РАН

Эта страница только для чтения. Вы можете посмотреть её исходный текст, но не можете его изменить. Сообщите администратору, если считаете, что это неправильно.
====== Система управления библиографической информацией ИБ Коми НЦ УрО РАН на основе программного продукта «Zotero». Руководство администратора ======
===== Установка Zotero Data Server на Debian Linux =====
Авторы: Altynbek Isabekov, Eric Fernandez (20.06.2013)

Перевод (с дополнениями) Иван Чадин (11.10.2014)


===== Реферат =====

Данное руководство посвящено процессу установки сервера данных Zotero на ЭВМ, работающей под управлением Debian Wheezy (7.0RC1)


===== Установка Zotero Data Server =====
==== Получение исходных кодов ====
Создайте каталог для установки Zotero Data Server и перейдите в него
<code>
 $ mkdir /srv/http
 $ cd /srv/http/
</code>
Загрузите исходный код Zotero Data Server из репозитория github:
<code>
 $ sudo git clone —recursive https://github.com/Panzerkampfwagen/dataserver.git
</code>

Переименуйте каталог (важно! наименование каталога используется в исходном коде)

<code>
 $ sudo mv dataserver ZoteroDataServer
</code>

Загрузите php-фреймворк Zend
<code>
 $ sudo wget -vc "http://framework.zend.com/releases/ZendFramework -1.12.3/ZendFramework-1.12.3.tar.gz"
</code>
Распакуйте часть архива php-фреймворка Zend (ZendFramework-1.12.2/library/Zend) в каталог «include» (''/srv/http/ZoteroDataServer/include/Zend''):

<code>
 $ sudo tar -xvf ZendFramework-1.12.3.tar.gz --strip=3 -C "/srv/http/ZoteroDataServer/include/Zend" "ZendFramework-1.12.3/library/Zend"
</code>

==== Настройка веб-сервера Apache и PHP ====
Установите сервер Apache и PHP

<code>
 $ sudo aptitude install apache2 php5
</code>

Создайте виртуальный хост для сервера данных Zotero. Для этого добавьте следующие строки в конфигурационный файл '' /etc/apache2/sites-available/default''. Каталогом для сервера данных служит ''/srv/http/ZoteroDataServer/''.
<code>
 NameVirtualHost *:85
 <VirtualHost *:85>
 ServerName *:85
     DocumentRoot "/srv/http/ZoteroDataServer/htdocs"
     ErrorLog "${APACHE_LOG_DIR}/Zotero-Data-Server-Error.log"
     CustomLog "${APACHE_LOG_DIR}/Zotero-Data-Server-Access.log" common
     <Directory "/srv/http/ZoteroDataServer/htdocs">
         Options FollowSymLinks MultiViews
         AllowOverride All
         Order allow,deny
         Allow from all
     </Directory>
     AllowEncodedSlashes On
 </VirtualHost>
</code>

Сделайте доступными следующие модули:
<code>
 $ sudo a2enmod rewrite
 $ sudo a2enmod vhost_alias
</code>
Включите в Apache прослушивание порта 85, который указывает на виртуальный хост Zotero, путем добавления слующих строк в файл ''/etc/apache2/ports.conf'':
<code>
 NameVirtualHost *:85
 Listen 85
</code>

Запустите Apache и убедитесь, что он успешно запускается:
<code>
 $ sudo service apache2 start
</code>

== Настройка MySQL ==
Установите MySQL:
<code>
 $ sudo aptitude install php5-mysql mysql-server
</code>
Сервер данных Zotero настроен на использование пароля 'SecurePassword' в качестве пароля пользователя root. Для того, чтобы установить этот пароль остановите демон MySQL, если он запущен:
<code>
 $ sudo service mysql stop
</code>
Перезапустите MySQL с пропуском системы атентификации:
<code>
 $ sudo mysqld_safe --skip-grant-tables &
</code>
Запустите консольный клиент mysql
<code>
$ sudo mysql -u root mysql
</code>
Поменяйте root пароль:
<code>
 mysql> UPDATE mysql.user SET Password=PASSWORD('SecurePassword') WHERE User='root';
 mysql> FLUSH PRIVILEGES;
 mysql> EXIT
</code>

Скрипты, которые создают базу данных Zotero нуждаются информации о логине и пароле. Скрипт получает эту информацию из файла ''/etc/mysql/my.cnf''. Внесите следующие изменения в этот файл:
<code>
 [client]
 user=root
 password=SecurePassword
</code>
Измените часовой пояс MySQL на UTC путем внесения измений файл ''/etc/mysql/my.cnf:''
<code>
 [mysqld]
 ...
 default-time-zone = '+0:00'
</code>
Установите phpMyAdmin, удобный инструмент для администрирования MySQL с использованием веб-интерфейса:
<code>
 $ sudo aptitude install phpmyadmin
</code>
Перезапустите Apache:
<code>
 $ sudo service apache2 restart
</code>
==== Настройка Zotero Data Server ====
Основные настройки хранятся в файле: ''ZoteroDataServer/include/config/config.inc.php''
<code>
  ...
 public static $SYNC_DOMAIN = '127.0.0.1:85';
 ...
 public static $CLI_PHP_PATH = '/usr/bin/php';
 public static $CLI_DOCUMENT_ROOT = "/srv/http/ZoteroDataServer/";
 ...
</code>
Адрес сервера Zotero предустановлен локальный (127.0.0.1:85), таким образом он не принимает соединения с других IP адресов. Но на этом этапе нашей задачей является добиться работоспособности сервера на локальном хосте. Позднее, когда сервер начнет работать корректно, необходимо будет поменять локальный IP адрес на IP адрес ЭВМ вашей локальной сети, чтобы сделать сервер Zotero доступным для синхронизации с любой ЭВМ, подключенной к вашей локальной сети.

Если вы решите изменить корневой каталог сервера данных, изменив значение переменной ''$CLI_DOCUMENT_ROOT ''не забудьте добавить завершающий слэш «/» в конце пути к каталогу.

Взаимодейстие с MySQL сервер производит используя сведения о root пароле, который хранится в файле ''ZoteroDataServer/include/config/config.inc.php''. Вы можете изменить пароль по умолчанию ("SecurePassword"), редактируя этот файл.

==== Запуск Zotero Data Server ====
Запустите MySQL. Запустите Apache. Убедитесь, что оба сервера запустились без ошибок.
<code>
 $ sudo service mysql start
 $ sudo service apche2 start
</code>
Установите систему кэширования памяти «memcached», которая позволит повысить быстродействие и отказоустойчивость веб-сервисов, запущенных на ЭВМ:
<code>
 $ sudo aptitude install memcached
</code>
Перейдите в каталог ''/srv/http/ZoteroDataServer/misc''
<code>
 $ cd /srv/http/ZoteroDataServer/misc
</code>
Запустите скрипт ''test_reset'', который удалит все сущеествующие базы данных Zotero data server и создаст новые базы данных с нуля.
<code>
 $ sudo ./test_reset
 Deleting databases
 Creating databases
 Deleting users
 Creating users
 Updating user privileges
 Filling databases with default fields
 Reset is successfull. Now run ./test_setup
</code>
Вы должны увидеть сообщение ''"Reset is successfull. Now run ./test_setup"''. Сейчас вы можете запустить скрипт ''test_setup, ''который добавит некоторые записи в базу данных ''zoterotest1'':
<code>
 $ sudo ./test_setup
</code>
Если вы увидете сообщение ''"Test setup is successfull.", ''то это означает что необходимые записи были добавлены в базу данных.

Измените права доступа к каталогу tmp Zotero data server:
<code>
 $ sudo chmod 777 /srv/http/ZoteroDataServer/tmp
</code>
Теперь можно открыть три терминала и запустить демоны, управляющие загрузкой, скачиванием и отслеживанием ошибок процесса синхронизации:

В первом терминале:
<code>
 $ cd /srv/http/ZoteroDataServer/processor/upload/
 $ php daemon.php
</code>
Во втором терминале:
<code>
 $ cd /srv/http/ZoteroDataServer/processor/download/
 $ php daemon.php
</code>
В третьем терминале:
<code>
 $ cd /srv/http/ZoteroDataServer/processor/error/
 $ php daemon.php
</code>
Проверьте, что каждый из демонов запустился успешно (в данном случае, демон «download»):
<code>
 2013-06-20 11:16:48.5637 Starting download processor daemon
 2013-06-20 11:16:48.5754 0 processors, 0 queued processes
</code>
В случае возникновения ошибки, демоны остановятся и Zotero data server будет недоступен для синхронизции до тех пор, пока демоны не будут перезапущенны вручную. В частности, демоны закрузки и скачивания аварийно завершат работу если период ожидания доступа к базам данных MySQL превысит лимит 8 часов, установленный по умолчанию настройках MySQL. Чтобы предотвратить это, можно изменить параметр ''wait_timeout ''в файле /''etc/mysql/my.cnf'' на максимальное значение — 1 год (31536000 seconds):
<code>
 [mysqld]
 ...
 wait_timeout = 31536000
</code>
Альтернативным (и более надежным) решением является установка пакета «daemontools»:
<code>
 $ sudo aptitude install daemontools
</code>
Затем в каждом из каталогов запустите утилиту ''supervise'':

В первом терминале:
<code>
 $ cd /srv/http/ZoteroDataServer/processor/upload/
 $ sudo supervise .
</code>
В втором терминале:
<code>
 $ cd /srv/http/ZoteroDataServer/processor/download/
 $ sudo supervise .
</code>
В третьем терминале:
<code>
 $ cd /srv/http/ZoteroDataServer/processor/error/
 $ sudo supervise .
</code>
Программа ''supervise'' будет автоматически запускать файл ''./run'' в каждой из директорий и перезапускать его в случае аварийного завершения.

== Тестирование Zotero Data Server ==
Установите утилиту curl:
<code>
 $ sudo aptitude install curl
</code>
Для проверки аутентификации на сервере, отправьте на него следующий запрос:
<code>
 $ curl -X POST -d "version=9&username=testuser&password=testuser" http://127.0.0.1:85/login
</code>
Этот запрос должен вернуть ответ, похожий на этот:
<code>
 <?xml version="1.0"?>
 <response version="9" timestamp="1341134959">
     <sessionID>
         da802280ce0bfc2e90cb1ad0747ff642
     </sessionID>
 </response>
</code>
Теперь, используя идентификатор сессии ''"sessionID"'' вы можете отправить запрос ''"updated"'':
<code>
 $ curl -X POST -d "version=9&sessionid=da802280ce0bfc2e90cb1ad0747ff642&lastsync=1" http://127.0.0.1:85/updated
</code>
ответ будет примерно таким:
<code>
 <?xml version="1.0"?>
 <response version="9" timestamp="1341135305" userID="1"
     defaultLibraryID="1" updateKey="43d4eaa497ab8cbfc8f4d201d955fd70"
         earliest="1341131740">
 <updated/>
 </response>
 $ cadaver http://127.0.0.1/zotero
 Authentication required for WebDAV on server `127.0.0.1':
 Username: testuser
 Password:
 dav:/zotero/> ls
 Listing collection `/zotero/': succeeded.
     3QBQSD38.prop    117         Aug 12 13:21
     3QBQSD38.zip    465149     Aug 12 13:21
     5BA5I3IP.prop    117         Aug 12 13:21
     5BA5I3IP.zip    809         Aug 12 13:21
     8IF963XB.prop    117         Aug 12 13:21
     8IF963XB.zip    860702     Aug 12 13:21
     lastsync            1    Aug 12 13:21
 dav:/zotero/>
</code>
===== Установка Zotero Attachment Server =====
Для того, чтобы получить возможность загружать на сервер и скачивать оттуда файлы, приложенные пользователями к библиографическим описаниям необходимо обеспечить клиент Zotero доступом к серверу WebDAV. Для того, чтобы запустить свой WebDAV сервер сделайте доступными серверу Apache следующие модули:
<code>
 $ sudo a2enmod auth_digest
 $ sudo a2enmod dav
 $ sudo a2enmod dav_fs
 $ sudo a2enmod dav_lock
</code>
Теперь создайте WebDAV lock каталог и файл:
<code>
 $ sudo mkdir /srv/http/DAVLock
 $ sudo chmod -R 777 /srv/http/DAVLock
 $ sudo chown -R www-data:www-data /srv/http/DAVLock
</code>
Создайте каталог для хранения файлов-приложений Zotero:
<code>
 $ sudo mkdir /srv/http/zotero
 $ sudo chown -R www-data:www-data /srv/http/zotero
 $ sudo chmod -R 777 /srv/http/zotero
</code>
Добавьте следующую строку в конфигурационный файл: ''/etc/apache2/sites-available/default:''
<code>
 DavLockDB /srv/http/DAVLock/DAVLockDB
</code>
Поместите следущие строки в файл /etc/apache2/sites-available/default ниже раздела ''<VirtualHost *:80>''
<code>
 DocumentRoot /srv/http
 <Directory "/srv/http/zotero">
     Dav On
     Order Allow,Deny
     Allow from all
     AllowOverride None
     AuthType Digest
     AuthName "WebDAV"
     AuthUserFile "/var/www/.DAVlogin"
     AuthDigestProvider file
     Require user "testuser"
 </Directory>
</code>
Теперь необходимо создать MD5 хэш для пользователя «testuser», выбрав какой либо пароль, и сохранить его в файле /''etc/httpd/conf/extra/AuthWebDAV.passwd :''
<code>
 $ sudo htdigest -c /etc/httpd/conf/extra/AuthWebDAV.passwd WebDAV testuser
 Adding password for testuser in realm WebDAV.
 New password:
 Re-type new password:
</code>
Перезапустите сервер Apache:
<code>
 $ sudo service apache2 restart
</code>
Для того, чтобы протестировать ваш WebDAV сервер установите пакет ''«cadaver»'':
<code>
 $ sudo aptitude install cadaver
</code>
Теперь подключитесь к вашему WebDAV серверу:
<code>
 $ cadaver http://127.0.0.1/zotero
 Authentication required for WebDAV on server `127.0.0.1':
 Username: testuser
 Password:
 dav:/zotero/> mkcol SomeCollection
 Creating `SomeCollection': succeeded.
 dav:/zotero/>
</code>
==== Установка клиента Zotero ====
В каталоге ''ZoteroDataServer/misc/'' находится несколько версий клиента Zotero (только в форме дополенений к браузеру Firefox), с «заплатками», позволяющими указать произвольный адрес сервера Zotero Data Server.
"Пропатчить" свежую версию клиента Zotero можно с помощью утилиты patch и файла patch_4.0.20.2.txt:
<code>
unzip zotero-4.0.20.2.xpi -d ./zotero-4.0.20.2-patched
cd zotero-4.0.20.2-patched
patch -p1 < ../patch_4.0.20.2.txt
zip -rq ../zotero-4.0.20.2-patched.xpi *
</code>


Рекомендуется установить версию браузера Firefox», не требующую инсталляции в системе — Firefox Portable (http://portableapps.com/apps/internet/firefox_portable) и уже в нем установите «проопатченную» версию дополнения Zotero. Введите на странице «Синхронизация» адрес вашего сервера и порта (например: http://172.19.1.1:85), имя пользователя и пароль (по умолчанию: testuser/testuser).