slamby api
v1.7.2
Slamby представляет Slamby Server (API). Создайте мощную службу управления данными, хранить и проанализировать ваши данные.
Проверьте нашу документацию API.
Slamby API может найти в центре Docker.
Поскольку Slamby API имеет зависимости: Elasticsearch, Redis и Nginx (рекомендуется), самый простой способ использования Slamby API-это Docker-Compose.
Мы сделали подготовленный файл Docker Compose для простой установки.
Установите Docker на вашу машину: официальное руководство по установке Docker
Установите Docker Compose на вашем компьютере (минимум 1.9.0.
Загрузите наш файл Docker Compose
$ curl -L "https://github.com/slamby/slamby-api/releases/download/v1.7.2/docker-compose.yml" > docker-compose.yml
$ docker-compose -p slamby up -d
$ curl localhost
{
"Name": "Slamby.API",
"Version": "1.7.2",
"InstanceId": "817021ac-cc23-4473-b203-5083c3e7e00e",
"Information": "https://developers.slamby.com"
}
Откройте страницу настройки в браузере (http: // localhost/setup) и следуйте заказам
Во время установки вам нужно:
Вы можете использовать Slamby API -сервер без сочинения. Но Slamby API имеет предпосылки. Вы должны дать настройки серверу API Slamby через переменные среды (это похоже на: SlambyApi__... ). Обратите внимание, что если вы запустите его в контейнере, вам нужно установить переменные среды в контейнер, а не на хост. Если вы используете операционную систему, в которой вы можете использовать : в именах переменных среды, чем вы должны использовать : вместо __ .
Slamby API использует Elasticsearch в качестве системы хранения данных. Вы можете использовать собственный экземпляр или кластер. Рекомендуемая версия составляет 2,3. Он должен быть пустым (без индексов), и рекомендуется установить плагин Mapper-Attachments. Установите URL Elasticsearch на SlambyApi__ElasticSearch__Uris__0 (например: http: // elasticsearchserver: 9200/). Или, если у вас есть кластер с несколькими конечными точками, установите все конечные точки SlambyApi__ElasticSearch__Uris__0 , SlambyApi__ElasticSearch__Uris__1 , SlambyApi__ElasticSearch__Uris__2 и т. Д. Переменные среды).
Slamby API с использованием REDIS для предпринята и для сохранения некоторых метрик. Установите строку подключения Redis в SlambyApi__Redis__Configuration .
Вы даже можете отключить использование Redis, если хотите, установите Set SlambyApi__Redis__Enabled to false . (Обратите внимание, что в этом случае вы не можете использовать некоторые функции, такие как PRC Preindexing).
Slamby API с использованием Dotnet Core и Kestrel под капотом. Рекомендуется использовать nginx вершины. У нас есть предварительно настроенное изображение Nginx в Dockerhub. Рекомендуется использовать это, но вы можете использовать свой собственный сервер Nginx.
Создайте каталог на хост -компьютере для постоянных файлов API Slamby
Вытащите изображение из Hub Docker
docker pull slamby/slamby.api:1.7.2
Запустите контейнер с настройками
docker run -d
--name slamby_api
-p 5000:5000
-v /yourDataDirectory:/Slamby
slamby/slamby.api:1.7.2
API Slamby использует порт 5000 по умолчанию, но вы можете связать его с любым портом, который вы хотите на своем хосте Docker.
Вы можете переопределить настройки с помощью переменных среды. Обратите внимание, что если вы используете операционную систему, в которой вы можете использовать : в именах переменных среды, чем вы должны использовать : вместо __ .
Вот список самых важных настройки. Вы можете найти все настройки в файле appsettings.json.
SlambyApi__ApiSecret Значение по умолчанию: s3cr3t
Это секрет для вашего API. Вы должны использовать это для аутентификации ваших запросов.
SlambyApi__BaseUrlPrefixПо умолчанию это пусто.
Если вы используете API за обратным прокси, то вы должны использовать это значение. Потому что в этом случае имя хоста не будет точным. API поставит HTTP -хост запроса после него.
ElasticSearch__Uris__NUMBERОбратите внимание, что это значение конфигурации массива. Таким образом, вы должны положить 0, 1, 2 ... вместо числа.
Существует по умолчанию One ElasticSearch__Uris__0 , со значением по умолчанию: 'http://elasticsearch:9200/'
SlambyApi__Serilog__Output Значение по умолчанию: /Slamby/Logs
Выводный каталог файлов журнала.
SlambyApi__Serilog__MinimumLevel Значение по умолчанию: Information
Минимальный уровень журнала.
SlambyApi__Redis__Configuration Значение по умолчанию: redis,abortConnect=false,ssl=false,syncTimeout=30000
Строка подключения для сервера Redis.
SlambyApi__Parallel__ConcurrentTasksLimit Значение по умолчанию: 0
Максимальный предел используемых потоков в каждой операции. Если это 0, то API с использованием номера ядра * 2 для лучшей производительности. Совет: вы можете ограничить его в каждом заголовке запроса. Проверьте это в документации API.
SlambyApi__RequestsLimiting__MaxConcurrentRequests Значение по умолчанию: 50
С помощью этой настройки вы можете настроить максимальный номер параллельного запроса. Если есть больше параллельных запросов, чем этот номер, API будет отвечать с кодом состояния HTTP 503 (служба недоступна).
Мы используем проблемы GitHub для отслеживания публичных ошибок. Пожалуйста, убедитесь, что ваше описание является ясным и имеет достаточные инструкции, чтобы иметь возможность воспроизводить проблему.
Пожалуйста, проверьте наше руководство по взносу здесь
Этот проект лицензирован в соответствии с общей публичной лицензией GNU Affero версию 3.0.
Для коммерческого использования, пожалуйста, свяжитесь с нами по адресу [email protected] и приобретите коммерческую лицензию.
Если у вас есть какие -либо вопросы, посетите нашу группу сообщества или напишите нам по электронной почте по адресу [email protected]
