npm/wo-base-webserver
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

引用 so.base/config.js 来配置

Browse Source
This commit is contained in:
陆柯 2020-03-15 19:59:29 +08:00
parent fe8e869419
commit a2b9eb1dd8
4 changed files with 78 additions and 172 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

49
ConfigBasic.js
View File

@ -1,49 +0,0 @@
module.exports={
protocol: 'http',
host: 'localhost',
port: undefined,
from: './dist', // local path to serve as webroot
production: {
protocol: 'httpall',
host: 'remote.domain',
// 如果使用 https 协议，必须填写以下内容，或在命令行参数中设置：
sslType: 'file', // '' or greenlock or file
sslDomainList: ['remote.domain'],
sslKey: '/etc/letsencrypt/live/HOST/privkey.pem', // ssl key file,
sslCert: '/etc/letsencrypt/live/HOST/fullchain.pem', // ssl cert file,
sslCA: '/etc/letsencrypt/live/HOST/bundle.pem', // ssl ca file,
},
deploy: {
type: 'ssh',
from: './unpackage/dist/build/h5', // 以 HBuilderX + uniapp 的配置为例
host: 'localhost', // 待部署到的主机
port: '22', // 带部署到的主机的 SSH 端口
dir: '/faronear/ORG/APP', // 待部署到的目录路径
dist: 'dist', // 待部署到的文件夹
user: 'adot', // 登录用户名
password: '', // 登录用户密码
key: `${process.env.HOME}/.ssh/id_rsa`, // 登录用户私钥文件
},
deploy_git: {
type: 'git',
from: './unpackage/dist/build/h5',
repo: 'https://github.com/ORG/APP',
gitname: 'team',
gitemail: 'team@outlook.com',
password: '', // 登录用户密码
key: `${process.env.HOME}/.ssh/id_rsa`, // 登录用户私钥文件
},
},
// 如果使用虚拟主机
/*
vhosts: [
{ webroot: 'dist', webindex: 'index.html', domainList: ['']}
],
*/
}

3
ConfigCustom.js
View File

@ -1,3 +0,0 @@
module.exports={
}

2
package.json
View File

@ -12,7 +12,7 @@
"deepmerge": "^2.1.1", "deepmerge": "^2.1.1",
"errorhandler": "^1.5.0", "errorhandler": "^1.5.0",
"express": "^4.16.2", "express": "^4.16.2",
"greenlock-express": "^2.7.8", "greenlock-express": "^4.0.3",
"method-override": "^2.3.10", "method-override": "^2.3.10",
"morgan": "^1.9.0", "morgan": "^1.9.0",
"serve-favicon": "^2.4.5", "serve-favicon": "^2.4.5",

196
server.js
View File

