nb env update

nb env update memperbarui konfigurasi dari env yang tersimpan. Kamu bisa menggunakannya untuk menyesuaikan alamat API, metode autentikasi, asal source code, path aplikasi lokal, public path, port, parameter database, dan lainnya. Setelah pembaruan selesai, CLI akan otomatis menangani langkah lanjutan yang diperlukan sesuai perubahan tersebut.

Jika kamu tidak memberikan parameter konfigurasi apa pun, CLI tetap akan melakukan sinkronisasi ulang berdasarkan status env saat ini.

Penggunaan

nb env update [name] [flags]

Opsi umum

OpsiTipeDeskripsi
[name]stringNama env terkonfigurasi yang akan diperbarui. Jika dihilangkan, env saat ini yang digunakan
--verbosebooleanMenampilkan progres secara detail

Opsi API dan autentikasi

OpsiTipeDeskripsi
--api-base-url, -ustringURL API NocoBase, termasuk prefix /api
--auth-typestringMetode autentikasi: basic, token, atau oauth
--access-token, --token, -tstringAPI key atau access token yang digunakan untuk autentikasi token. Menyimpannya juga akan mengganti tipe autentikasi menjadi token
--usernamestringUsername yang disimpan untuk autentikasi basic. Gunakan hanya ketika env saat ini sudah memakai basic, atau bersama --auth-type basic

Opsi source dan unduhan

OpsiTipeDeskripsi
--sourcestringSource aplikasi yang tersimpan: docker, git, local, atau npm
--download-version, --versionstringPemilih versi yang tersimpan: tag Docker, versi paket npm, atau Git ref
--docker-registrystringNama registry image Docker, tanpa tag
--docker-platformstringPlatform image Docker: auto, linux/amd64, atau linux/arm64
--git-urlstringURL repository Git
--npm-registrystringRegistry yang dipakai untuk unduhan npm atau Git dan pemasangan dependency
--dev-dependencies / --no-dev-dependenciesbooleanApakah devDependencies perlu dipasang untuk source npm atau Git
--build / --no-buildbooleanApakah build dijalankan otomatis setelah unduhan npm atau Git
--build-dts / --no-build-dtsbooleanApakah file deklarasi TypeScript perlu dibuat saat build

Opsi aplikasi

OpsiTipeDeskripsi
--app-pathstringDirektori aplikasi. Ini sekarang menjadi cara yang direkomendasikan untuk mengelola path aplikasi lokal
--app-public-pathstringPublic path aplikasi (APP_PUBLIC_PATH), seperti / atau /nocobase/
--app-portstringPort HTTP aplikasi
--cdn-base-urlstringURL dasar CDN untuk aset statis sisi klien (CDN_BASE_URL)
--app-keystringKunci aplikasi (APP_KEY)
--timezonestringZona waktu aplikasi (TZ)

Opsi database

OpsiTipeDeskripsi
--builtin-db / --no-builtin-dbbooleanApakah menggunakan database bawaan yang dikelola CLI
--db-dialectstringJenis database: postgres, mysql, mariadb, atau kingbase
--builtin-db-imagestringImage container yang digunakan untuk database bawaan
--db-hoststringHost database
--db-portstringPort database
--db-databasestringNama database
--db-userstringUsername database
--db-passwordstringPassword database
--db-schemastringSchema database. Ini biasanya hanya digunakan oleh PostgreSQL
--db-table-prefixstringPrefix tabel
--db-underscored / --no-db-underscoredbooleanApakah nama tabel dan nama field menggunakan gaya underscore

Pembersihan konfigurasi

OpsiTipeDeskripsi
--unsetstring[]Mengosongkan satu atau beberapa field yang tersimpan berdasarkan nama flag. Kamu bisa mengulang opsi ini atau memberikan daftar yang dipisahkan koma, seperti --unset git-url,username

Catatan

Tip

Jika kamu hanya ingin CLI melakukan sinkronisasi ulang berdasarkan status terbaru dari env saat ini, cukup jalankan nb env update atau nb env update <name> tanpa opsi tambahan.

  • Setelah pembaruan selesai, CLI akan otomatis menangani sinkronisasi lanjutan yang diperlukan berdasarkan perubahan yang dibuat kali ini
  • Opsi lainnya hanya memperbarui konfigurasi env yang tersimpan. Opsi ini tidak otomatis me-restart aplikasi atau mengganti source code lokal maupun image Docker
  • Setelah mengubah pengaturan seperti app-path, app-port, timezone, atau db-*, CLI biasanya akan menyarankan kamu menjalankan nb app restart --env <name>; jika perubahan menyangkut database bawaan yang dikelola CLI, CLI akan menyarankan nb app restart --env <name> --with-db
  • Setelah mengubah pengaturan seperti app-port, app-public-path, atau cdn-base-url yang memengaruhi hasil reverse proxy, jalankan ulang nb proxy nginx generate atau nb proxy caddy generate jika kamu sudah memakai konfigurasi proxy hasil generate
  • Saat memperbarui pengaturan source seperti source, download-version, docker-registry, git-url, atau npm-registry, hanya nilai yang tersimpan yang berubah. Source code lokal, dependency, dan image yang sudah ada tidak diganti secara otomatis
  • --access-token tidak dapat digunakan bersama --auth-type basic atau --auth-type oauth
  • Field yang sama tidak bisa digunakan bersamaan dengan --unset dan nilai eksplisit. Misalnya, jangan gunakan --unset git-url bersama --git-url ...
  • Jika kamu mengganti metode autentikasi menjadi basic atau oauth, atau mengosongkan token, biasanya kamu perlu menjalankan nb env auth <name> setelah itu

Contoh

# Sinkronkan ulang env saat ini berdasarkan status tersimpan terbaru
nb env update

# Sinkronkan ulang env tertentu
nb env update prod

# Perbarui URL API
nb env update prod --api-base-url http://localhost:13000/api

# Perbarui token dan ganti tipe autentikasi menjadi token
nb env update prod --access-token <token>

# Ganti ke autentikasi basic, simpan username, lalu jalankan nb env auth nanti
nb env update prod --auth-type basic --username admin

# Perbarui source dan versi yang tersimpan tanpa langsung mengganti kode lokal
nb env update local --source git --git-url git@github.com:nocobase/nocobase.git --download-version next

# Sesuaikan port aplikasi dan zona waktu, lalu restart nanti
nb env update local --app-port 13080 --timezone Asia/Shanghai

# Sesuaikan public path dan generate ulang proxy setelahnya jika diperlukan
nb env update local --app-public-path /nocobase/

# Simpan URL dasar CDN untuk aset klien
nb env update local --cdn-base-url https://cdn.example.com/nocobase/

# Kosongkan field yang tersimpan
nb env update local --unset git-url --unset username
nb env update local --unset git-url,username

Perintah terkait