Merge pull request #297 from integer32llc/dotenv

Add dotenv support

Author: shepmaster

README.md

@@ -96,18 +96,19 @@ basic HTML/CSS/JS changes, directly open in your browser the built
 `ui/frontend/build/index.html`.
 
 ### Build and run the server
+
+Configure your `.env` file as described in the [ui README](./ui/README.md).
+
 ```
 cd ui
-RUST_LOG=ui=debug \
-PLAYGROUND_UI_ROOT=$PWD/frontend/build/ \
-PLAYGROUND_GITHUB_TOKEN=YOUR_TOKEN \
 cargo run
 ```
 
-### Build the containers
+### Build or download the containers
 ```
 cd compiler
-./build.sh
+./build.sh # If you want to test changes to the containers
+./fetch.sh # If you just want the current playground
 ```
 
 ## Deployment

ui/Cargo.lock

@@ -30,6 +30,7 @@ hyper = "0.11.21"
 hyper-tls = "0.1.2"
 router = "0.6.0"
 openssl-probe = "0.1.2"
+dotenv = "0.11.0"
 
 [dependencies.playground-middleware]
 git = "https://github.com/integer32llc/playground-middleware"

ui/Cargo.toml

@@ -1,9 +1,19 @@
 ## Configuration
 
-| Key                     | Required  | Default Value   | Description                                                             |
-| ------------------------|-----------|-----------------|-------------------------------------------------------------------------|
-| `PLAYGROUND_UI_ROOT`    | **Yes**   |                 | The path to the HTML, CSS, and Javascript files                         |
-| `PLAYGROUND_UI_ADDRESS` | No        |       127.0.0.1 | The address to listen on                                                |
-| `PLAYGROUND_UI_PORT`    | No        |            5000 | The port to listen on                                                   |
-| `PLAYGROUND_LOG_FILE`   | No        |  access-log.csv | The file to record accesses                                             |
-| `TMPDIR`                | No        | system-provided | Where compilation artifacts will be saved. Must be accessible to Docker |
+When developing, you can place these in a [`.env`][dotenv] file on
+disk in this directory.
+
+In production, these should be set according to your deployment method
+of choice.
+
+| Key                       | Required | Default Value   | Description                                                             |
+| --------------------------|----------|-----------------|-------------------------------------------------------------------------|
+| `PLAYGROUND_UI_ROOT`      | **Yes**  |                 | The path to the HTML, CSS, and Javascript files                         |
+| `PLAYGROUND_GITHUB_TOKEN` | **Yes**  |                 | The [GitHub API token][gist] to read and write Gists                    |
+| `PLAYGROUND_UI_ADDRESS`   | No       |       127.0.0.1 | The address to listen on                                                |
+| `PLAYGROUND_UI_PORT`      | No       |            5000 | The port to listen on                                                   |
+| `PLAYGROUND_LOG_FILE`     | No       |  access-log.csv | The file to record accesses                                             |
+| `TMPDIR`                  | No       | system-provided | Where compilation artifacts will be saved. Must be accessible to Docker |
+
+[dotenv]: https://crates.io/crates/dotenv
+[gist]: https://developer.github.com/v3/gists/#authentication

ui/README.md

@@ -3,6 +3,7 @@
 #[macro_use]
 extern crate log;
 extern crate env_logger;
+extern crate dotenv;
 extern crate iron;
 extern crate mount;
 extern crate router;
@@ -66,6 +67,7 @@ const ONE_YEAR_IN_SECONDS: u64 = 60 * 60 * 24 * 365;
 const SANDBOX_CACHE_TIME_TO_LIVE_IN_SECONDS: u64 = ONE_HOUR_IN_SECONDS as u64;
 
 fn main() {
+    dotenv::dotenv().unwrap();
     openssl_probe::init_ssl_cert_env_vars();
     env_logger::init();