## README_Linux.MD

# Сервис для сканирования документов c помощью трехдиапазонных сканеров SmartEngines MSS REST Service

## Установка

Для того, чтобы установить сервис, запустите скрипт install.sh с правами администратора. По дефолту сервис устанавливается по пути

    /opt/mss_rest

Это поведение можно изменить, задав опцию -p

## Настройка

Все основные настройки сервиса содержатся в файле config.json, находящимся в папке установки. В конфигурационном файле задаются IP-адрес, порт и другие настройки сервиса, в том числе путь к директории для логирования работы. По умолчанию для логирования используется папка logs, находящаяся по пути установки сервиса. Для применения настроек необходимо перезапустить сервис.

## Первый запуск

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

Для того, чтобы ознакомиться с API сервиса, наберите в браузере http://localhost:12345/doc/ (здесь указаны адрес и порт по умолчанию). также полезные ссылки для ознакомления с сервисом:

Resource | Method | Available endpoints
--- | --- | ---
Diagnostics | GET | `/diagnostics`
Help | GET | `/help`
Version | GET | `/version`
Documentation | GET | `/doc`

## Обработка ошибок

В случае, если что-то пошло не так, сервер возвращает ошибку. В таблице перечислены возможные коды ошибок:

    200 - OK
    400 - Bad Request
    500 - Server Error. Something went wrong