59 lines
1.7 KiB
Markdown
59 lines
1.7 KiB
Markdown
# hexo-server
|
|
|
|
[](https://github.com/hexojs/hexo-server/actions?query=workflow%3ATester)
|
|
[](https://www.npmjs.com/package/hexo-server)
|
|
[](https://coveralls.io/r/hexojs/hexo-server?branch=master)
|
|
|
|
Server module for [Hexo].
|
|
|
|
## Installation
|
|
|
|
``` bash
|
|
$ npm install hexo-server --save
|
|
```
|
|
|
|
## Usage
|
|
|
|
``` bash
|
|
$ hexo server
|
|
```
|
|
|
|
Option | Description | Default
|
|
--- | --- | ---
|
|
`-i`, `--ip` | Override the default server IP. | `::` when IPv6 is available, else `0.0.0.0` (note: in most systems, `::` also binds to `0.0.0.0`)
|
|
`-p`, `--port` | Override the default port. | 4000
|
|
`-s`, `--static` | Only serve static files. | false
|
|
`-l`, `--log [format]` | Enable logger. Override log format. | false
|
|
`-o`, `--open` | Immediately open the server url in your default web browser. | false
|
|
|
|
## Options
|
|
|
|
``` yaml
|
|
server:
|
|
port: 4000
|
|
log: false
|
|
ip: 0.0.0.0
|
|
compress: false
|
|
cache: false
|
|
header: true
|
|
serveStatic:
|
|
extensions:
|
|
- html
|
|
```
|
|
|
|
- **port**: Server port
|
|
- **log**: Display request info on the console. Always enabled in debug mode.
|
|
- **ip**: Server IP
|
|
- **compress**: Enable GZIP compression
|
|
- **cache**: Enable cache for rendered content
|
|
- This can speed up server response. However, any changes will no longer take effect in real time.
|
|
- Suitable for production environment only.
|
|
- **header**: Add `X-Powered-By: Hexo` header
|
|
- **serveStatic**: Extra options passed to [serve-static](https://github.com/expressjs/serve-static#options)
|
|
|
|
## License
|
|
|
|
MIT
|
|
|
|
[Hexo]: http://hexo.io/
|