worldwide open-source software - wiki:farms

advanced

anonymous@undisclosed.example.com (Anonymous) — Wed, 15 Jan 2025 18:55:23 +0000

Расширенные настройки фермы и советы

Большую часть старой документации фермы, которая не охвачена новой документацией фермы, следует добавить сюда.

В следующих разделах предполагается установка, аналогичная той, что описана на фермах.

CLI tools

CLI-инструменты инструменты командной строки вам нужно только задать имя животного в animal переменной окружения. Например, если вы хотите выполнить bin/indexer.php для животного «foo» вы можете использовать animal=foo bin/indexer.php.

Установка значений по умолчанию и ограничение опций

Вы можете добавить дополнительные файлы конфигурации для значений по умолчанию, которые должны использоваться в животных, и для ограничения определенных параметров конфигурации. Если вы добавите следующий код в конец inc/preload.php, основной файл конфигурации фермера будет использоваться как файл по умолчанию для всех животных, а защищенный файл фермера будет использоваться как последний защищенный файл для всех животных, что означает, что животные не смогут изменять эти параметры. Это может быть использовано для отключения определенных параметров, таких как phpok если вы не доверяете администратору животных.

$config_cascade['main']['default'][] = DOKU_INC.'conf/local.php';
$config_cascade['main']['protected'][] = DOKU_INC.'conf/local.protected.php';

Обратите внимание, что эти изменения также влияют на фермера, если к нему есть доступ. Это сломает менеджер конфигурации в фермере, поскольку он предполагает, что все измененные значения являются значениями по умолчанию, и удалит их из конфигурации.

Аналогичные изменения можно использовать для каскада плагинов, чтобы определить набор плагинов, которые включены по умолчанию, или набор плагинов, которые должны или не должны быть включены.

Конечно, вы также можете полностью изменить каскад конфигурации, каскад конфигурации по умолчанию, который используется в фермах, вы можете найти в конце inc/farm.php.

Отключение доступа к фермеру

Если вы хотите отключить доступ к фермеру, вы можете добавить что-то вроде

if (DOKU_FARM == false) { nice_die('Access to the farmer denied'); }

в конце inc/preload.php (после включения farm.php).

Централизованное управление пользователями

Если некоторые или все ваши животные должны иметь общих пользователей, вы можете сделать это не только с помощью той же внешней аутентификации, но и с помощью управления пользователями DokuWiki по умолчанию, указав путь к списку пользователей в том же месте в конце inc/preload.php:

$config_cascade['plainauth.users'] = array(
    'default'   => '/your/path/to/conf/users.auth.php',
);

Если вы хотите сделать это только для некоторых животных, вы, конечно, можете просто добавить условие, основанное на значении DOKU_CONF.

Гибкие настройки на основе .htaccess

На самом деле настройки на основе .htaccess могут быть намного более гибкими, чем настройки, описанные на фермах. Для этих расширенных настроек ваш каталог фермы может и даже должен быть вне корня документов (каталога, доступного из Интернета). Если ваш каталог фермы находится внутри корня документов, вам нужно убедиться, что вы должным образом защищаете каждый каталог данных (например, используя .htaccess, как это делается в обычной настройке DokuWiki), так как в этих расширенных настройках они могут не быть автоматически защищены (зависит от используемых вами условий перезаписи).

Чтобы сделать животных доступными, как в стандартной настройке, вы можете создать второй каталог фермы внутри корня документа с файлом .htaccess и без каталогов животных. Вы также можете добавить RewriteCond операторы, как в примере ниже, чтобы предотвратить циклы перенаправления. Тогда ваши животные могут быть в корневом каталоге домена, т. е. вы можете иметь example.com/animal1/ для животного animal1 и example.com/dokuwiki/ для фермера.

.htaccess

RewriteEngine On
 
# Prevent rewrite loops by making sure that the farmer directory won't be matched
# If you need to enable access to other directories either add them here or try something like
# RewriteCond %{REQUEST_FILENAME}       !-f
# RewriteCond %{REQUEST_FILENAME}       !-d
# but then also the files of your animals (if they should be in this directory) will be accessible
# so make sure you have properly protected them
 
RewriteCond %{REQUEST_URI} !^/?dokuwiki/
RewriteRule ^/?([^/]+)/(.*)  /dokuwiki/$2?animal=$1 [QSA]
RewriteCond %{REQUEST_URI} !^/?dokuwiki$
# RewriteCond %{REQUEST_FILENAME}       !-f # allow files in the root directory (like some index file)
RewriteRule ^/?([^/]+)$      /dokuwiki/?animal=$1 [QSA]
Options +FollowSymLinks

Более одного домена

Если вы можете использовать символические ссылки вы можете легко связать каталог в корневом каталоге документов каждого домена с фермером и указать этот каталог в правилах перезаписи.

Пользовательские пути

Если вы не хотите, чтобы все животные были в одном каталоге, вы можете просто создать файл .htaccess для каждого животного. В этом файле .htaccess вы можете указать имя животного.

.htaccess

RewriteEngine On
 
# Prevent rewrite loops by making sure that the farmer directory won't be matched
# If you need to enable access to other directories either add them here or try something like
# RewriteCond %{REQUEST_FILENAME}       !-f
# RewriteCond %{REQUEST_FILENAME}       !-d
# but then also the files of your animal (if they should be in this directory) will be accessible
# so make sure you have properly protected them
RewriteCond %{REQUEST_URI} !^/?dokuwiki/
RewriteRule ^/?(.*) /dokuwiki/$1?animal=ANIMAL [QSA]
RewriteRule ^/?$ /dokuwiki/?animal=ANIMAL [QSA]
 
Options +FollowSymLinks

Операторы RewriteCond предотвращают циклы перенаправления, когда ваш каталог фермера находится внутри каталога животных. Таким образом, вы также можете поместить животное в корневой каталог домена.

Запуск фермы за обратным прокси-сервером

