Configuration

Once you have installed Butter, running first installation command, for example butter magento:install 2.4.0 will give you error that butter is not configured yet along with the file path from where butter can be configured.

Open this file & start editing it as per your machine environment. The important parts are

1. Database Connection: Enter your database connection details under node [db][connection]

2. Authentication: Get MAGEID & Download Token from your Magento account & enter them under [authentication] node

3. Installation Root: Enter folder path in the node [installation_root] where you want all the installation folders to be created

4. Setup Directory: Enter folder path in the node [setup_directory] where you want to store downloaded ZIP packages of various versions

5. Base URL: Enter the URL in the node [base_url], you would like to have for your installations. Don't remove <version> from it as it's a variable & dynamically replaced with the Magento version

6. Generate Performance Profiles: You may enter value "small/medium/large or extra_large" in node [generate_performance_profile] for generating data (product/categories/orders etc) in the installation automatically

7. Virtual Host: You may configure Butter to create nginx virtual hosts automatically. If you want to then configure it under [vhost] node by stating with setting [vhost][enabled] to true

8. Post Install Commands: You may specify custom commands to be executed after a installation is completed. Please enter them at node [post_install_commands]

9. Extra Extensions: You may install extra extensions at each installations. If you like to then enter their composer package names at node [extra_extensions]

10. Installation Method: By default Butter uses ZIP based installation method. You may change it to "composer" at node [installation_method]