Move .env_sample out of /config directory (#9868)
The `.env` file shouldn't live in the `/config` directory when it is created, but currently, the `.env_sample` file lives within `/config`. This can be confusing and cause ENV var issues if someone duplicates `.env_sample` and renames it to `.env`, because none of their ENV variables will get picked up, since their `.env` file will mistakenly end up in `/config`. This change moves `.env_sample` out of `/config`, and updates the documentation/relevant .yml files accordingly.
This commit is contained in:
parent
f452086280
commit
1531c182cc
8 changed files with 8 additions and 12 deletions
|
|
@ -21,7 +21,7 @@ tasks:
|
|||
redis-server &
|
||||
/home/gitpod/elasticsearch-7.5.2/bin/elasticsearch &
|
||||
init: >
|
||||
cp config/.env_sample .env &&
|
||||
cp .env_sample .env &&
|
||||
gem install solargraph &&
|
||||
bin/setup
|
||||
command: >
|
||||
|
|
|
|||
|
|
@ -43,7 +43,7 @@ install: true
|
|||
script:
|
||||
- date --rfc-3339=seconds
|
||||
- nvm install
|
||||
- cp config/.env_sample .env
|
||||
- cp .env_sample .env
|
||||
- pkill -9 -f elasticsearch || true
|
||||
- curl -s -O https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-7.5.2-amd64.deb
|
||||
- sudo dpkg -i --force-confnew elasticsearch-7.5.2-amd64.deb
|
||||
|
|
|
|||
|
|
@ -11,11 +11,11 @@ The [backend guide][backend_guide] will show you how to get free API keys for
|
|||
additional services that may be required to run certain parts of the app.
|
||||
|
||||
To set up keys for your local instance of Forem, you'll need to create an `.env`
|
||||
file. You can do this by copying the file called `.env_sample` in the `config`
|
||||
file. You can do this by copying the file called `.env_sample` in the app's main
|
||||
directory:
|
||||
|
||||
```shell
|
||||
cp config/.env_sample .env
|
||||
cp .env_sample .env
|
||||
```
|
||||
|
||||
Then, add each key you need to the `.env` file. For example, if you're setting
|
||||
|
|
|
|||
|
|
@ -68,8 +68,7 @@ with Podman. You can install it by following these
|
|||
- For any key that you wish to enter/replace:
|
||||
|
||||
1. Create `.env` by copying from the provided template (i.e. with bash:
|
||||
`cp config/.env_sample .env`). This is a personal file that is ignored
|
||||
in git.
|
||||
`cp .env_sample .env`). This is a personal file that is ignored in git.
|
||||
1. Obtain the development variable and apply the key you wish to
|
||||
enter/replace. i.e.:
|
||||
|
||||
|
|
|
|||
|
|
@ -98,8 +98,7 @@ NOTE: Make sure to download **the OSS version**, `elasticsearch-oss`.
|
|||
- For any key that you wish to enter/replace:
|
||||
|
||||
1. Create `.env` by copying from the provided template (i.e. with bash:
|
||||
`cp config/.env_sample .env`). This is a personal file that is ignored
|
||||
in git.
|
||||
`cp .env_sample .env`). This is a personal file that is ignored in git.
|
||||
1. Obtain the development variable and apply the key you wish to
|
||||
enter/replace. i.e.:
|
||||
|
||||
|
|
|
|||
|
|
@ -218,8 +218,7 @@ your local Elasticsearch installation, for example:
|
|||
- For any key that you wish to enter/replace, follow the steps below.
|
||||
|
||||
1. Create `.env` by copying from the provided template (i.e. with bash:
|
||||
`cp config/.env_sample .env`). This is a personal file that is ignored
|
||||
in git.
|
||||
`cp .env_sample .env`). This is a personal file that is ignored in git.
|
||||
2. Obtain the development variable and apply the key you wish to
|
||||
enter/replace. i.e.:
|
||||
|
||||
|
|
|
|||
|
|
@ -255,8 +255,7 @@ To install Elasticsearch perform the following steps:
|
|||
- For any key that you wish to enter/replace:
|
||||
|
||||
1. Create `.env` by copying from the provided template (ie. with bash:
|
||||
`cp config/.env_sample .env`). This is a personal file that is ignored
|
||||
in git.
|
||||
`cp .env_sample .env`). This is a personal file that is ignored in git.
|
||||
1. Obtain the development variable and apply the key you wish to
|
||||
enter/replace. ie:
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue