Kanesh
GitHub ★ Star

Mulai

Memulai

Jalankan Kanesh dengan Docker, klaim instalasi, dan buat workspace pertama.

Setelah mengikuti panduan ini, kamu akan punya Kanesh yang berjalan secara lokal, akun owner, dan koleksi yang bisa diakses lewat API. Image Docker sudah menyertakan Studio dan memakai SQLite secara default.

Paling mudah: setup interaktif

Kamu butuh Docker dengan plugin Compose. Pilih salah satu cara:

Satu perintah. Perintah ini menanyakan database (SQLite, PostgreSQL, atau MySQL), port, dan MCP, lalu menjalankan Kanesh:

curl -fsSL https://YOUR_KANESH_SITE/install.sh | sh

Lewati pertanyaannya dengan flag, misalnya sh -s -- --db postgres --port 8080 --mcp. Jalankan perintah yang sama lagi nanti untuk upgrade.

Satu file compose. Mau lihat setiap barisnya? Unduh docker-compose.yml dan .env, lalu jalankan sendiri; lihat Docker Compose.

Buka http://127.0.0.1:8080 saat script bilang Kanesh sudah siap.

Note: Keduanya memakai image yang dipublikasikan, yang hadir bersama rilis pertama. Sampai saat itu, build image dengan langkah di bawah dan atur KANESH_IMAGE=kanesh di .env.

Sebelum mulai

  • Siapkan Git dan Docker untuk mengambil source dan membangun image.
  • Gunakan browser untuk menyelesaikan setup di Studio.
  • Pertahankan volume kanesh-data agar data tetap tersimpan.

Note: Pakai TLS dan COOKIE_SECURE=true sebelum membuka Kanesh ke luar mesinmu.

1. Build image

Selama preview belum ada image yang dipublikasikan, jadi build dari source:

git clone https://github.com/kaneshdev/kanesh.git
cd kanesh
docker build --tag kanesh .

2. Jalankan

docker run --name kanesh -p 127.0.0.1:8080:8080 -v kanesh-data:/data kanesh

Data tersimpan di volume kanesh-data dan tetap ada setelah restart.

3. Klaim instalasi

Saat pertama jalan, Kanesh menulis token sekali pakai ke /data/claim-token:

docker cp kanesh:/data/claim-token ./claim-token

Buka http://127.0.0.1:8080, tempel tokennya, lalu buat akun owner. Jaga kerahasiaan token ini.

Note: Kamu bisa melewati token dengan mengisi ADMIN_EMAIL dan ADMIN_PASSWORD (atau ADMIN_PASSWORD_FILE) sebelum pertama kali menjalankan Kanesh. Pengaturan ini tidak mereset password owner yang sudah ada saat restart.

4. Buat koleksi

Di Studio, buka Pengaturan → Model data → Buat koleksi. Setiap koleksi langsung tersedia lewat REST dan GraphQL. Halaman Referensi API menampilkan contoh request dan ekspor OpenAPI.

Pemecahan masalah

  • Tidak ada image yang bisa di-pull: belum ada image yang dipublikasikan. Build image lokal kanesh pada langkah 1 sebelum menjalankannya.
  • Setup masih diminta: salin token sekali pakai dari container yang sedang berjalan, lalu selesaikan layar setup. Status readiness berhasil setelah instalasi diklaim.
  • Mengubah password bootstrap tidak berpengaruh: variabel admin hanya membuat owner pada instalasi baru; restart tidak mereset password yang sudah ada.

Langkah berikutnya

Traktir kopi