Konfigurasi Lingkungan Tingkat Proyek dengan File .servbay.config

Ringkasan

ServBay adalah alat lingkungan pengembangan web lokal yang kuat, memungkinkan pengembang mengonfigurasi lingkungan runtime secara terpisah untuk setiap proyek. Fitur inti ini berpusat pada dukungan pembuatan file bernama .servbay.config di setiap direktori proyek.

Dengan menggunakan file .servbay.config, Anda dapat dengan mudah menetapkan versi PHP, Node.js, Python, Go, Java, dan bahasa lain yang dibutuhkan oleh proyek tertentu, sekaligus mengatur pengelola paket Node.js seperti NPM dan Yarn—termasuk menentukan registry dan direktori cache-nya. Kontrol tingkat proyek yang detail ini sangat meningkatkan efisiensi serta kenyamanan pengembangan, memastikan setiap proyek berjalan stabil pada lingkungan yang spesifik dan menghindari konflik versi.

Cara Kerja File .servbay.config

Saat ServBay memulai atau memuat ulang situs, ia akan memeriksa apakah ada file .servbay.config di direktori root situs. Jika file tersebut ada, ServBay akan membaca pengaturannya dan menerapkannya ke lingkungan runtime situs tersebut. Konfigurasi tingkat proyek ini akan menimpa pengaturan global yang sejenis pada ServBay. Jika file .servbay.config tidak ditemukan, atau suatu pengaturan tidak dicantumkan dalam file, ServBay akan menggunakan pengaturan global sebagai default.

Mekanisme ini memungkinkan Anda berpindah antar proyek dengan mudah dan mulus, sebab setiap proyek membawa konfigurasi lingkungannya sendiri.

Cara Membuat dan Mengatur .servbay.config

Membuat dan mengatur file .servbay.config sangatlah mudah.

Lokasi File

Buat file bernama .servbay.config di direktori root proyek Anda. Direktori root proyek biasanya berada di jalur penyimpanan situs ServBay, misalnya /Applications/ServBay/www/nama-proyek-anda/.

Sintaks Konfigurasi

File .servbay.config menggunakan format sederhana KEY=VALUE untuk setiap baris konfigurasi. Anda bisa menambahkan komentar untuk memperjelas konfigurasi dengan tanda # di awal baris.

Contoh Opsi Konfigurasi

Berikut adalah contoh file .servbay.config yang menampilkan cara mengatur berbagai versi lingkungan dan pengelola paket:

# Contoh file .servbay.config

# Menentukan versi PHP yang digunakan. Pastikan versi ini sudah terpasang di ServBay.
PHP_VERSION=8.5

# Menentukan versi Node.js yang digunakan. Pastikan versi ini sudah terpasang di ServBay.
NODE_VERSION=20

# Mengatur alamat registry mirror Yarn untuk mempercepat pengunduhan dependensi.
YARN_CONFIG_REGISTRY=https://npmreg.proxy.ustclug.org/

# Mengatur alamat registry mirror NPM untuk mempercepat pengunduhan dependensi.
NPM_CONFIG_REGISTRY=https://npmreg.proxy.ustclug.org/

# Menentukan direktori cache lokal untuk NPM. Catatan: Jalur ini relatif terhadap direktori instalasi ServBay.
NPM_CONFIG_CACHE=/Applications/ServBay/tmp/npm/cache

# Menentukan direktori cache lokal untuk Yarn. Catatan: Jalur ini relatif terhadap direktori instalasi ServBay.
YARN_CONFIG_CACHE=/Applications/ServBay/tmp/yarn/cache

# Menentukan versi Ruby yang digunakan. Pastikan versi ini sudah terpasang di ServBay.
RUBY_VERSION=2.7

# Menentukan versi Java (OpenJDK) yang digunakan. Pastikan versi ini sudah terpasang di ServBay.
JAVA_VERSION=21

# Menentukan versi Python yang digunakan. Pastikan versi ini sudah terpasang di ServBay.
PYTHON_VERSION=3.11

# Menentukan versi .NET yang digunakan. Pastikan versi ini sudah terpasang di ServBay.
DOTNET_VERSION=5.0

# Menentukan versi Go yang digunakan. Pastikan versi ini sudah terpasang di ServBay.
GO_VERSION=1.12

# Mengatur proxy modul Go untuk mempercepat pengunduhan modul.
GOPROXY=https://goproxy.cn,direct

Harap Diperhatikan: Nomor versi pada contoh (PHP_VERSION=8.5, NODE_VERSION=20, dan sebagainya) hanya untuk tujuan demonstrasi. Saat penggunaan nyata, pastikan Anda menuliskan versi sesuai kebutuhan proyek maupun berdasarkan versi yang telah dipasang dan didukung oleh ServBay. Jika versi yang ditetapkan belum diinstal, ServBay kemungkinan akan menggunakan versi default atau menampilkan pesan error.

Jenis Opsi Konfigurasi yang Didukung

Berdasarkan contoh di atas, file .servbay.config mendukung tipe konfigurasi utama berikut:

1. Penetapan Versi Lingkungan:

   • PHP_VERSION: Tentukan versi PHP.
   • NODE_VERSION: Tentukan versi Node.js.
   • RUBY_VERSION: Tentukan versi Ruby.
   • JAVA_VERSION: Tentukan versi Java (OpenJDK).
   • PYTHON_VERSION: Tentukan versi Python.
   • DOTNET_VERSION: Tentukan versi .NET.
   • GO_VERSION: Tentukan versi Go.
   • (Silakan cek dokumentasi ServBay atau tampilan aplikasi untuk melihat semua tipe lingkungan yang didukung beserta nama variabel konfigurasinya.)

