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
This commit is contained in:
Hannah Wolfe 2013-09-15 15:45:18 +01:00
parent 71a92194ca
commit 596c1dccd2
3 changed files with 65 additions and 70 deletions

View File

@ -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"

View File

@ -1,43 +1,31 @@
// # 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'
},
travis: {
database: {
client: 'sqlite3',
connection: {
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'
},
// Default configuration
// ### 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
// }
// }
// },
// ```
database: {
client: 'sqlite3',
connection: {
@ -48,40 +36,15 @@ config = {
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: {
database: {
client: 'sqlite3',
connection: {
filename: path.join(__dirname, '/content/data/ghost-staging.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'
},
// ### 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: {
@ -92,9 +55,42 @@ config = {
server: {
host: '127.0.0.1',
port: '2368'
}
},
// **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-test.db')
}
},
// The url to use when providing links to the site; like RSS and email.
url: 'http://127.0.0.1:2368'
server: {
host: '127.0.0.1',
port: '2369'
}
},
// ### 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-travis.db')
}
},
server: {
host: '127.0.0.1',
port: '2368'
}
}
};

View File

@ -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'