74e7a6e5c1
This PR allows someone to define a `region` key in `_config.yml` so that upload works correctly via `s3-sync`. Why? [`s3-sync`](https://github.com/hughsk/s3-sync) uses [`knox`](https://github.com/LearnBoost/knox) to handle S3 commands. Unless your are uploading to `us-standard`, the upload will fail because the S3 url won't be correct.
62 lines
947 B
Markdown
62 lines
947 B
Markdown
# S3 deployer plugin for [Hexo](http://zespia.tw/hexo/)
|
|
|
|
This plugin can deploy your blog via S3.
|
|
|
|
## Usage
|
|
|
|
### Install
|
|
|
|
```
|
|
npm install hexo-deployer-s3 --save
|
|
```
|
|
|
|
### Enable
|
|
|
|
Add `hexo-deployer-s3` to `plugins` in `_config.yml`.
|
|
|
|
``` yaml
|
|
plugins:
|
|
- hexo-deployer-s3
|
|
```
|
|
|
|
### Configure
|
|
|
|
Add `bucket`, `aws_key` and `aws_secret` to `deploy` in `_config.yml`.
|
|
|
|
```
|
|
deploy:
|
|
type: s3
|
|
bucket: <S3 bucket>
|
|
aws_key: <AWS id key>
|
|
aws_secret: <AWS secret key>
|
|
concurrency: <number of connections> //Optional
|
|
region: <region> //Optional, see https://github.com/LearnBoost/knox#region
|
|
```
|
|
|
|
### Disable
|
|
|
|
Remove `hexo-deployer-s3` from `plugins` in `_config.yml`.
|
|
|
|
``` yaml
|
|
plugins:
|
|
- hexo-deployer-s3
|
|
```
|
|
|
|
### Update
|
|
|
|
Execute the following command.
|
|
|
|
```
|
|
npm update
|
|
```
|
|
|
|
### Uninstall
|
|
|
|
Execute the following command. Don't forget to disable the plugin before uninstalling.
|
|
|
|
```
|
|
npm uninstall hexo-deployer-s3
|
|
```
|
|
|
|
[Hexo]: http://zespia.tw/hexo
|