2. Konfigurasi Pengelola Paket (Node.js):

   • YARN_CONFIG_REGISTRY: Alamat registry mirror Yarn.
   • NPM_CONFIG_REGISTRY: Alamat registry mirror NPM.
   • NPM_CONFIG_CACHE: Jalur direktori cache lokal NPM.
   • YARN_CONFIG_CACHE: Jalur direktori cache lokal Yarn.

3. Konfigurasi Proxy Modul Go:

   • GOPROXY: Alamat server proxy modul Go.

Opsi-opsi konfigurasi ini memberi Anda kontrol penuh untuk mengatur lingkungan independen pada setiap proyek, tanpa mengganggu proyek lainnya.

Penerapan dan Verifikasi

Setelah mengatur file .servbay.config, pastikan proyek Anda sudah dimuat di ServBay (artinya, proyek Anda tampil dalam daftar "Situs" di aplikasi ServBay). ServBay akan membaca file konfigurasi saat memuat atau memuat ulang situs.

Untuk memastikan konfigurasi sudah diterapkan, Anda dapat memverifikasinya dengan cara berikut:

1. Lihat Melalui Tampilan Aplikasi ServBay: ServBay kemungkinan akan menampilkan versi lingkungan yang saat ini diterapkan untuk proyek Anda di halaman detail situs atau antarmuka terkait.

2. Verifikasi Melalui Command Line: Buka fungsi Terminal pada ServBay, lalu pindah direktori ke root proyek Anda. Jalankan perintah pemeriksaan versi berikut:

   • Cek versi PHP: php -v
   • Cek versi Node.js: node -v
   • Cek versi Yarn: yarn -v
   • Cek versi NPM: npm -v
   • Cek versi Python: python -V atau python3 -V
   • Cek versi Go: go version
   • Cek versi Java: java -version
   • Cek versi .NET: dotnet --version
   • Cek versi Ruby: ruby -v Pastikan output versi sudah sama persis dengan yang Anda tetapkan dalam file .servbay.config.

3. Verifikasi Melalui Halaman Web (untuk PHP): Buat file PHP sederhana di root proyek Anda (misal bernama info.php), dengan isi <?php phpinfo(); ?>. Akses file tersebut lewat browser (misal http://your-project.servbay.demo/info.php), lalu cari versi PHP di tampilan phpinfo untuk memastikan sudah sesuai.

Gambar di bawah ini mungkin menunjukkan contoh pada antarmuka ServBay yang menampilkan hasil konfigurasi tingkat proyek yang telah diterapkan:

(Silakan cek hasil tampilan aplikasi ServBay secara langsung untuk mengetahui detail implementasi pengaturan proyek Anda.)

Hal-hal yang Perlu Diperhatikan

• Nama file .servbay.config harus persis benar, tanpa salah eja.
• File harus ditempatkan di direktori root proyek.
• Versi yang ditentukan pada file harus sudah terpasang dan didukung oleh ServBay.
• Setiap baris konfigurasi menggunakan format KEY=VALUE dan dipisah baris baru.
• Kesalahan sintaks dapat menyebabkan file diabaikan atau hanya sebagian konfigurasi yang diterapkan.
• Pengaturan pada .servbay.config akan menimpa pengaturan global ServBay dan hanya berlaku untuk proyek terkait.

Pertanyaan Umum (FAQ)

T: Bagaimana jika di direktori root proyek saya tidak ada file .servbay.config?

J: Jika file tidak ditemukan, ServBay akan menggunakan pengaturan lingkungan global yang Anda atur melalui aplikasi untuk menjalankan proyek Anda.

T: Apa yang terjadi jika saya menetapkan versi yang belum terinstal pada ServBay di file .servbay.config?

J: ServBay akan menampilkan notifikasi error. Perilaku pastinya tergantung versi dan pengaturan ServBay. Agar versi yang Anda tentukan benar-benar diterapkan, pastikan terlebih dahulu versi lingkungan yang dibutuhkan sudah terpasang lewat aplikasi ServBay.

T: Setelah mengubah file .servbay.config, apakah saya harus me-restart ServBay?

J: Biasanya, setelah melakukan perubahan pada file .servbay.config, cukup dengan memuat ulang atau menghentikan lalu mengaktifkan kembali situs terkait di aplikasi ServBay. Tidak perlu keluar atau me-restart aplikasi sepenuhnya.

T: Apakah konfigurasi pada .servbay.config akan memengaruhi proyek saya yang lain?

J: Tidak akan. File .servbay.config hanyalah pengaturan tingkat proyek, jadi hanya berlaku pada direktori website ServBay tempat file itu berada.

Kesimpulan

Dengan memanfaatkan file .servbay.config, ServBay memberikan pengembang kekuatan manajemen lingkungan tingkat proyek yang sangat fleksibel. Baik Anda memelihara proyek warisan yang memerlukan lingkungan versi lama, maupun mengembangkan proyek baru menggunakan teknologi terkini, Anda bisa dengan cepat beralih dan mengisolasi lingkungan setiap proyek hanya dengan mengatur file ini. Ini sangat meningkatkan fleksibilitas dan efisiensi lingkungan pengembangan lokal Anda. Manfaatkan fitur ini untuk membuat alur kerja pengembangan Anda menjadi lebih lancar dan produktif.