@ -1,95 +1,53 @@
const fs = require('fs') const fs = require('fs')
const path = require('path') const path = require('path')
const os = require('os')
function config(){ var Config = require('so.base/config.js')
const commander = require('commander') if (!Config || Object.keys(Config).length===0) {
const deepmerge = require('deepmerge') Config = { // 默认配置，如果用户什么也没有提供
protocol: 'http',
host: 'localhost',
from: './dist', // local path to serve as webroot
var Config={} production: {
protocol: 'httpall',
host: 'remote.domain',
// 如果使用 https 协议，必须填写以下内容，或在命令行参数中设置：
sslType: 'file', // '' or greenlock or file
sslKey: 'ssl/privkey.pem', // ssl key file,
sslCert: 'ssl/fullchain.pem', // ssl cert file,
sslCA: 'ssl/bundle.pem', // ssl ca file,
ssl: {
// greenlockOptions: {
// version: 'draft-11',
// server: 'https://acme-staging-v02.api.letsencrypt.org/directory', // for development
// // 'https://acme-v02.api.letsencrypt.org/directory', // for production
// agreeTos: true,
// communityMember: false,
// store: require('greenlock-store-fs'),
// email: 'ssl@faronear.org',
// approvedDomains: ['remote.domain'],
// configDir: path.resolve(__dirname, 'ssl'),
// }
},
},
// 读取配置文件 // 如果使用虚拟主机
try { /*
let configFile vhosts: [
if (fs.existsSync(configFile = path.join(process.cwd(), './ConfigBasic.js'))) { { webroot: 'dist', webindex: 'index.html', domainList: ['']}
Config=require(configFile) ],
console.info(`${configFile} loaded`) */
}else {
console.info(`Missing and omitting ${configFile}`)
} }
if (fs.existsSync(configFile = path.join(process.cwd(), './ConfigCustom.js'))) { // 如果存在，覆盖掉 ConfigBasic 里的默认参数
Config=deepmerge(Config, require(configFile)) // 注意，objectMerge后，产生了一个新的对象，而不是在原来的Config里添加
console.info(`${configFile} loaded`)
}else {
console.info(`Missing and omitting ${configFile}`)
}
if (fs.existsSync(configFile = path.join(process.cwd(), './ConfigSecret.js'))) { // 如果存在，覆盖掉 ConfigBasic 和 ConfigCustom 里的参数
Config=deepmerge(Config, require(configFile))
console.info(`${configFile} loaded`)
}else {
console.info(`Missing and omitting ${configFile}`)
}
}catch(err){
console.error(`Loading config files failed: ${err.message}`)
} }
// 载入命令行参数 (function serve(){
commander console.log('★★★★★★★★ Starting Server ★★★★★★★★')
.version(Config.VERSION, '-v, --version') // 默认是 -V。如果要 -v，就要加 '-v --version'
.option('-e, --env <env>', 'Environment. Default to ' + (Config.env || process.env.NODE_ENV)) const server = require('express')()
.option('-H, --host <host>', `Host ip or domain name. Default to ${Config.host}`)
.option('-P, --protocol <protocol>', `Web server protocol http|https|httpall|http2https. Default to ${Config.protocol}`)
.option('-p, --port <port>', `Server port. Default to ${Config.port?Config.port:'80|443'}`)
.option('-f, --from <from>', `Distribution folder to serve as webroot. Default to ${Config.from}`)
.option('--sslType <type>', `SSL provider type. Default to ${Config.sslType}`)
.option('--sslCert <cert>', `SSL certificate file. Default to ${Config.sslCert}`)
.option('--sslKey <key>', `SSL private key file. Default to ${Config.sslKey}`)
.option('--sslCA <ca>', 'SSL ca bundle file')
.parse(process.argv)
// 把命令行参数 合并入配置。 const greenlock = Config.sslType==='greenlock'
Config.env = commander.env || Config.env || process.env.NODE_ENV ? require('greenlock-express').create(Object.assign(Config.ssl.greenlockOptions, {app: server}))
if (Config.env === 'production') { : null
Config = deepmerge(Config, Config.production)
}
delete Config.production
Config.host=commander.host || Config.host
Config.protocol=commander.protocol || Config.protocol || 'http'
Config.port=parseInt(commander.port) || parseInt(Config.port) || (Config.protocol==='http'?80:Config.protocol==='https'?443:undefined) // 端口默认为 http:80, https:443, httpall: 80|443
Config.from = commander.from || Config.from || 'dist'
Config.sslType = commander.sslType || Config.sslType
Config.sslCert=commander.sslCert || Config.sslCert
Config.sslKey=commander.sslKey || Config.sslKey
Config.sslCA=commander.sslCA || Config.sslCA
console.info('Configuration is ready.')
return Config
}
async function init(){ /*** 设置全局对象 ***/
global.wo={} // wo 代表 world或‘我’，是当前的命名空间，把各种类都放在这里，防止和其他库的冲突。
wo.Config=config() // 依次载入系统默认配置、用户配置文件、命令行参数
}
(async function start(){
await init()
const express=require('express')
const server = express()
const greenlock = (['https', 'httpall'].indexOf(wo.Config.protocol)>=0 && wo.Config.sslType === 'greenlock') ? require('greenlock-express').create({
version: 'draft-11',
server: 'https://acme-v02.api.letsencrypt.org/directory', // for test: acme-staging-v02
agreeTos: true,
communityMember: false,
store: require('greenlock-store-fs'),
email: 'ssl@faronear.org',
approvedDomains: wo.Config.sslDomainList,
configDir: path.resolve(process.cwd(), 'ssl'),
app: server,
}) : null
/*** 通用中间件 ***/ /*** 通用中间件 ***/
server.use(require('morgan')('development'===server.get('env')?'dev':'combined')) server.use(require('morgan')('development'===server.get('env')?'dev':'combined'))
@ -102,12 +60,12 @@ async function init(){ /*** 设置全局对象 ***/
// vhost 匹配了域名，就执行；不匹配，就next() // vhost 匹配了域名，就执行；不匹配，就next()
// express.static 找到了具体文件，就返回；找不到，就next() // express.static 找到了具体文件，就返回；找不到，就next()
// 所以，如果 vhost匹配了域名，且static找到了文件，就结束了。如果 vhost 匹配了域名，但static找不到文件，就继续往下。 // 所以，如果 vhost匹配了域名，且static找到了文件，就结束了。如果 vhost 匹配了域名，但static找不到文件，就继续往下。
if (!wo.Config.vhosts) { if (!Config.vhosts) {
server.use(express.static(path.join(process.cwd(), wo.Config.from), {index: 'index.html'})) server.use(express.static(path.join(process.cwd(), Config.from), {index: 'index.html'}))
// server.use(require('serve-favicon')(path.join(process.cwd(), 'public', 'favicon.ico'))) // uncomment after placing your favicon in /public // server.use(require('serve-favicon')(path.join(process.cwd(), 'public', 'favicon.ico'))) // uncomment after placing your favicon in /public
}else { } else {
let vhost = require('vhost') let vhost = require('vhost')
for (let h of wo.Config.vhosts) { for (let h of Config.vhosts) {
for (let domain of h.domainList) { for (let domain of h.domainList) {
server.use(vhost(domain, express.static(path.join(process.cwd(), h.webroot), {index: h.webindex}))) server.use(vhost(domain, express.static(path.join(process.cwd(), h.webroot), {index: h.webindex})))
} }
@ -119,66 +77,66 @@ async function init(){ /*** 设置全局对象 ***/
//router.get('/path', function(req,res) { res.redirect('target') }) //router.get('/path', function(req,res) { res.redirect('target') })
//server.use(router) //server.use(router)
let ipv4 = getMyIp()
/*** 启动 Web 服务 ***/ /*** 启动 Web 服务 ***/
let webServer let webServer
if ('http' === wo.Config.protocol) { let ipv4 = getMyIp()
webServer = require('http').createServer(server).listen(wo.Config.port, function (err) { let portHttp = Config.port || 80
let portHttps = Config.port || 443
if ('http' === Config.protocol) {
webServer = require('http').createServer(server).listen(portHttp, function (err) {
if (err) console.log(err) if (err) console.log(err)
else console.log(`[${new Date().toJSON()}] Server listening on ${wo.Config.protocol}://${wo.Config.host}:${wo.Config.port} with IPv4=${ipv4} for ${server.settings.env} environment`) else console.log(`[${new Date().toJSON()}] Server listening on ${Config.protocol}://${Config.host}:${portHttp} with IPv4=${ipv4} for ${server.settings.env} environment`)
}) })
} else if ('https' === wo.Config.protocol) { } else if ('https' === Config.protocol) {
webServer = require('https').createServer(wo.Config.sslType === 'greenlock' ? greenlock.httpsOptions : { webServer = require('https').createServer(Config.sslType === 'greenlock' ? greenlock.httpsOptions : {
key: fs.readFileSync(wo.Config.sslKey), key: fs.readFileSync(Config.sslKey),
cert: fs.readFileSync(wo.Config.sslCert), cert: fs.readFileSync(Config.sslCert),
// ca: [ fs.readFileSync(wo.Config.sslCA) ] // only for self-signed certificate: https://nodejs.org/api/tls.html#tls_tls_createserver_options_secureconnectionlistener // ca: [ fs.readFileSync(Config.sslCA) ] // only for self-signed certificate: https://nodejs.org/api/tls.html#tls_tls_createserver_options_secureconnectionlistener
}, server).listen(wo.Config.port, function (err) { }, server).listen(portHttps, function (err) {
if (err) console.log(err) if (err) console.log(err)
else console.log(`[${new Date().toJSON()}] Server listening on ${wo.Config.protocol}://${wo.Config.host}:${wo.Config.port} with IPv4=${ipv4} for ${server.settings.env} environment`) else console.log(`[${new Date().toJSON()}] Server listening on ${Config.protocol}://${Config.host}:${portHttps} with IPv4=${ipv4} for ${server.settings.env} environment`)
}) })
} else if ('httpall' === wo.Config.protocol) { } else if ('httpall' === Config.protocol) {
let portHttp = wo.Config.port ? wo.Config.port : 80 // 如果port参数已设置，使用它；否则默认为80 portHttp = 80
let portHttps = (wo.Config.port && wo.Config.port !== 80) ? wo.Config.port + 443 : 443 // 如果port参数已设置，使用它+443；否则默认为443 if (Config.sslType === 'greenlock') {
if (wo.Config.sslType === 'greenlock') {
webServer = greenlock.listen(portHttp, portHttps, function (err) { webServer = greenlock.listen(portHttp, portHttps, function (err) {
if (err) console.log(err) if (err) console.log(err)
else console.log(`[${new Date().toJSON()}] Server listening on [${wo.Config.protocol}] http=>https://${wo.Config.host}:${portHttp}=>${portHttps} with IPv4=${ipv4} for ${server.settings.env} environment`) else console.log(`[${new Date().toJSON()}] Server listening on [${Config.protocol}] http=>https://${Config.host}:${portHttp}=>${portHttps} with IPv4=${ipv4} for ${server.settings.env} environment`)
}) })
} else { } else {
require('http').createServer(server.all('*', function (ask, reply) { require('http').createServer(server.all('*', function (ask, reply) {
reply.redirect(`https://${wo.Config.host}:${portHttps}`) reply.redirect(`https://${Config.host}:${portHttps}`)
})).listen(portHttp, function(err) { })).listen(portHttp, function(err) {
if (err) console.log(err) if (err) console.log(err)
else console.log(`[${new Date().toJSON()}] Server listening on [${wo.Config.protocol}] http://${wo.Config.host}:${portHttp} with IPv4=${ipv4} for ${server.settings.env} environment`) else console.log(`[${new Date().toJSON()}] Server redirecting from [${Config.protocol}] http://${Config.host}:${portHttp} with IPv4=${ipv4} for ${server.settings.env} environment`)
}) })
webServer = require('https').createServer({ webServer = require('https').createServer({
key: fs.readFileSync(wo.Config.sslKey), key: fs.readFileSync(Config.sslKey),
cert: fs.readFileSync(wo.Config.sslCert), cert: fs.readFileSync(Config.sslCert),
// ca: [ fs.readFileSync(wo.Config.sslCA) ] // only for self-signed certificate: https://nodejs.org/api/tls.html#tls_tls_createserver_options_secureconnectionlistener // ca: [ fs.readFileSync(Config.sslCA) ] // only for self-signed certificate: https://nodejs.org/api/tls.html#tls_tls_createserver_options_secureconnectionlistener
}, server).listen(portHttps, function (err) { }, server).listen(portHttps, function (err) {
if (err) console.log(err) if (err) console.log(err)
else console.log(`[${new Date().toJSON()}] Server listening on [${wo.Config.protocol}] https://${wo.Config.host}:${portHttps} with IPv4=${ipv4} for ${server.settings.env} environment`) else console.log(`[${new Date().toJSON()}] Server listening on [${Config.protocol}] https://${Config.host}:${portHttps} with IPv4=${ipv4} for ${server.settings.env} environment`)
}) })
} }
} else if ('http2https' === wo.Config.protocol) { } else if ('http2https' === Config.protocol) {
wo.Config.port = wo.Config.port || 80
webServer = require('http').createServer(server.all('*', function (ask, reply) { /* 错误的API调用进入这里。*/ webServer = require('http').createServer(server.all('*', function (ask, reply) { /* 错误的API调用进入这里。*/
reply.redirect(`https://${wo.Config.host}`) reply.redirect(`https://${Config.host}`)
})).listen(wo.Config.port, function (err) { })).listen(portHttp, function (err) {
if (err) console.log(err) if (err) console.log(err)
else console.log(`[${new Date().toJSON()}] Server listening on ${wo.Config.protocol}://${wo.Config.host}:${wo.Config.port} with IPv4=${ipv4} for ${server.settings.env} environment`) else console.log(`[${new Date().toJSON()}] Server listening on ${Config.protocol}://${Config.host}:${portHttp} with IPv4=${ipv4} for ${server.settings.env} environment`)
}) })
} }
})() }
// ==================== // ====================
function getMyIp() { function getMyIp() {
var ipv4=null const os = require('os')
let ipv4 = null
try { try {
var ifaces = os.networkInterfaces() let ifaces = os.networkInterfaces()
Object.keys(ifaces).forEach(function (ifname) { Object.keys(ifaces).forEach(function (ifname) {
ifaces[ifname].forEach(function (iface) { ifaces[ifname].forEach(function (iface) {
if ('IPv4' === iface.family && iface.internal === false) { if ('IPv4' === iface.family && iface.internal === false) {
@ -191,4 +149,4 @@ function getMyIp() {
console.log('ERROR in getMyIP(): '+e.message) console.log('ERROR in getMyIP(): '+e.message)
} }
return ipv4 return ipv4
} })()