# ember-cli-deploy-alioss
> An ember-cli-deploy plugin to upload to Aliyun OSS
Latest version **2.0.0** (published 2022-03-28) · MIT license · 0 weekly downloads
## Install
```sh
npm install ember-cli-deploy-alioss
pnpm add ember-cli-deploy-alioss
yarn add ember-cli-deploy-alioss
bun add ember-cli-deploy-alioss
```
## Health
**Score 15/100 (F)** — status: abandoned.
Positive: no vulnerabilities.
Warnings: low downloads; no types; no esm support.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 2.0.0 |
| Published | 2022-03-28 |
| First published | 2020-04-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 10.* |
| Dependencies | 8 |
| Unpacked size | 15.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | qhe@heyook.com |
| Maintainers | he9qi |
| Keywords | ember-addon, ember-cli-deploy-plugin, deploy, aliyun, oss, aliyun oss |
## Links
- npm: https://www.npmjs.com/package/ember-cli-deploy-alioss
- Repository: https://github.com/he9qi/ember-cli-deploy-alioss
- Homepage: https://github.com/he9qi/ember-cli-deploy-alioss#readme
- Issues: https://github.com/he9qi/ember-cli-deploy-alioss/issues
- npm.io page: https://npm.io/package/ember-cli-deploy-alioss
## Dependencies (8)
- [mime](https://npm.io/package/mime.md) ^2.5.2
- [rsvp](https://npm.io/package/rsvp.md) ^4.8.5
- [lodash](https://npm.io/package/lodash.md) ^4.17.21
- [ali-oss](https://npm.io/package/ali-oss.md) ^6.5.0
- [minimatch](https://npm.io/package/minimatch.md) ^3.0.3
- [core-object](https://npm.io/package/core-object.md) ^2.0.0
- [ember-cli-babel](https://npm.io/package/ember-cli-babel.md) ^5.1.5
- [ember-cli-deploy-plugin](https://npm.io/package/ember-cli-deploy-plugin.md) ^0.2.2
## Recent versions
- 2.0.0 (latest) — 2022-03-28
- 1.0.0 — 2020-04-30
## README
# ember-cli-deploy-alioss
> An ember-cli-deploy [plugin][1] to upload files to Aliyun OSS （阿里云对象储存）.
[](https://travis-ci.org/he9qi/ember-cli-deploy-alioss)
This plugin is originally **a fork** from [ember-cli-deploy-s3][5] to setup [阿里云对象存储 Aliyun OSS](http://oss.aliyun.com/). All credits go to developers in [ember-cli-deploy-s3][5].
## Aliyun OSS Policy Requirements
Make sure to enable your bucket's ACL to public read.
## Quick Start
To get up and running quickly, do the following:
- Ensure [ember-cli-deploy-build][2] is installed and configured.
- Install this plugin
```bash
$ ember install ember-cli-deploy-alioss
```
- Place the following configuration into `config/deploy.js`
```javascript
ENV.alioss = {
accessKeyId: '',
secretAccessKey: '',
bucket: '',
region: ''
}
```
- Run the pipeline
```bash
$ ember deploy
```
## ember-cli-deploy Hooks Implemented
For detailed information on what plugin hooks are and how they work, please refer to the [Plugin Documentation][1].
- `configure`
- `upload`
## Configuration Options
For detailed information on how configuration of plugins works, please refer to the [Plugin Documentation][1].
### accessKeyId (`required`)
The OSS access key for the user that has the ability to upload to the `bucket`.
*Default:* `undefined`
### secretAccessKey (`required`)
The OSS secret for the user that has the ability to upload to the `bucket`.
*Default:* `undefined`
### bucket (`required`)
The OSS bucket that the files will be uploaded to.
*Default:* `undefined`
### region (`required`)
The region the OSS `bucket` is located in.
*Default:* `undefined`
### acl
The ACL to apply to the objects.
*Default:* `public-read`
### prefix
A directory within the `bucket` that the files should be uploaded in to.
*Default:* `''`
### filePattern
Files that match this pattern will be uploaded to S3. The file pattern must be relative to `distDir`.
*Default:* `'**/*.{js,css,png,gif,ico,jpg,map,xml,txt,svg,swf,eot,ttf,woff,woff2}'`
### distDir
The root directory where the files matching `filePattern` will be searched for. By default, this option will use the `distDir` property of the deployment context, provided by [ember-cli-deploy-build][2].
*Default:* `context.distDir`
### distFiles
The list of built project files. This option should be relative to `distDir` and should include the files that match `filePattern`. By default, this option will use the `distFiles` property of the deployment context, provided by [ember-cli-deploy-build][2].
*Default:* `context.distFiles`
### gzippedFiles
The list of files that have been gziped. This option should be relative to `distDir`. By default, this option will use the `gzippedFiles` property of the deployment context, provided by [ember-cli-deploy-gzip][3].
This option will be used to determine which files in `distDir`, that match `filePattern`, require the gzip content encoding when uploading.
*Default:* `context.gzippedFiles`
### manifestPath
The path to a manifest that specifies the list of files that are to be uploaded to S3.
This manifest file will be used to work out which files don't exist on S3 and, therefore, which files should be uploaded. By default, this option will use the `manifestPath` property of the deployment context, provided by [ember-cli-deploy-manifest][4].
*Default:* `context.manifestPath`
## Prerequisites
The following properties are expected to be present on the deployment `context` object:
- `distDir` (provided by [ember-cli-deploy-build][2])
- `distFiles` (provided by [ember-cli-deploy-build][2])
- `gzippedFiles` (provided by [ember-cli-deploy-gzip][3])
- `manifestPath` (provided by [ember-cli-deploy-manifest][4])
## Running Tests
- `npm test`
[1]: http://ember-cli.github.io/ember-cli-deploy/plugins "Plugin Documentation"
[2]: https://github.com/ember-cli-deploy/ember-cli-deploy-build "ember-cli-deploy-build"
[3]: https://github.com/lukemelia/ember-cli-deploy-gzip "ember-cli-deploy-gzip"
[4]: https://github.com/lukemelia/ember-cli-deploy-manifest "ember-cli-deploy-manifest"
[5]: https://github.com/ember-cli-deploy/ember-cli-deploy-s3 "ember-cli-deploy-s3"
---
_Source: https://npm.io/package/ember-cli-deploy-alioss · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._