Merge pull request #130 from Magellol/enhancement/introduce-dotenv

Proposal for allowing users to set their own env vars directly in the project.

.env-sample

@@ -0,0 +1,12 @@
+MYSQL_HOST=
+MYSQL_PORT=
+MYSQL_USER=
+MYSQL_PASSWORD=
+MYSQL_DATABASE=
+
+# Only required if you wish to run the test suites.
+MYSQL_HOST_TEST=
+MYSQL_PORT_TEST=
+MYSQL_USER_TEST=
+MYSQL_PASSWORD_TEST=
+MYSQL_DATABASE_TEST=

.gitignore

@@ -118,4 +118,5 @@ nbproject
 .node_history
 .editorconfig
 typings
-jsconfig.json
+jsconfig.json
+.env

.npmignore

@@ -41,4 +41,5 @@ nbproject
 .node_history
 .editorconfig
 typings
-jsconfig.json
+jsconfig.json
+.env

README.md

@@ -64,35 +64,16 @@ For example on Raspbian or on a Mac, it's located in :
 
 #### Connect Gladys to MySQL
 
-To connect Gladys to your database, you need to modify environment variables. 
+To connect Gladys to your database, you will need to set some environment variables.
+To do so, you'll have to create a `.env` file at the root of this project. The content of this file can be found by looking at `.env-sample`, which lists all the customizable env vars.
 
-You can set `MYSQL_HOST`, `MYSQL_PORT`, `MYSQL_USER`, `MYSQL_PASSWORD` and `MYSQL_DATABASE`.
-
-
-
-**Dirty way :**
-
-If you are not able to modify environment variables, you can enter your connections informations in the `config/connections.js` file.
-
-Modify the following lines with your own informations :
+**Note :** You will need to create the database as well in MySQL:
 
+```sql
+CREATE DATABASE gladys; -- or whatever name you've set in your .env file.`
 ```
-sailsmysql: {
-    adapter: 'sails-mysql',
-    host: process.env.MYSQL_HOST || 'localhost',
-    port: process.env.MYSQL_PORT || 3306,
-    user: process.env.MYSQL_USER || 'root',
-    password: process.env.MYSQL_PASSWORD || 'root',
-    database: process.env.MYSQL_DATABASE || 'gladys'
-  },
-```
-
-**Note :** You need to create the database first in MySQL :
-
-`CREATE DATABASE gladys;`
-
 
-#### Compile assets 
+#### Compile assets
 
 If you want to recompile assets and run all tasks, you can run :
 

app.js

@@ -33,9 +33,12 @@
 
 // if no env variable is set, we are in production
 if(!process.env.NODE_ENV){
-    process.env.NODE_ENV = 'production';    
+  process.env.NODE_ENV = 'production';
 }
 
+if (process.env.NODE_ENV === 'development') {
+  require('dotenv').config();
+}
 
 // Ensure we're in the project directory, so relative paths work as expected
 // no matter where we actually lift from.

config/connections.js

@@ -34,11 +34,11 @@ module.exports.connections = {
 
   test: {
     adapter: 'sails-mysql',
-    host: 'localhost',
-    port: 8889,
-    user: 'root',
-    password: 'root',
-    database: 'gladystest'
+    host: process.env.MYSQL_HOST_TEST || 'localhost',
+    port: process.env.MYSQL_PORT_TEST || 8889,
+    user: process.env.MYSQL_USER_TEST || 'root',
+    password: (typeof process.env.MYSQL_PASSWORD_TEST !== 'undefined') ? process.env.MYSQL_PASSWORD_TEST : 'root',
+    database: process.env.MYSQL_DATABASE_TEST || 'gladystest'
   },
 
   /***************************************************************************
@@ -54,7 +54,7 @@ module.exports.connections = {
     host: process.env.MYSQL_HOST || 'localhost',
     port: process.env.MYSQL_PORT || 3306,
     user: process.env.MYSQL_USER || 'root',
-    password: process.env.MYSQL_PASSWORD || 'root',
+    password: (typeof process.env.MYSQL_PASSWORD !== 'undefined') ? process.env.MYSQL_PASSWORD : 'root',
     database: process.env.MYSQL_DATABASE || 'gladys'
   },
 

package.json

@@ -21,6 +21,7 @@
     "bluebird": "^3.3.4",
     "clone": "^2.0.0",
     "crypto": "~0.0.3",
+    "dotenv": "^2.0.0",
     "ejs": "^2.4.1",
     "es6-template-strings": "^2.0.0",
     "fs-extra": "^0.30.0",

test/bootstrap.test.js

@@ -4,6 +4,10 @@ var Sails = require('sails'),
 var Barrels = require('barrels');
 var Promise = require('bluebird');
 
+if (process.env.NODE_ENV === 'development') {
+  require('dotenv').config();
+}
+
 /*
 log: {
       level: 'error'