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をマシンにインストールします（最低1.9.0が必要）：公式Docker Composeインストールガイド
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には前提条件があります。環境変数を介してSlamby APIサーバーに設定を提供する必要があります（これらは次のようです： SlambyApi__... ）。コンテナで実行する場合、ホストにはなく環境変数をコンテナに設定する必要があることに注意してください。使用できるオペレーティングシステムを使用する場合:環境変数名で使用する必要があります: __の代わりに使用する必要があります。
Slamby APIは、Elasticsearchをデータストレージシステムとして使用しています。独自のインスタンスまたはクラスターを使用できます。推奨バージョンは2.3です。空にする必要があり（インデックスなし）、Mapper-Attachmentsプラグインをインストールすることをお勧めします。 elasticsearch urlをSlambyApi__ElasticSearch__Uris__0に設定します（例：http：// elasticsearchserver：9200/）。または、複数のエンドポイントを備えたクラスターがある場合、すべてのエンドポイントをSlambyApi__ElasticSearch__Uris__0に設定した場合、 SlambyApi__ElasticSearch__Uris__1 Elasticsearch__uris__1、 SlambyApi__ElasticSearch__Uris__2など。環境変数）。
redisを使用して、いくつかのメトリックを保存するためにRedisを使用してSlamby API。 SlambyApi__Redis__ConfigurationでRedis接続文字列を設定します。
必要に応じて、Redisの使用を無効にすることもできます。Slambyapi__redis__ed SlambyApi__Redis__Enabled設定をfalseに設定します。 （その場合、PRC Predexingなどの機能を使用できないことに注意してください）。
Slamby APIは、フードの下でdotnetコアとケストレルを使用しています。その上部のnginxを使用することをお勧めします。 dockerhubには、事前に構成されたnginx画像があります。これを使用することをお勧めしますが、独自のNginxサーバーを使用できます。
永続的なSlamby 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を配置する必要があります。
デフォルトの1つの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 General Public Licenseバージョン3.0の下でライセンスされています。
商業使用については、[email protected]までお問い合わせください。商業ライセンスを購入してください。
ご質問がある場合は、コミュニティグループにアクセスするか、[email protected]でメールを書いてください。
