Added some docs about configuration file

[oss/stilllife.git] / doc / config.txt

diff --git a/doc/config.txt b/doc/config.txt
new file mode 100644 (file)
index 0000000..7b2768f
--- /dev/null
+++ b/doc/config.txt
@@ -0,0 +1,48 @@
+Файл конфигурации форума
+
+Файл имеет имя .forum и размещается в корневой директории форума (там
+же, где список подфорумов верхнего уровня).
+
+Состоит из строк
+
+параметр = значение.
+
+Используются следующие параметры:
+
+templates = имя-директории-на-сервере
+       Место расположения используемого набора шаблонов. Может быть (но не
+       обязано) быть за пределами DocumentRoot.
+
+userdir = имя-директории-на-сервере
+  
+  Место, куда складываются аватары пользователей 
+
+userurl = url
+  
+  Имя под которым эта директория видна по http
+
+passwd = имя-файла-на-сервере
+
+  Место расположения базы информации о пользователях. Должно быть
+  имя файла в недоступной по http директории (за пределами DocumentRoot
+  или в крайнем случае, запрещенной для доступа через .htaccess) к
+  которой cgi-скрипты имеют доступ на запись.
+
+sessions= имя-файла-на-сервере
+
+  База активных пользовательских сессий. Те же требования
+
+authperiod - время жизни пользовательской сессии. 
+               Формат число единица измерения, где единица измерения может быть
+               m (минута)
+               h (час)
+               d (день)
+               M (месяц)
+               y (год). По умолчанию 1M.
+
+renewtime - время автоматического продления сессии. В секундах. 
+       Т.е. если у пользователя осталось меньше чем renewtime секунд до
+       конца жизни его сессии, и он выполнил какую-то операцию, требующую
+       проверки его сессии (постинг комментария, редактирование профиля)
+       его сессия продлевается на authperiod. По умолчанию 86400.
+