From fc1f35ad59a503e086e9d98b87deb89b3f0a6b52 Mon Sep 17 00:00:00 2001 From: Alejandro Celaya Date: Thu, 24 Oct 2024 10:12:34 +0200 Subject: [PATCH] Update CONTRIBUTING file removing references to old local config files --- CONTRIBUTING.md | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4ee94c70e..e44c5feea 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -16,11 +16,20 @@ The first thing you need to do is fork the repository, and clone it in your loca Then you will have to follow these steps: -* Copy all files with `.local.php.dist` extension from `config/autoload` by removing the dist extension. +* Copy the `config/params/shlink_dev_env.php.dist` in the same directory, but removing the `.dist` extension: - For example the `common.local.php.dist` file should be copied as `common.local.php`. + ``` + cp config/params/shlink_dev_env.php.dist config/params/shlink_dev_env.php + ``` + + The `shlink_dev_env.php` file is gitignored, so you can customize it as you want. For example, by adding your own GeoLite license key. + +* Do the same with the `docker-compose.override.yml.dist`: + + ``` + cp docker-compose.override.yml.dist docker-compose.override.yml + ``` -* Copy the file `docker-compose.override.yml.dist` by also removing the `dist` extension. * Start-up the project by running `docker compose up`. The first time this command is run, it will create several containers that are used during development, so it may take some time.