From 7047b01671a1f2ee59b656f5933f4fdd10faf977 Mon Sep 17 00:00:00 2001 From: Karen Dickenson Date: Thu, 5 Nov 2020 10:03:18 -0500 Subject: [PATCH] 11163 - documentation - installation/containers (#11192) * Reordered and reworded .env setup for clarification * One more clarification --- docs/installation/containers.md | 43 ++++++++++++++++++--------------- 1 file changed, 23 insertions(+), 20 deletions(-) diff --git a/docs/installation/containers.md b/docs/installation/containers.md index 3baa34625..b784e479d 100644 --- a/docs/installation/containers.md +++ b/docs/installation/containers.md @@ -56,30 +56,33 @@ with Podman. You can install it by following these ## Setting up Forem -1. Fork Forem's repository, e.g. -1. Clone your forked repository, eg. - `git clone https://github.com//forem.git` -1. Set up your environment variables/secrets +1. Fork Forem's repository, e.g. +1. Clone your forked repository, eg. + `git clone https://github.com//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