diff --git a/Lenvi.yaml b/Lenvi.yaml index ed2133d..821b54e 100644 --- a/Lenvi.yaml +++ b/Lenvi.yaml @@ -2,45 +2,70 @@ # Lenvi: Central Configuration for Your Development Environment # ------------------------------------------------------------------ -# Optional developer utilities +# ---------------------------------------------------------------------------------------- +# 🔧 CONFIGURATION GUIDELINES + +# utilities: +# phpmyadmin: +# enabled: false +# domain: "pma.lenvi.local" # Local domain (can be customized) +# php_version: "8.2" # Must match one of your project's PHP versions +# redis: +# enabled: false + +# db_engine: +# Choose between mariadb, mysql, or postgresql. Lenvi will install and manage the correct service. + +# db_credentials: +# Used for all auto-provisioned databases. + +# sites: +# A list of all your projects. +# - domain: Local domain to access via browser. +# project_root: Base project directory (where .git or composer.json is). +# document_root: Public web directory served by Nginx (e.g., /public). +# php_version: PHP version for this project. +# database: (Optional) Database name to create for this project. + +# ---------------------------------------------------------------------------------------- + +# 🔌 Utilities utilities: phpmyadmin: enabled: false - domain: "pma.lenvi.local" # Or whatever you prefer - php_version: "8.2" # This must be one of the php version/s you set on your sites/projects + domain: "pma.lenvi.local" + php_version: "8.3" redis: enabled: false -# 1. Set the global database engine. -db_engine: "mariadb" # mariadb, mysql or postgresql +# 🛢️ Database Engine +db_engine: "mariadb" -# 2. Define the global database credentials. +# 🔐 Database Credentials db_credentials: user: "Lenvi" password: "secret" -# 3. Define all your web sites below. -# WSL users: Ensure these paths are correct for your WSL environment. -# If your project directory is on windows filesystem use /mnt/c i.e., /mnt/c/Users/YourUser/projects/laravel -# project_root -> root directory of your project -# document_root -> directory where your index.php lives +# 🌐 Project Sites + +# WSL USERS: Ensure these paths are correct. +# If using the Windows filesystem (e.g., /mnt/c/Users/...), expect slower performance. +# For *blazing fast* performance, place your projects inside the WSL filesystem (e.g., `/home/user`). sites: - # Example for a standard Laravel project + - domain: mylaravelapp.local project_root: /home/lenvi/projects/laravel document_root: /home/lenvi/projects/laravel/public php_version: "8.2" database: "laravel_db" - # Example for a legacy project or a non-Laravel PHP project - domain: mylegacyapp.local project_root: /home/lenvi/projects/legacy-site document_root: /home/lenvi/projects/legacy-site php_version: "8.0" database: "legacy_db" - # Example for a simple site (no DB) - domain: simple.local project_root: /home/lenvi/projects/simple document_root: /home/lenvi/projects/simple - php_version: "8.3" \ No newline at end of file + php_version: "8.3"