maverick/docbrown
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

11163 - documentation - installation/containers (#11192)

Browse source 
* Reordered and reworded .env setup for clarification

* One more clarification
This commit is contained in:
Karen Dickenson 2020-11-05 10:03:18 -05:00 • committed by GitHub
parent 7a6ad7b83a
commit 7047b01671
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 23 additions and 20 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

43
docs/installation/containers.md
View file

@ -56,30 +56,33 @@ with Podman. You can install it by following these
## Setting up Forem
1. Fork Forem's repository, e.g. <https://github.com/forem/forem/fork>
1. Clone your forked repository, eg.
`git clone https://github.com/<your-username>/forem.git`
1. Set up your environment variables/secrets
1. Fork Forem's repository, e.g. <https://github.com/forem/forem/fork>
1. Clone your forked repository, eg.
`git clone https://github.com/<your-username>/forem.git`
1. Set up your environment variables/secrets
- Take a look at `.env_sample`. This file lists all the `ENV` variables we
use and provides a fake default for any missing keys.
- The [backend guide](/backend) will show you how to get free API keys for
additional services that may be required to run certain parts of the app.
- For any key that you wish to enter/replace:
1. Create `.env` by copying from the provided template`.env_sample` (i.e.
with bash: `cp .env_sample .env`).
1. Create `.env` by copying from the provided template (i.e. with bash:
`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.:
- `.env` is a personal file that is **ignored in git**.
- `.env` lists all the `ENV` variables we use and provides a fake
default for any missing keys.
```shell
export CLOUDINARY_API_KEY="SOME_REAL_SECURE_KEY_HERE"
export CLOUDINARY_API_SECRET="ANOTHER_REAL_SECURE_KEY_HERE"
export CLOUDINARY_CLOUD_NAME="A_CLOUDINARY_NAME"
```
2. For any key that you wish to enter/replace:
- You do not need "real" keys for basic development. Some features require
certain keys, so you may be able to add them as you go.
- You do not need "real" keys for basic development. Some features
require certain keys, so you may be able to add them as you go.
- The [backend guide](/backend) will show you how to get free API keys
for additional services that may be required to run certain parts of
the app.
- Obtain the development variable and apply the key you wish to
enter/replace. i.e.:
```shell
export CLOUDINARY_API_KEY="SOME_REAL_SECURE_KEY_HERE"
export CLOUDINARY_API_SECRET="ANOTHER_REAL_SECURE_KEY_HERE"
export CLOUDINARY_CLOUD_NAME="A_CLOUDINARY_NAME"
```
## Running Forem with Docker via docker-compose