Это происходит, когда вы настраиваете свою ферму на внутреннем сервере (например http://11.22.33.44) и представляете свои вики-ресурсы миру через фронтенд-сервер Apache (например, http://www.example.com).

Сначала настройте ферму на сервере в соответствии со стандартной документацией.

В моем случае я решил поместить все файлы DokuWiki в одно место, чтобы отделить их от других сайтов, работающих на внутреннем сервере:

/var/www/wikis/ – Корень моей установки DokuWiki.

Итак, моя ферма имеет следующую конфигурацию:

/var/www/wikis/dokuwiki– движок DokuWiki, он должен быть доступен из Интернета
/var/www/wikis/farm– каталог ферм DokuWiki, содержащий всех животных
/var/www/wikis/farm/bear– моя первая вики о медведях

На внутреннем сервере моя вики о медведях (после полной настройки) будет доступна по следующему адресу http://11.22.33.44/wikis/farm/bear

Однако на сервере frontend я хочу представить свою вики по следующему адресу (обратите внимание, что я решил убрать «s» из «wikis» в этом URL ): http://www.example.com/wiki/bear

Используя тип настройки .htaccess, я настроил его /var/www/wikis/farm/.htaccess с помощью следующего кода:

.htaccess

RewriteEngine On
 
RewriteRule ^/?([^/]+)/(.*)  /wikis/dokuwiki/$2?animal=$1 [QSA]
RewriteRule ^/?([^/]+)$      /wikis/dokuwiki/?animal=$1 [QSA]
Options +FollowSymLinks

Затем /var/www/wikis/farm/bear/confя редактирую local.protected.php следующим образом (примечание: здесь используется адрес интерфейса):

local.protected.php

<?php
/**
 * These settings are "protected" and cannot be overwritten
 * by the configuration manager, but need to be edited manually.
 */
 
$conf['savedir'] = DOKU_CONF.'../data';
$conf['updatecheck'] = 0;
// if you're using the .htaccess base setup, set this to your animal's base directory:
$conf['basedir'] = '/wiki/bear/';

Поэтому я использую Apache's mod_proxy и настраиваю конфигурацию в httpd.conf на сервере front-end:

httpd.conf

    <Location /wiki>
      ProxyPass http://11.22.33.44/wikis/farm
      ProxyPassReverse http://11.22.33.44/wikis/farm
    </Location>

Это означает, что все животные на моей ферме всегда будут проходить обратный прокси-сервер с желаемого адреса интерфейса.

Это работает очень хорошо, пока вы не выполните определенные действия (например, вход в систему, выход из системы, сохранение изменений и т. д.). Поскольку движок DokuWiki выполняет перенаправление в этих точках, браузеру конечного пользователя отправляется заголовок HTTP 302, содержащий следующее:

Location: http://11.22.33.44/wiki/bear/doku.php?id=blahblahblah

Конечно, на внутреннем сервере по этому адресу нет страницы, и в результате в браузере пользователя появляется сообщение об ошибке HTTP 404 «Страница не найдена».

Средство — использовать Apache's mod_headers. Мы изменяем наш блок кода в httpd.conf следующим образом:

httpd.conf

    <Location /wiki>
      ProxyPass http://11.22.33.44/wikis/farm
      ProxyPassReverse http://11.22.33.44/wikis/farm
      Header edit Location ^http://11.22.33.44 http://www.example.com
    </Location>

The 'Location' response header is now re-written to the correct address and everything works fine.

example01

anonymous@undisclosed.example.com (Anonymous) — Wed, 15 Jan 2025 18:28:13 +0000

⇐ Вернуться назад

Пример создания вики-фермы

Когда я создал свою первую вики-ферму, это заняло около 5 часов. Следующая, как я ожидаю, будет значительно меньше часа. Поэтому я подумал, что другим будет полезно, если я опубликую свои заметки администратора в публичном месте. Обратите внимание, что мы не рекомендуем это как лучший способ что-то делать, а скорее как пример, который работает для нас.

Эта страница предназначена для дополнения официальной документации farms а не для ее замены. Пожалуйста, прочитайте хотя бы то объяснение перед этим.

Что мы пытаемся сделать

Этот сервер находится в специализированном исследовательском центре, который является частью физического факультета крупного университета. В настоящее время у нас есть 3 профессора, один штатный сотрудник (я) и от 15 до 30 аспирантов и студентов, участвующих в исследовании.

Мы хотим полупубличную вики для центра и частные вики для каждого профессора, чтобы управлять проектами и публиковать результаты перед тем, как они станут общедоступными. Вероятно, мы захотим очень частные вики для работы над грантовыми предложениями или сбора данных для публикации

Среда

Наш веб-сервер работает под управлением Scientific Linux 6.3 (SL6), похожего на CentOS 6.3. Мы используем Apache 2.2.

Наш ИТ-отдел выдал нам один внешний фиксированный IP-адрес и одну запись DNS . Возможно, можно получить дополнительные записи CNAME, которые являются псевдонимами для IP-адреса, чтобы позволить одному серверу размещать несколько сайтов (см. wikipedia's description. Поэтому мы решили использовать метод .htaccess, своего рода.

Мы используем PHP v5.3.3 с Zend Engine v2.3.0.

Обзор процесса

Apache, PHP уже настроен и работает с доверенным сертификатом SSL. Шаги, которые мы собираемся рассмотреть, следующие:

Установите последнюю версию Dokuwiki из tarball. (только обзор)
Настройте базовую вики (только обзор)
Установить ферму
Заблокируйте его для ограниченного доступа

С точки зрения браузера пользователь не может отличить ферму вики от нескольких установок полных или родительских вики. Мы могли бы установить несколько копий всего tarball dokuwiki в отдельные каталоги на веб-сервере, но это значительно усложнило бы текущие задачи по обслуживанию.

Причина создания фермы заключается в том, что только родительская вики должна быть обновлена до новой версии, а плагины должны быть установлены только один раз. Веб-сервер Apache также более эффективен с одной копией программы, но это вторично.

Последняя версия DokuWiki

В целом, я большой поклонник использования предварительно упакованного ПО для каждой ОС . Однако в этом случае пакетное ПО было 2-летней давности, не содержало модуля фермы и разбросало файлы php в /usr/share/dokuwiki, /etc/dokuwiki и бог знает где еще. Теперь, когда у нас есть рабочая установка, мы, вероятно, могли бы работать с пакетом, но это было запутанно.

Руководство по установке довольно простое и ему легко следовать, если вы решите пойти по этому пути.

Настройте базовую вики

В настройке базовой вики нет ничего особенного. В документации это называется «фермер» и является начальной настройкой работающей Dokuwiki, как объясняется в руководстве по установке.

Этот wiki должен быть запущен и запущен, прежде чем мы займемся фермой. Он содержит весь код (файлы PHP), который управляет wiki. Другие wiki в ферме имеют только столько PHP-кода, чтобы отделить их друг от друга.

Установить ферму

Обзор терминологии

The farm metaphor maybe taking things too far but we'll be consistent and try to avoid the common computer documentation foible of mixing our metaphors.

Ферма: Полная установка с одним родительским вики (фермер) и несколькими дочерними вики (животные)
Фермер: Родительская вики, которая содержит большинство файлов PHP, управляющих Dokuwiki. Это также полноценная вики сама по себе. Что важно в настройке, так это то, что мы можем получить доступ как к отдельным модулям, используемым животным (см. ниже), так и к основным модулям, используемым всеми вики.
Директория фермы: Не путать с фермой, это корневой каталог всех дочерних вики. Это просто каталог в веб-пространстве.
Животное : Помните, что разница между дочерней вики (животное) и родительской вики (фермер) заключается в том, какие файлы PHP хранятся в их каталоге. Каждое животное содержит минимальное количество файлов .php, которые используются для настройки dokuwiki, а также каталоги, содержащие все данные для этой вики, в то время как у фермера есть полная установка dokuwiki, которая используется всеми животными, а также его собственные каталоги для данных. Таким образом, только родительской вики нужно установить плагины, и только родительскую вики нужно обновить до новой версии.

Что видит браузер

Наше веб-пространство организовано следующим образом:

http://whatsamatta.edu - домашняя страница
- http://whatsamatta.edu/wiki - Родительская вики с материалами для потребления авторизованными пользователями, фермером.
- http://whatsamatta.edu/einstein - Первая частная вики-статья профессора, посвященная животным (дочерняя вики-статья).
- http://whatsamatta.edu/keppler - Частная вики второго профессора, еще одно животное.

Все остальное http://whatsamatta.edu/somethingElse не зависит от Dokuwiki.

Как организованы наши каталоги

Организация и расположение файлов конфигурации веб-сервера и контента являются, мягко говоря, гибкими. Соглашения значительно различаются, особенно если вы находитесь в общей или размещенной среде. Это описание нашей системы, не путайте его с рекомендацией того, как выглядит или должна выглядеть ваша система.

Конфигурация веб-сервера для этих вики содержится в /etc/httpd/conf.d/dokuwiki.conf. Мы создали этот файл.

Веб-контент находится в /var/www/html, а соответствующие каталоги:

├── wiki                <--The farmer (parent wiki)
│   ├── bin
│   ├── conf
│   ├── data                  <-- These folders are what Dokuwiki uses
│   ├── inc
│   └── lib
└── wikis                     <--The farm (folder with child wikis)
    ├── _animal               <-- template for new child wiki
    ├── kepler                <-- animal (child wiki) #1
    ├── Kepler -> kepler      <--symbolic link for common errors
    ├── einstein              <-- animal #2
    └── Einstein -> einstein  <--symbolic link

Каталог _animal — это шаблон, доступный на странице фермы этот шаблон животных. Он принадлежит пользователю root с привилегиями 600, поэтому он недоступен для веб-сервера. Чтобы подготовить новое животное (дочернюю вики), введите:

cp -r _animal newton
chown -R apache:apache newton
ln -s newton Newton

Символические ссылки — это просто моя любимая мозоль. Я никогда не знаю, как люди будут писать имя с заглавной буквы, это делает newton и Newton похожими.

Для нашей системы каждый файл и каталог, показанные здесь (и их подкаталоги), принадлежат apache:apache и имеют разрешения 640 для файлов и 750 для каталогов. Обратите внимание, что имена пользователей и групп также значительно различаются в зависимости от установки.

Самое интересное: конфигурация

Следующие файлы изменены или созданы:

В каждом животном (дочерняя вики): (/var/www/html/wikis/einstein, /var/www/html/wikis/kepler...)

Редактировать conf/local.protected.php uncomment и установить $conf['basedir']

Например, измените:

   //$conf['basedir'] = '/farm/animal/';

на

  $conf['basedir'] = '/wikis/einstein/';

Я считаю, что завершающий символ / необходим, поэтому будьте осторожны.

Мы также изменили conf/local.php чтобы установить заголовок вики, чтобы помочь отладке, но это можно сделать через веб-интерфейс после того, как все заработает. Если вы хотите сделать это, измените:

  $conf['title'] = 'Animal Wiki Title';

на

  $conf['title'] = 'Albert\'s Wiki';

В каталоге фермера (/var/www/html/wiki)

Чтобы активировать ферму, перейдите в каталог inc в каталоге farmer (родительская вики).

Скопируйте файл preload.php.dist в preload.php. Обратите внимание, если вы решили работать со старой версией Dokuwiki, вам придется загрузить farm.php и preload.php.dist (см. страницу документации по фермам).

Раскомментируйте определение DOKU_FARMDIR и укажите путь. Изменить:

  //if(!defined('DOKU_FARMDIR')) define('DOKU_FARMDIR', '/var/www/farm');

  if(!defined('DOKU_FARMDIR')) define('DOKU_FARMDIR', '/var/www/html/wikis');

Раскомментируйте модуль фермы:

  //include(fullpath(dirname(__FILE__)).'/farm.php');

Конфигурация Apache

Во время установки Dokuwiki мы создали файл конфигурации /etc/httpd/conf.d/dokuwiki.conf с несколькими директивами <Directory>, которые управляют доступом к различным каталогам. (Я ищу ссылку на инструкции о том, как это сделать).

Теперь нам нужно определить псевдонимы, необходимые для сокращения URL-адресов, которые будут вводить наши пользователи, и добавить правила перезаписи.

Псевдонимы

В текущем виде пользователь может ввести URL-адрес, который выглядит так, http://wattsamatta.edu/wikis/einstein чтобы попасть на нужное животное на ферме (дочерняя вики), однако тот факт, что мы решили назвать наши вики-сайты фермы, не имеет значения, поэтому, чтобы сократить его до, http://wattsamata.edu/enistein мы включаем директиву псевдонима для каждой дочерней вики:

  Псевдоним /Эйнштейн /var/www/html/wikis/kepler
  Псевдоним /Кеплер /var/www/html/wikis/kepler

Переписать правила

В документации ферм представлены два различных метода адресации ферм: виртуальные хосты и .htaccess. При использовании метода виртуального хоста (который мы не используем) пользователь вводит URL-адрес вида http://einstein.whatsamatta.edu. При использовании метода .htaccess (описанного ниже) этот URL-адрес будет выглядеть так : . Выбор обычно определяется тем, к каким инструментам у вас есть доступ. Мы выбрали метод .htaccess, потому что нам нелегко добавлять записи CNAME на DNS- http://whatsamatta.edu/einstein. сервер университета.

Это единственная действительно, действительно таинственная и непонятная часть. То, что мы хотим, чтобы наши пользователи делали, это входили http://whatsamatta.edu/einstein, а то, что нужно dokuwiki, больше похоже на то, http://whatsamatta.edu/wiki/doku.php?animal=einstein за исключением, конечно, когда это не домашняя страница вики, тогда uri намного сложнее.

Это делается с помощью правил перезаписи, которые Apache использует для преобразования фактического URL в тот, который нам нужен. Это регулярное выражение (что само по себе плохо) с дополнительными флагами. По большей части вы можете скопировать эти правила с небольшими, очевидными изменениями. Если вы хотите лучше их понять, я нашел этот шведский сайт с хорошим способом поиграться с правилами mod_rewrite, см. http://martinmelin.se/rewrite-rule-tester/ (так скажем, Мартин).

Инструкции фермы делают это с помощью файла .htaccess, но мы предпочитаем помещать их в директиву <Directory>. Оба варианта работают, Apache рекомендует директиву из соображений производительности, но метод .htaccess работает для людей без привилегий root. Добавьте следующее в файл dokuwiki.conf:

  <Directory /var/www/html/wikis>
        AllowOverride All
        Options +FollowSymLinks
 
        RewriteEngine On
 
        RewriteRule ^/?([^/]+)/(.*)  /wiki/$2?animal=$1 [QSA]
        RewriteRule ^/?([^/]+)$      /wiki/?animal=$1 [QSA]
 
  </Directory>

На этом этапе, если никто из нас ничего не упустил, перезапуск веб-сервера создаст рабочую вики-ферму. Введите:

  service httpd restart

затем попробуйте сделать это через браузер.

Удачи.