# egg-acm

> Aliyun ACM(Application Configuration Management) plugin for Egg.js

Latest version **3.0.0** (published 2019-01-11) · MIT license · 0 weekly downloads

## Install

```sh
npm install egg-acm
pnpm add egg-acm
yarn add egg-acm
bun add egg-acm
```

## 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 | 3.0.0 |
| Published | 2019-01-11 |
| First published | 2018-06-29 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=8.0.0 |
| Dependencies | 1 |
| Unpacked size | 10.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 7 |
| Author | gxcsoccer |
| Maintainers | czy88840616, gxcsoccer, shuang6 |
| Keywords | egg, eggPlugin, egg-plugin |

## Links

- npm: https://www.npmjs.com/package/egg-acm
- Repository: https://github.com/eggjs/egg-acm
- Homepage: https://github.com/eggjs/egg-acm#readme
- Issues: https://github.com/eggjs/egg/issues
- npm.io page: https://npm.io/package/egg-acm

## Dependencies (1)

- [acm-client](https://npm.io/package/acm-client.md) ^3.0.0

## Recent versions

- 3.0.0 (latest) — 2019-01-11
- 2.0.0 — 2018-10-11
- 1.0.7 — 2018-10-09
- 1.0.6 — 2018-08-25
- 1.0.5 — 2018-08-25
- 1.0.4 — 2018-08-10
- 1.0.3 — 2018-07-05
- 1.0.2 — 2018-07-05
- 1.0.1 — 2018-06-29
- 1.0.0 — 2018-06-29

## README

# egg-acm

[![NPM version][npm-image]][npm-url]
[![build status][travis-image]][travis-url]
[![Test coverage][codecov-image]][codecov-url]
[![David deps][david-image]][david-url]
[![Known Vulnerabilities][snyk-image]][snyk-url]
[![npm download][download-image]][download-url]

[npm-image]: https://img.shields.io/npm/v/egg-acm.svg?style=flat-square
[npm-url]: https://npmjs.org/package/egg-acm
[travis-image]: https://img.shields.io/travis/eggjs/egg-acm.svg?style=flat-square
[travis-url]: https://travis-ci.org/eggjs/egg-acm
[codecov-image]: https://img.shields.io/codecov/c/github/eggjs/egg-acm.svg?style=flat-square
[codecov-url]: https://codecov.io/github/eggjs/egg-acm?branch=master
[david-image]: https://img.shields.io/david/eggjs/egg-acm.svg?style=flat-square
[david-url]: https://david-dm.org/eggjs/egg-acm
[snyk-image]: https://snyk.io/test/npm/egg-acm/badge.svg?style=flat-square
[snyk-url]: https://snyk.io/test/npm/egg-acm
[download-image]: https://img.shields.io/npm/dm/egg-acm.svg?style=flat-square
[download-url]: https://npmjs.org/package/egg-acm

Application Configuration Management (ACM), formerly known as Taobao's internal configuration center Diamond, is an application configuration center that enables you to centralize the management of application configurations, and accomplish real-time configuration push in a distributed environment. With ACM, you can greatly reduce the workload of configuration management and enhance service capabilities in scenarios such as microservices, DevOps, and big data.

## Install

```bash
$ npm i egg-acm --save
```

## Usage

```js
// {app_root}/config/plugin.js
exports.acm = {
  enable: true,
  package: 'egg-acm',
};
```

## Configuration

```js
// {app_root}/config/config.default.js
exports.acm = {
  endpoint: 'acm.aliyun.com', // Available in the ACM console
  namespace: '**********',    // Available in the ACM console
  accessKey: '**********',    // Available in the ACM console
  secretKey: '**********',    // Available in the ACM console
  requestTimeout: 6000,       // Request timeout, 6s by default
};
```

see [config/config.default.js](config/config.default.js) for more detail.

## Example

you can access [acm-client](https://github.com/acm-group/acm-sdk-nodejs#api) api via `app.acm` or `ctx.acm`
```js
// get config
const content= await app.acm.getConfig('test', 'DEFAULT_GROUP');
console.log('getConfig = ',content);

// subscription
app.acm.subscribe({
  dataId: 'test',
  group: 'DEFAULT_GROUP',
}, content => {
  console.log(content);
});

// publish config
const content= await app.acm.publishSingle('test', 'DEFAULT_GROUP', '测试');
console.log('getConfig = ',content);

// delete config
await acm.remove('test', 'DEFAULT_GROUP');
```

## Questions & Suggestions

Please open an issue [here](https://github.com/eggjs/egg/issues).

## License

[MIT](LICENSE)

---
_Source: https://npm.io/package/egg-acm · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._