Updates documentation

Author: moay

docs/topics/configuration.md

@@ -2,20 +2,23 @@
 
 The server comes well configured but the configuration can be tweaked. You should set your private recipes repo, all other options are optional.
 
-In order to change the configuration, alter the file `/config/parameters.yaml`. Some of the values can be provided in a .env-file, take a look at the contained `.env.dist` for helpful hints.
+In order to change the configuration, alter the file `/config/parameters.yaml`. Some of the values can be provided in environment variables or via .env-file, take a look at the contained `.env.dist` for helpful hints.
 
 ### Private recipes repo
 
 Your private recipes repo must be a git repo. It must be available via git, so it should be either a public repo or you should ensure that your server has access to it, probably by setting up some sort of SSH keys. In order to make the server use your repo, set this parameter:
 
-    recipe_repo_private: The url to your private recipe repo
+    env(FLEX_RECIPE_REPO_PRIVATE): The url to your private recipe repo
 
-The url provided must be a *https* url. Make sure to provide the right url structure, here are two examples:
+The url provided should be a *https* url, but most valid git-urls will work. Make sure to provide the right url structure, here are some examples:
 
 *  `https://github.com/moay/demo-recipes`
+*  `https://github.com/moay/demo-recipes.git`
 *  `https://bitbucket.org/mvmoay/demo-recipes`
+*  `[email protected]:moay/demo-recipes.git`
+*  `[email protected]:1234/moay/demo-recipes.git`
 
-There have been reports regarding private bitbucket repos, where people needed to use the git url (`[email protected]:<user>/<repo>.git`), feel free to try that out in case you run into problems.
+Github has proven to be quite good in resolving git requests, other providers or git servers may be pickier. If you run into problems, try to play with '.git', the protocol prefix or the type of url provided.
 
 After changing the configuration, you'll need to update the repos. Whenever you change the repo entirely, it is recommended to completely reset the private repo by executing the command `php bin/console recipes:reset private`.
 
@@ -25,7 +28,7 @@ Read more about these commands [here](commands.md).
 
 * If you want your server instance to **not** act as a proxy for the official endpoint, set `proxy_official_endpoint` to false. The default behaviour is to do so, because otherwise, Symfony probably won't work properly. You should have good reasons in order to disable it.     
 * If you don´t want the server to cache requests it makes to the official endpoint, set `cache_official_endpoint` to false. You won't notice any changes until network fails to load the official endpoint.
-* If (for some reason) you want to have any other official endpoint than symfony.sh, change `official_endpoint`. You could setup a working endpoint chain by providing the url to a second instance of this server.
+* If (for some reason) you want to have any other official endpoint than symfony.sh, change `env(FLEX_OFFICIAL_ENDPOINT)`. You could setup a working endpoint chain by providing the url to a second instance of this server.
 
 ### Mirroring the official recipe repos
 
@@ -36,8 +39,8 @@ Having a local copy of the official repos might be something you consider. You c
 
 Also, you might want to use your own forks of the official repos, you could use them by changing two options:
 
-    recipe_repo_official: The url to the official recipe repo
-    recipe_repo_contrib: The url to the contrib recipe repo
+    env(FLEX_RECIPE_REPO_OFFICIAL): The url to the official recipe repo
+    env(FLEX_RECIPE_REPO_CONTRIB): The url to the contrib recipe repo
 
 If you use both the proxy functionality **and** custom official repos, the official endpoint responses will be used only for recipes that are not available in your repos.
 

docs/topics/setup.md

@@ -4,7 +4,7 @@ Setting up the server should be quick and easy. These are the necessary steps:
 
 1. [Download](https://github.com/moay/symfony-flex-server/releases) the project from Github (or `git clone https://github.com/moay/symfony-flex-server`)
 2. Navigate to the project folder and run `composer install`.
-3. Open the file `config/services.yaml` and enter the url to your private recipes repo.
+3. Open the file `config/parameters.yaml` and enter the url to your private recipes repo (or provide appropriate environment variables).
 4. Setup the `APP_ENV` properly. This can be done in the `.env` file (create if needed) or on the hosting. Setting it to `prod` is recommended.
 5. Run `php bin/console recipes:initialize` in order to download your recipes.
 
@@ -37,4 +37,4 @@ Make sure to allow connections over http to composer (if using localhost) by add
         }
     }
 
-*It is not recommended to run the server locally. The best setup would be a private server behind a firewall.*
+*It is not recommended to run the server locally. The best setup would be a private server behind a firewall.*