slamby api
v1.7.2
Slamby介紹了Slamby Server（API）。構建強大的數據管理服務，存儲和分析您的數據。
查看我們的API文檔。
Slamby API可以在Docker Hub上找到。
由於Slamby API具有依賴性：Elasticsearch，Redis和Nginx（推薦），因此使用Slamby API的最簡單方法是與Docker-Compose一起使用。
我們製作了一個準備好的Docker撰寫文件，以簡化安裝。
在您的計算機上安裝Docker：官方Docker安裝指南
在您的計算機上安裝Docker（至少需要1.9.0）：官方Docker撰寫安裝指南
下載我們的Docker撰寫文件
$ 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/stetup）中打開“設置”頁面，然後遵循訂單
在設置過程中，您需要：
您可以在不構圖的情況下使用Slamby API服務器。但是Slamby API有先決條件。您必須通過環境變量將設置提供給Slamby API服務器（這些都像： SlambyApi__... ）。請注意，如果將其運行在容器中，則必須將環境變量設置為不在主機的容器。如果您使用可以使用的操作系統:在環境變量名稱中，您必須使用的是:而不是__ 。
Slamby API將Elasticsearch用作數據存儲系統。您可以使用自己的實例或群集。推薦版本為2.3。它必須是空的（無索引），建議安裝映射器 - 附加插件。將Elasticsearch URL設置為SlambyApi__ElasticSearch__Uris__0 （例如：http：// elasticsearchserver：9200/）。或者，如果您有一個帶有多個端點的群集，則將所有端點設置為SlambyApi__ElasticSearch__Uris__0 .0 __0， SlambyApi__ElasticSearch__Uris__1 ， SlambyApi__ElasticSearch__Uris__2等。環境變量）。
使用REDIS進行預索引並節省一些指標的SLAMBY API。在SlambyApi__Redis__Configuration __configuration中設置redis連接字符串。
如果需要，您甚至可以禁用Redis的使用情況，將設置設置SlambyApi__Redis__Enabled為false 。 （請注意，在這種情況下，您不能使用某些功能，例如PRC預索引）。
使用dotnet核心和kestrel在引擎蓋下使用SLAMBY API。建議使用頂部的nginx。我們在DockerHub中具有預配置的Nginx圖像。建議使用此功能，但您可以使用自己的NGINX服務器。
在主機計算機上為持久的猛擊API文件創建目錄
從Docker Hub中拉出圖像
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
Slamby API默認使用端口5000，但是您可以將其綁定到Docker主機上想要的任何端口。
您可以按環境變量覆蓋設置。請注意，如果您使用可以使用的操作系統:在環境變量名稱中，您必須使用的是:而不是__ 。
這是最重要的設置列表。您可以在appSettings.json文件中找到所有設置。
SlambyApi__ApiSecret默認值： s3cr3t
這是您的API的秘訣。您必須使用它來驗證您的請求。
SlambyApi__BaseUrlPrefix默認情況下是空的。
如果您使用的是反向代理後面的API，則必須使用此值。因為在這種情況下，主機名不會準確。 API將在請求之後放置HTTP主機。
ElasticSearch__Uris__NUMBER請注意，這是一個數組配置值。因此，您必須將0、1、2 ...而不是數字放置。
有一個默認一個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，則使用核心編號 * 2的API獲得最佳性能。提示：您也可以在每個請求標頭中限制它。在API文檔中檢查它。
SlambyApi__RequestsLimiting__MaxConcurrentRequests默認值： 50
使用此設置，您可以設置最大並發請求號。如果並發請求多於此數字，則API將使用HTTP狀態代碼503（服務不可用）響應。
我們使用GitHub問題來跟踪公共錯誤。請確保您的描述清晰，並有足夠的說明以能夠複製該問題。
請在此處查看我們的貢獻指南
該項目是根據GNU Affero通用公共許可證3.0版獲得許可的。
有關商業用途，請通過[email protected]與我們聯繫併購買商業許可證。
如果您有任何疑問，請訪問我們的社區小組或通過[email protected]向我們寫一封電子郵件
