slamby api
v1.7.2
O SLAMBY apresenta o servidor Slamby (API). Crie um poderoso serviço de gerenciamento de dados, armazene e analise seus dados.
Confira nossa documentação da API.
A API da Slamby pode encontrar no Hub do Docker.
Como a API da SLAMBY possui dependências: Elasticsearch, Redis e Nginx (recomendado), a maneira mais fácil de usar a API do Slamby é com o Docker-Compompose.
Fizemos um arquivo de composição preparado do Docker para a instalação fácil.
Instale o Docker em sua máquina: Guia de instalação oficial do Docker
Instale o docker compor em sua máquina (mínimo 1.9.0 necessário): Guia de instalação oficial do Docker Compose
Baixe nosso arquivo de composição do 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"
}
Abra a página de configuração em um navegador (http: // localhost/setup) e siga os pedidos
Durante a configuração, você precisa:
Você pode usar o servidor API SLAMBY sem compor. Mas a API da Slamby tem pré -requisitos. Você precisa fornecer as configurações ao servidor API Slamby por meio de variáveis de ambiente (são como: SlambyApi__... ). Observe que, se você executá -lo em um contêiner, precisará definir as variáveis de ambiente para o contêiner não para o host. Se você usar um sistema operacional no qual você pode usar : no ambiente, nomes de variáveis do que você deve usar : em vez de __ .
A API da SLAMBY está usando o Elasticsearch como sistema de armazenamento de dados. Você pode usar uma própria instância ou cluster. A versão recomendada é 2.3. Ele tem que estar vazio (sem índices) e é recomendável instalar o plug-in de ator de mapas. Defina o URL do Elasticsearch para o SlambyApi__ElasticSearch__Uris__0 (por exemplo: http: // elasticsearchServer: 9200/). Ou se você tiver um cluster com vários pontos de extremidade, defina todos os pontos de extremidade para o SlambyApi__ElasticSearch__Uris__0 , SlambyApi__ElasticSearch__Uris__1 , SlambyApi__ElasticSearch__Uris__2 etc. etc. Variáveis de ambiente).
Slamby API usando Redis para pré -indexação e para salvar algumas métricas. Defina a sequência de conexão Redis na SlambyApi__Redis__Configuration .
Você pode até desativar o uso do Redis, se quiser, definir o SlambyApi__Redis__Enabled como false . (Observe que, nesse caso, você não pode usar alguns recursos como a pré -indexação do PRC).
API Slamby usando o núcleo dotnet e o Kestrel sob o capô. Recomenda -se usar um nginx do topo. Temos uma imagem nginx pré -configurada no DockerHub. É recomendável usar isso, mas você pode usar seu próprio servidor nginx.
Crie um diretório no computador host para os arquivos de API persistentes de Slamby
Puxe a imagem do Docker Hub
docker pull slamby/slamby.api:1.7.2
Execute o contêiner com configurações
docker run -d
--name slamby_api
-p 5000:5000
-v /yourDataDirectory:/Slamby
slamby/slamby.api:1.7.2
A API da Slamby está usando a porta 5000 por padrão, mas você pode vinculá -la a qualquer porta que desejar no host do Docker.
Você pode substituir as configurações por variáveis de ambiente. Observe que, se você usar um sistema operacional no qual você pode usar : nos nomes de variáveis do ambiente, você precisa usar : em vez de __ .
Aqui está uma lista das configurações mais importantes. Você pode encontrar toda a configuração no arquivo appSsettings.json.
SlambyApi__ApiSecret Valor padrão: s3cr3t
Este é o segredo da sua API. Você precisa usar isso para autenticar suas solicitações.
SlambyApi__BaseUrlPrefixEstá vazio por padrão.
Se você estiver usando a API por trás de um proxy reverso, precisará usar esse valor. Porque nesse caso, o nome do host não será preciso. A API colocará o host HTTP da solicitação depois dela.
ElasticSearch__Uris__NUMBERObserve que este é um valor de configuração de matriz. Então você tem que colocar 0, 1, 2 ... em vez do número.
Existe um ElasticSearch__Uris__0 um Elastic__uris__0, com valor padrão: 'http://elasticsearch:9200/'
SlambyApi__Serilog__Output Valor padrão: /Slamby/Logs
O diretório de saída dos arquivos de log.
SlambyApi__Serilog__MinimumLevel Valor padrão: Information
O nível mínimo de log.
SlambyApi__Redis__Configuration Valor padrão: redis,abortConnect=false,ssl=false,syncTimeout=30000
A sequência de conexão para o servidor Redis.
SlambyApi__Parallel__ConcurrentTasksLimit Valor padrão: 0
O limite máximo dos encadeamentos usados em cada operação. Se for 0, a API usando o número do núcleo * 2 para obter o melhor desempenho. Dica: você pode limitá -lo em cada cabeçalho de solicitação também. Verifique na documentação da API.
SlambyApi__RequestsLimiting__MaxConcurrentRequests Valor padrão: 50
Com essa configuração, você pode configurar um número máximo de solicitação simultânea. Se houver mais solicitações simultâneas do que esse número, a API responderá ao código de status HTTP 503 (serviço indisponível).
Usamos problemas do GitHub para rastrear bugs públicos. Verifique se sua descrição é clara e possui instruções suficientes para poder reproduzir o problema.
Por favor, verifique nosso guia de contribuição aqui
Este projeto está licenciado sob a licença pública geral da GNU Affero versão 3.0.
Para uso comercial, entre em contato conosco em [email protected] e adquiram licença comercial.
Se você tiver alguma dúvida, visite nosso grupo comunitário ou escreva um email para nós em [email protected]
