slamby api
v1.7.2
Slamby memperkenalkan Slamby Server (API). Bangun layanan manajemen data yang kuat, simpan dan analisis data Anda.
Lihat dokumentasi API kami.
API Slamby dapat menemukan di hub Docker.
Karena Slamby API memiliki dependensi: Elasticsearch, Redis dan Nginx (disarankan), cara termudah untuk menggunakan Slamby API adalah dengan komposisi Docker.
Kami membuat file compose Docker yang disiapkan untuk instalasi yang mudah.
Instal Docker di Mesin Anda: Panduan Instalasi Docker Resmi
Instal Docker Compose di Mesin Anda (Minimal 1.9.0 Diperlukan): Panduan Instalasi Kompose Docker Resmi
Unduh file Compose Docker kami
$ 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"
}
Buka halaman Pengaturan di browser (http: // localhost/setup) dan ikuti pesanan
Selama pengaturan yang Anda butuhkan:
Anda dapat menggunakan Slamby API Server tanpa menyusun. Tapi Slamby API memiliki prasyarat. Anda harus memberikan pengaturan ke server API Slamby melalui variabel lingkungan (ini seperti: SlambyApi__... ). Perhatikan bahwa jika Anda menjalankannya dalam wadah, Anda harus mengatur variabel lingkungan ke wadah bukan ke host. Jika Anda menggunakan sistem operasi tempat Anda dapat menggunakan : di nama variabel lingkungan daripada yang harus Anda gunakan : bukan __ .
Slamby API menggunakan Elasticsearch sebagai sistem penyimpanan data. Anda dapat menggunakan instance atau cluster sendiri. Versi yang disarankan adalah 2.3. Itu harus kosong (tidak ada indeks) dan disarankan untuk menginstal plugin mapper-attachments. Atur URL Elasticsearch ke SlambyApi__ElasticSearch__Uris__0 (misalnya: http: // ElasticsearchServer: 9200/). Atau jika Anda memiliki cluster dengan beberapa titik akhir mengatur semua titik akhir ke SlambyApi__ElasticSearch__Uris__0 , SlambyApi__ElasticSearch__Uris__1 , SlambyApi__ElasticSearch__Uris__2 dll. Variabel lingkungan).
Slamby API menggunakan Redis untuk preindexing dan untuk menyimpan beberapa metrik. Atur string koneksi Redis di SlambyApi__Redis__Configuration konfigurasi.
Anda bahkan dapat menonaktifkan penggunaan redis jika Anda mau, atur set SlambyApi__Redis__Enabled menjadi false . (Perhatikan bahwa dalam hal ini, Anda tidak dapat menggunakan beberapa fitur seperti PRC preindexing).
Slamby API Menggunakan Dotnet Core dan Kestrel di bawah kap. Disarankan untuk menggunakan nginx dari atasnya. Kami memiliki gambar Nginx yang telah dikonfigurasi sebelumnya di Dockerhub. Disarankan untuk menggunakan ini tetapi Anda dapat menggunakan server Nginx Anda sendiri.
Buat direktori di komputer host untuk file API Slamby yang persisten
Tarik gambar dari hub Docker
docker pull slamby/slamby.api:1.7.2
Jalankan wadah dengan pengaturan
docker run -d
--name slamby_api
-p 5000:5000
-v /yourDataDirectory:/Slamby
slamby/slamby.api:1.7.2
API Slamby menggunakan port 5000 secara default, tetapi Anda dapat mengikatnya ke port apa pun yang Anda inginkan di host Docker Anda.
Anda dapat mengesampingkan pengaturan dengan variabel lingkungan. Harap dicatat bahwa jika Anda menggunakan sistem operasi tempat Anda dapat menggunakan : di lingkungan variabel lingkungan daripada yang harus Anda gunakan : bukan __ .
Berikut adalah daftar pengaturan terpenting. Anda dapat menemukan semua pengaturan di file appsettings.json.
SlambyApi__ApiSecret Nilai default: s3cr3t
Ini adalah rahasia untuk API Anda. Anda harus menggunakan ini untuk mengotentikasi permintaan Anda.
SlambyApi__BaseUrlPrefixItu kosong secara default.
Jika Anda menggunakan API di belakang proxy terbalik, maka Anda harus menggunakan nilai ini. Karena dalam hal ini, nama host tidak akan akurat. API akan menempatkan host HTTP dari permintaan setelahnya.
ElasticSearch__Uris__NUMBERPerhatikan bahwa ini adalah nilai konfigurasi array. Jadi Anda harus menempatkan 0, 1, 2 ... bukan nomornya.
Ada default One ElasticSearch__Uris__0 , dengan nilai default: 'http://elasticsearch:9200/'
SlambyApi__Serilog__Output Nilai default: /Slamby/Logs
Direktori output file log.
SlambyApi__Serilog__MinimumLevel Nilai default: Information
Level log minimum.
SlambyApi__Redis__Configuration Nilai default: redis,abortConnect=false,ssl=false,syncTimeout=30000
String koneksi untuk server Redis.
SlambyApi__Parallel__ConcurrentTasksLimit Nilai default: 0
Batas maksimum utas yang digunakan di setiap operasi. Jika 0 maka API menggunakan Nomor Inti * 2 untuk kinerja terbaik. Kiat: Anda juga dapat membatasi di setiap header permintaan. Periksa di dokumentasi API.
SlambyApi__RequestsLimiting__MaxConcurrentRequests Nilai default: 50
Dengan pengaturan ini Anda dapat mengatur nomor permintaan bersamaan maksimum. Jika ada permintaan yang lebih bersamaan daripada nomor ini, API akan menanggapi dengan kode status HTTP 503 (Layanan tidak tersedia).
Kami menggunakan masalah GitHub untuk melacak bug publik. Harap pastikan deskripsi Anda jelas dan memiliki instruksi yang cukup untuk dapat mereproduksi masalah ini.
Silakan periksa panduan kontribusi kami di sini
Proyek ini dilisensikan di bawah GNU Affero General Public License versi 3.0.
Untuk penggunaan komersial, silakan hubungi kami di [email protected] dan beli lisensi komersial.
Jika Anda memiliki pertanyaan, silakan kunjungi grup komunitas kami atau tulis email kepada kami di [email protected]
