diff options
| author | Sam Pearson <sam@sgp.me.uk> | 2018-11-05 13:16:10 +0000 |
|---|---|---|
| committer | Sam Pearson <sam@sgp.me.uk> | 2018-11-05 13:27:02 +0000 |
| commit | 94c761fc5eb91fa7b558f0c8e8bdbff4f34e2ac7 (patch) | |
| tree | 2776a78ae739c965c29e9f8273fcfe5b13f9bff8 /docs | |
| parent | 738f832405561690da3c2ad7b94b7c87c556dafc (diff) | |
[Vagrant] Check and generate config file if necessary
This adds support in `script/setup` for generating a local `general.yml`
if it doesn't already exist and is run as the `vagrant` user. This is
called from the `Vagrantfile` when using the FixMyStreet Vagrant box.
[skip ci]
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/install/manual-install.md | 10 |
1 files changed, 6 insertions, 4 deletions
diff --git a/docs/install/manual-install.md b/docs/install/manual-install.md index fcb65ad41..5ddf8a30f 100644 --- a/docs/install/manual-install.md +++ b/docs/install/manual-install.md @@ -7,10 +7,10 @@ title: Installing <p class="lead"> This page describes how to install the FixMyStreet platform manually. - You can use this if you're used to setting up web applications — + You can use this if you're used to setting up web applications — but the other installation options may be easier:</p> -Note that this is just one of +Note that this is just one of [many ways to install FixMyStreet]({{ "/install/" | relative_url }}) (the other ways are easier!). @@ -129,7 +129,9 @@ and compiles any translation `.mo` files (using `commonlib/bin/gettext-makemo`). The settings for FixMyStreet are defined in `conf/general.yml` using the YAML markup language. There are some defaults in `conf/general.yml-example` which -you should copy to `conf/general.yml`: +you should copy to `conf/general.yml`; note that if you are using the Vagrant +environment, a simple `conf/general.yml` file should already have been +configured for you. {% highlight bash %} $ cp conf/general.yml-example conf/general.yml @@ -151,7 +153,7 @@ Some others you might want to look at, though the defaults are enough for it to * [GEO_CACHE]({{ "/customising/config/#geo_cache" | relative_url }}) -- this is the location where Geolocation data will be cached. It should be accessible by and writeable by the FixMyStreet process. If you are using Bing or Google maps you should also set one of -[BING_MAPS_API_KEY]({{ "/customising/config/#bing_maps_api_key" | relative_url }}) or +[BING_MAPS_API_KEY]({{ "/customising/config/#bing_maps_api_key" | relative_url }}) or [GOOGLE_MAPS_API_KEY]({{ "/customising/config/#google_maps_api_key" | relative_url }}). ### 6. Set up some required data |