Allow to have multi-leveled module settings.

[stg.git] / doc / help / ch10.xml

diff --git a/doc/help/ch10.xml b/doc/help/ch10.xml
index ab5c70272d61a670927da4db52e8ebb181592e29..c62cc05c1317e47983e8c6953410460d9640d89e 100644 (file)
--- a/doc/help/ch10.xml
+++ b/doc/help/ch10.xml
@@ -1,5 +1,62 @@
 <chapter xml:id="ch10">
 <chapter xml:id="ch10">

-    <title>Приложение А: конвертация БД</title>
-    <para>Для преобразования базы между любыми двумя модулями хранилища используется утилита convertor (исходный код утилиты находится в каталоге projects/convertor стандартной поставки системы). Утилита работает из каталога сборки без установки в ОС. Для сборки утилиты необходимо запустить скрипт ./build.</para>
-    <para>При запуске утилиты в качестве параметра можно передать путь к конфигурационному файлу. По умолчанию будет использован файл convertor.conf из каталога сборки. Конфигурационный файл имеет такой-же формат, что и конфигурационный файл stargazer. Глобальный параметр ModulesPath указывает местонахождение модулей хранилища. Далее следуют две секции: &lt;SourceStoreModule&gt; и &lt;DestStoreModule&gt;. Они описывают, соответственно, источник данных и их приемник. Так, например, для переноса всей информации из БД на основе файлов в БД Firebird необходимо в первой секции прописать параметры файлового хранилища, а во второй — хранилища Firebird.</para>
-</chapter>
+       <title>Приложение А: конвертация БД</title>
+       <para>Для преобразования базы между любыми двумя модулями хранилища используется утилита convertor (исходный код утилиты находится в каталоге projects/convertor стандартной поставки системы). Утилита работает из каталога сборки без установки в ОС. Для сборки утилиты необходимо запустить скрипт ./build. </para>
+       <para>При запуске утилиты в качестве параметра можно передать путь к конфигурационному файлу. По умолчанию будет использован файл convertor.conf из каталога сборки. Конфигурационный файл имеет такой-же формат, что и конфигурационный файл stargazer. Глобальный параметр ModulesPath указывает местонахождение модулей хранилища. Далее следуют две секции: &lt;SourceStoreModule&gt; и &lt;DestStoreModule&gt;. Они описывают, соответственно, источник данных и их приемник. Так, например, для переноса всей информации из БД на основе файлов в БД Firebird необходимо в первой секции прописать параметры файлового хранилища, а во второй — хранилища Firebird.</para>
+       <para>Пример файла конфигурации:</para>
+<programlisting linenumbering="unnumbered">
+# Путь к директории, в которой находятся модули сервера
+ModulesPath = ../stargazer/modules
+
+###################################################################
+# Store module
+# Настройки плагина работающего с БД сервера
+
+# Второй параметр - это имя модуля без mod_ в начале и .so в конце
+# Т.е. полное имя модуля mod_store_files.so
+&lt;SourceStoreModule store_files&gt;
+
+    # Рабочая директория сервера, тут содержатся данные о тарифах, пользователях,
+    # администраторах и т.д.
+    WorkDir = /var/stg-test
+    
+    
+    # Владелец, группа и права доступа на файлы статистики (stat) пользователя
+    ConfOwner = root
+    ConfGroup = wheel
+    ConfMode = 600
+    
+    
+    # Владелец, группа и права доступа на файлы конфигурации (conf) пользователя
+    StatOwner = root
+    StatGroup = wheel
+    StatMode = 640
+    
+    # Владелец, группа и права доступа на лог-файлы (log) пользователя
+    UserLogOwner = root
+    UserLogGroup = wheel
+    UserLogMode = 640
+    
+&lt;/SourceStoreModule&gt;
+    
+&lt;DestStoreModule store_firebird&gt;
+    server = localhost
+    database = /var/stg/stargazer.fdb
+    user = stg
+    password = 123456
+&lt;/DestStoreModule&gt;
+
+#&lt;DestStoreModule store_mysql&gt;
+#    # Имя пользователя БД
+#    dbuser = stg
+#
+#    # Пароль пользователя БД
+#    rootdbpass = 123456
+#
+#    # Имя БД на сервере
+#    dbname = stg
+#
+#    # Адрес сервера БД
+#    dbhost = localhost
+#&lt;/DestStoreModule&gt;              
+</programlisting>
+</chapter>
\ No newline at end of file