Initial Home page

Home.md

@@ -0,0 +1,49 @@
+Базовая информация
+
+Интеграционный микрофреймворк для использования на устаревших платформах (php <= 5.2.17), либо, в случае отсутствия готового модуля для конкретной CMS.
+
+###Установка
+
+* Распаковать директорию retailcrm в корень проекта
+* На основе файла data/config/settings-dist.ini создать конфигурационный файл data/config/settings.ini
+* Создать необходимые sql файлы, файлы с критериями поиска писем и их обработчки (в случае их отсутствия скрипт даст подсказку)
+
+###Настройка
+
+Скрипт выполняет определенные действия в зависимости от переданных параметров. Перечень параметров можно увидеть, запустив скрипт без них:
+
+```bash
+php app.php
+```
+Обмен работает через вызов скрипта по cron, в частности производится:
+
+* Выгрузка новых заказов из магазина в CRM
+* Выгрузка новых клиентов из магазина в CRM
+* Получение изменений из CRM и запись их в БД сайта
+* Выгрузка каталога товаров в ICML файл
+* Выгрузка справочников (типы и службы доставки, типы и статусы оплат, статусы заказов)
+
+Дополнительно можно выполнять:
+
+* Выгрузку заказов из почты
+* Создание дампа БД
+* Миграцию данных из amoCRM в RetailCRM
+
+Для этого необходимо создать следующие записи вида:
+
+```bash
+*/5 * * * * /path/to/php /path/to/retailcrm/app.php -e orders -l 
+*/25 * * * * /path/to/php /path/to/retailcrm/app.php -e customers -l
+*/15 * * * * /path/to/php /path/to/retailcrm/app.php -e history
+* */6  * * * /path/to/php /path/to/retailcrm/app.php -e icml
+* 3  * * * /path/to/php /path/to/retailcrm/app.php -e references -r delivery-types
+*/5 * * * * /path/to/php /path/to/retailcrm/app.php -e mail -m mail@example.com
+```
+
+В случае, если для консольного окружения нет отдельного php.ini (чаще всего на FreeBSD), а подключение модулей (mysql.so, dom.so, xmlwriter.so) выполняется отельно, необходимо при запуске скрипта явно указать путь к php.ini, можно к тому, который используется при вызове php через libapache-mod-php (путь к нему покажет phpinfo()):
+
+```bash
+*/5 * * * * /path/to/php -c /path/to/php.ini /path/to/retailcrm/app.php -e orders -l
+*/15 * * * * /path/to/php -c /path/to/php.ini /path/to/retailcrm/app.php -e history -h orders
+* */6  * * * /path/to/php -c /path/to/php.ini /path/to/retailcrm/app.php -e icml
+```