Skip to content

Commit 046ded5

Browse files
author
Jordan
committed
README.md
1 parent d7fea6b commit 046ded5

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,12 @@
1+
[![npm](https://img.shields.io/npm/v/deploy-server-webpack-plugin.svg)](https://www.npmjs.com/package/deploy-server-webpack-plugin) [![npm](https://img.shields.io/npm/dt/deploy-server-webpack-plugin.svg)](https://www.npmjs.com/package/deploy-server-webpack-plugin) [![GitHub](https://img.shields.io/github/license/mashape/apistatus.svg)](https://github.com/mingmingwon/deploy-server-webpack-plugin/blob/master/LICENSE)
2+
13
# Introduction
4+
25
A plugin that deploys webpack bundles to server. It's useful when server ftp/sftp is forbidden or accessing server need pin + dynamic token each time.
36

47
# Install
8+
9+
[![NPM](https://nodei.co/npm/deploy-server-webpack-plugin.png)](https://nodei.co/npm/a-promise-lib/)
510
```
611
npm i deploy-server-webpack-plugin -D
712
```
@@ -30,6 +35,7 @@ module.exports = {
3035
]
3136
};
3237
```
38+
3339
or
3440

3541
```js
@@ -67,6 +73,7 @@ Copy ./server folder to you server machine somewhere, init the project and start
6773
npm i
6874
npm run start
6975
```
76+
7077
Next config your nginx/apache to allow your node service can be accessed.
7178

7279
Try to visit "@your host/receiver" in browser, when you see "Method Not Allowed", it means node server started success, but 'GET' method is not allowed because we only config "POST" router to upload files. Server code is based on Koa, change it according your demand.
@@ -80,7 +87,13 @@ Try to visit "@your host/receiver" in browser, when you see "Method Not Allowed"
8087
|token|String|false|for security if needed|
8188

8289
# Others
90+
8391
Sometimes bundle file is too big and uploading appears "504 Gateay Time-out" or "413 Request Entity Too Large" error, enlarge client_max_body_size value in nginx.conf may solve this problem:
92+
8493
```
8594
client_max_body_size: 10M; #default 1M
8695
```
96+
97+
# License
98+
99+
The MIT License

0 commit comments

Comments
 (0)