From f56e30c1a1ab2c42728ce10f5e9b1cea1891112e Mon Sep 17 00:00:00 2001 From: David Erwin Date: Fri, 13 Jan 2017 10:08:35 -0500 Subject: [PATCH 1/3] Updating docs for .env functionality --- README.md | 30 ++++++++++++++++-------------- 1 file changed, 16 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 239483628..6b5105a54 100644 --- a/README.md +++ b/README.md @@ -17,30 +17,32 @@ To launch a Talk server of your own from your browser without any need to muck a ### Configuration -The Talk application requires specific configuration options to be available -inside the environment in order to run, those variables are listed here: +The Talk application looks for the following configuration values either as +environment variables or via an `.env` file: - `TALK_MONGO_URL` (*required*) - the database connection string for the MongoDB database. - `TALK_REDIS_URL` (*required*) - the database connection string for the Redis database. - `TALK_SESSION_SECRET` (*required*) - a random string which will be used to secure cookies. -- `TALK_FACEBOOK_APP_ID` (*required*) - the Facebook app id for your Facebook -Login enabled app. -- `TALK_FACEBOOK_APP_SECRET` (*required*) - the Facebook app secret for your -Facebook Login enabled app. - `TALK_ROOT_URL` (*required*) - root url of the installed application externally available in the format: `://` without the path. -- `TALK_SMTP_EMAIL` (*required*) - the address to send emails from using the + +- `TALK_FACEBOOK_APP_ID` (*required for login via fb*) - the Facebook app id for your Facebook +Login enabled app. +- `TALK_FACEBOOK_APP_SECRET` (*required for login via fb*) - the Facebook app secret for your +Facebook Login enabled app. + +- `TALK_SMTP_EMAIL` (*required for email*) - the address to send emails from using the SMTP provider. -- `TALK_SMTP_USERNAME` (*required*) - username of the SMTP provider you are using. -- `TALK_SMTP_PASSWORD` (*required*) - password for the SMTP provider you are using. -- `TALK_SMTP_HOST` (*required*) - SMTP host url with format `smtp.domain.com`. -- `TALK_SMTP_PORT` (*required*) - SMTP port. +- `TALK_SMTP_USERNAME` (*required for email*) - username of the SMTP provider you are using. +- `TALK_SMTP_PASSWORD` (*required for email*) - password for the SMTP provider you are using. +- `TALK_SMTP_HOST` (*required for email*) - SMTP host url with format `smtp.domain.com`. +- `TALK_SMTP_PORT` (*required for email*) - SMTP port. +We recommend using environment variables for configuration in staging and +production environments. -### Install from Source - -If you want to run Talk in development mode from source (without docker) you can read the [INSTALL file](INSTALL.md). +For more information about configuration via `.env`, please [visit our wiki](https://github.com/coralproject/talk/wiki/Configuration-via-.env). ### License From 7c95781072efb77fc9b5a86dd1f70b76f0984899 Mon Sep 17 00:00:00 2001 From: David Erwin Date: Fri, 13 Jan 2017 10:21:12 -0500 Subject: [PATCH 2/3] Update README.md --- README.md | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 6b5105a54..e005c314f 100644 --- a/README.md +++ b/README.md @@ -17,8 +17,7 @@ To launch a Talk server of your own from your browser without any need to muck a ### Configuration -The Talk application looks for the following configuration values either as -environment variables or via an `.env` file: +The Talk application looks for the following configuration values either as environment variables: - `TALK_MONGO_URL` (*required*) - the database connection string for the MongoDB database. - `TALK_REDIS_URL` (*required*) - the database connection string for the Redis database. @@ -39,10 +38,7 @@ Facebook Login enabled app. - `TALK_SMTP_HOST` (*required for email*) - SMTP host url with format `smtp.domain.com`. - `TALK_SMTP_PORT` (*required for email*) - SMTP port. -We recommend using environment variables for configuration in staging and -production environments. - -For more information about configuration via `.env`, please [visit our wiki](https://github.com/coralproject/talk/wiki/Configuration-via-.env). +During development mode, you can use the command `npm run dev-start` which will load environment variables from a file named .env in the present working directory. ### License From 39a4d031c71c989940419f8299bd1706c8cc0874 Mon Sep 17 00:00:00 2001 From: Wyatt Johnson Date: Fri, 13 Jan 2017 08:24:12 -0700 Subject: [PATCH 3/3] Adjusted for new wiki page --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e005c314f..79c523925 100644 --- a/README.md +++ b/README.md @@ -38,7 +38,8 @@ Facebook Login enabled app. - `TALK_SMTP_HOST` (*required for email*) - SMTP host url with format `smtp.domain.com`. - `TALK_SMTP_PORT` (*required for email*) - SMTP port. -During development mode, you can use the command `npm run dev-start` which will load environment variables from a file named .env in the present working directory. +Refer to the wiki page on [Configuration Loading](https://github.com/coralproject/talk/wiki/Configuration-Loading) for +alternative methods of loading configuration during development. ### License