Updating example config file

- url first, replaced with temporary URL with documentation - mail config is a commented out example - mail documentation link in config and mail file - no more staging - gruntfile updated to generate correct docs
parroit · Sep 15, 2013 · 596c1dc · 596c1dc
1 parent 71a9219
commit 596c1dc
Show file tree

Hide file tree

Showing 3 changed files with 54 additions and 59 deletions.
diff --git a/Gruntfile.js b/Gruntfile.js
@@ -242,9 +242,9 @@ var path = require('path'),
                         "out": "./docs/",
                         "glob": [
                             "README.md",
-                            "config.js",
+                            "config.example.js",
                             "index.js",
-                            "core/ghost.js",
+                            "core/*.js",
                             "core/server/**/*.js",
                             "core/shared/**/*.js",
                             "core/client/**/*.js"

diff --git a/config.example.js b/config.example.js
@@ -1,100 +1,96 @@
 // # Ghost Configuration
+// Setup your Ghost install for various environments
 
 var path = require('path'),
     config;
 
-// ## Environment
-// **Warning:** Only change the settings below here if you are sure of what you are doing!
 config = {
-    testing: {
-        database: {
-            client: 'sqlite3',
-            connection: {
-                filename: path.join(__dirname, '/content/data/ghost-test.db')
-            }
-        },
-        server: {
-            host: '127.0.0.1',
-            port: '2369'
-        },
-        // The url to use when providing links to the site; like RSS and email.
-        url: 'http://127.0.0.1:2369'
-    },
+    // ### Development **(default)**
+    development: {
+        // The url to use when providing links to the site, E.g. in RSS and email.
+        url: 'http://my-ghost-blog.com',
+
+        // Example mail config
+        // Visit http://docs.ghost.org/mail for instructions
+        // ```
+        //  mail: {
+        //      transport: 'sendgrid',
+        //      host: 'smtp.sendgrid.net',
+        //      options: {
+        //          service: 'Sendgrid',
+        //          auth: {
+        //              user: '', // Super secret username
+        //              pass: ''  // Super secret password
+        //          }
+        //      }
+        //  },
+        // ```
 
-    travis: {
         database: {
             client: 'sqlite3',
             connection: {
-                filename: path.join(__dirname, '/content/data/ghost-travis.db')
-            }
+                filename: path.join(__dirname, '/content/data/ghost-dev.db')
+            },
+            debug: false
         },
         server: {
             host: '127.0.0.1',
             port: '2368'
-        },
-        // The url to use when providing links to the site; like RSS and email.
-        url: 'http://127.0.0.1:2368'
+        }
     },
 
-    // Default configuration
-    development: {
+    // ### Production
+    // When running Ghost in the wild, use the production environment
+    // Configure your URL and mail settings here
+    production: {
+        url: 'http://my-ghost-blog.com',
+        mail: {},
         database: {
             client: 'sqlite3',
             connection: {
-                filename: path.join(__dirname, '/content/data/ghost-dev.db')
+                filename: path.join(__dirname, '/content/data/ghost.db')
             },
             debug: false
         },
         server: {
             host: '127.0.0.1',
             port: '2368'
-        },
-        // The url to use when providing links to the site; like RSS and email.
-        url: 'http://127.0.0.1:2368',
-        // Example mail config
-        mail: {
-            transport: 'sendgrid',
-            host: 'smtp.sendgrid.net',
-            options: {
-                service: 'Sendgrid',
-                auth: {
-                    user: '', // Super secret username
-                    pass: ''  // Super secret password
-                }
-            }
         }
     },
 
-    staging: {
+    // **Developers only need to edit below here**
+
+    // ### Testing
+    // Used when developing Ghost to run tests and check the health of Ghost
+    // Uses a different port number
+    testing: {
+        url: 'http://127.0.0.1:2369',
         database: {
             client: 'sqlite3',
             connection: {
-                filename: path.join(__dirname, '/content/data/ghost-staging.db')
-            },
-            debug: false
+                filename: path.join(__dirname, '/content/data/ghost-test.db')
+            }
         },
         server: {
             host: '127.0.0.1',
-            port: '2368'
-        },
-        // The url to use when providing links to the site; like RSS and email.
-        url: 'http://127.0.0.1:2368'
+            port: '2369'
+        }
     },
 
-    production: {
+    // ### Travis
+    // Automated testing run through Github
+    travis: {
+        url: 'http://127.0.0.1:2368',
         database: {
             client: 'sqlite3',
             connection: {
-                filename: path.join(__dirname, '/content/data/ghost.db')
-            },
-            debug: false
+                filename: path.join(__dirname, '/content/data/ghost-travis.db')
+            }
         },
         server: {
             host: '127.0.0.1',
             port: '2368'
-        },
-        // The url to use when providing links to the site; like RSS and email.
-        url: 'http://127.0.0.1:2368'
+        }
     }
 };
 

diff --git a/core/server/mail.js b/core/server/mail.js
@@ -66,7 +66,7 @@ GhostMailer.prototype.usingSendmail = function () {
         message: [
             "Ghost is attempting to use your server's <b>sendmail</b> to send e-mail.",
             "It is recommended that you explicitly configure an e-mail service,",
-            "see <a href=\"https://github.com/TryGhost/Ghost/wiki/\">instructions in the wiki</a>."
+            "See http://docs.ghost.org/mail for instructions"
         ].join(' '),
         status: 'persistent',
         id: 'ghost-mail-fallback'
@@ -78,8 +78,7 @@ GhostMailer.prototype.emailDisabled = function () {
         type: 'warn',
         message: [
             "Ghost is currently unable to send e-mail.",
-            "See <a href=\"https://github.com/TryGhost/Ghost/wiki/\">instructions for configuring",
-            "an e-mail service</a>."
+            "See http://docs.ghost.org/mail for instructions"
         ].join(' '),
         status: 'persistent',
         id: 'ghost-mail-disabled'