slamby api

슬램 비 API

Slamby는 Slamby Server (API)를 소개합니다. 강력한 데이터 관리 서비스를 구축하고 데이터를 저장 및 분석하십시오.

제품 문서

API 문서를 확인하십시오.

Docker와의 설치

Slamby API는 Docker Hub에서 찾을 수 있습니다.

Docker Compose와 함께 (권장)

Slamby API에는 Elasticsearch, Redis 및 Nginx (권장)의 종속성이 있기 때문에 Slamby API를 사용하는 가장 쉬운 방법은 Docker-Compose입니다.

쉽게 설치하기 위해 준비된 Docker Compose 파일을 만들었습니다.

단계

1. 기계에 Docker를 설치하십시오 : 공식 Docker 설치 안내서

2. 기계에 Docker Compose 설치 (최소 1.9.0 필수) : 공식 Docker Compose 설치 안내서

3. Docker Compose 파일을 다운로드하십시오

 $ curl -L "https://github.com/slamby/slamby-api/releases/download/v1.7.2/docker-compose.yml" > docker-compose.yml

4. 컨테이너를 작성하십시오 (Compose 파일 옆에 실행)

 $ docker-compose -p slamby up -d

5. 서버가 설치되었습니다. 올바르게 작동하는지 확인하십시오

 $ curl localhost

{
  "Name": "Slamby.API",
  "Version": "1.7.2",
  "InstanceId": "817021ac-cc23-4473-b203-5083c3e7e00e",
  "Information": "https://developers.slamby.com"
}

6. 브라우저에서 설정 페이지를 열고 (http : // localhost/setup) 주문을 따르십시오.

   설정하는 동안 다음을 필요로합니다.

   • 미끄러운 라이센스를 요청하고
   • Slamby API 라이센스를 복사하고
   • Slamby API의 비밀 (비밀번호)을 설정하십시오

Docker와 함께 (고급)

작곡없이 Slamby API 서버를 사용할 수 있습니다. 그러나 Slamby API에는 전제 조건이 있습니다. 환경 변수를 통해 Slamby API 서버 설정을 제공해야합니다 ( SlambyApi__... ). 컨테이너로 실행하면 환경 변수를 호스트가 아닌 컨테이너로 설정해야합니다. 사용할 수있는 운영 체제를 사용하는 경우 : 환경에서 사용해야하는 것보다 : __ 대신 사용해야합니다.

전제 조건

Elasticsearch

Slamby API는 ElasticSearch를 데이터 저장 시스템으로 사용하고 있습니다. 자체 인스턴스 또는 클러스터를 사용할 수 있습니다. 권장 버전은 2.3입니다. 비어 있어야하며 (지수 없음) Mapper-Attachments 플러그인을 설치하는 것이 좋습니다. Elasticsearch URL을 SlambyApi__ElasticSearch__Uris__0 으로 설정하십시오 (예 : http : // elasticsearchserver : 9200/). 또는 여러 엔드 포인트가있는 클러스터가있는 경우 모든 엔드 포인트를 SlambyApi__ElasticSearch__Uris__0 , SlambyApi__ElasticSearch__Uris__1 , SlambyApi__ElasticSearch__Uris__2 등으로 설정합니다. 환경 변수 등).

레 디스

Slamby API는 사전 인덱싱 및 일부 메트릭을 저장하기 위해 Redis를 사용합니다. SlambyApi__Redis__Configuration 에서 Redis 연결 문자열을 설정하십시오.
원하는 경우 redis의 사용을 비활성화 할 수도 있고, 설정 세트 SlambyApi__Redis__Enabled false 로 설정하십시오. (이 경우 PRC preindexing과 같은 일부 기능을 사용할 수 없습니다).

nginx

Dotnet Core와 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 호스트에게 요청 후에 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이라면 최상의 성능을 위해 코어 번호 * 2를 사용하는 API. 팁 : 각 요청 헤더에서도 제한 할 수도 있습니다. API 문서에서 확인하십시오.

SlambyApi__RequestsLimiting__MaxConcurrentRequests

기본값 : 50

이 설정을 사용하면 최대 동시 요청 번호를 설정할 수 있습니다. 이 숫자보다 동시 요청이있는 경우 API는 HTTP 상태 코드 503 (서비스를 사용할 수 없음)으로 응답합니다.

문제

우리는 GitHub 문제를 사용하여 공개 버그를 추적합니다. 설명이 명확하고 문제를 재현 할 수있는 충분한 지침이 있는지 확인하십시오.

기여

여기에서 기여 가이드를 확인하십시오

특허

이 프로젝트는 GNU Affero General Public License 버전 3.0에 따라 라이센스가 부여됩니다.

상업용 용도로 [email protected]으로 문의하고 상업 라이센스를 구매하십시오.

연락하다

궁금한 점이 있으시면 커뮤니티 그룹을 방문하거나 [email protected]으로 이메일을 작성하십시오.