|
2 | 2 | [![Code Climate][clim-img]][clim-url]
|
3 | 3 | [![NPM][npm-img]][npm-url]
|
4 | 4 |
|
5 |
| -# haraka-plugin-template |
| 5 | +# haraka-message-stream |
6 | 6 |
|
7 |
| -Clone me, to create a new Haraka plugin! |
8 | 7 |
|
9 |
| -# Template Instructions |
10 |
| - |
11 |
| -These instructions will not self-destruct after use. Use and destroy. |
12 |
| - |
13 |
| -See also, [How to Write a Plugin](https://github.com/haraka/Haraka/wiki/Write-a-Plugin) and [Plugins.md](https://github.com/haraka/Haraka/blob/master/docs/Plugins.md) for additional plugin writing information. |
14 |
| - |
15 |
| -## Create a new repo for your plugin |
16 |
| - |
17 |
| -Haraka plugins are named like `haraka-plugin-something`. All the namespace after `haraka-plugin-` is yours for the taking. Please check the [Plugins](https://github.com/haraka/Haraka/blob/master/Plugins.md) page and a Google search to see what plugins already exist. |
18 |
| - |
19 |
| -Once you've settled on a name, create the GitHub repo. On the repo's main page, click the _Clone or download_ button and copy the URL. Then paste that URL into a local ENV variable with a command like this: |
20 |
| - |
21 |
| -```sh |
22 |
| -export MY_GITHUB_ORG=haraka |
23 |
| -export MY_PLUGIN_NAME=haraka-plugin-SOMETHING |
24 |
| -``` |
25 |
| - |
26 |
| -Clone and rename the template repo: |
27 |
| - |
28 |
| -```sh |
29 |
| -git clone [email protected]:haraka/haraka-plugin-template.git |
30 |
| -mv haraka-plugin-template $MY_PLUGIN_NAME |
31 |
| -cd $MY_PLUGIN_NAME |
32 |
| -git remote rm origin |
33 |
| -git remote add origin "[email protected]:$MY_GITHUB_ORG/$MY_PLUGIN_NAME.git" |
34 |
| -``` |
35 |
| - |
36 |
| -Now you'll have a local git repo to begin authoring your plugin |
37 |
| - |
38 |
| -## rename boilerplate |
39 |
| - |
40 |
| -Replaces all uses of the word `template` with your plugin's name. |
41 |
| - |
42 |
| -./redress.sh [something] |
43 |
| - |
44 |
| -You'll then be prompted to update package.json and then force push this repo onto the GitHub repo you've created earlier. |
45 |
| - |
46 |
| - |
47 |
| -# Add your content here |
48 |
| - |
49 |
| -## INSTALL |
50 |
| - |
51 |
| -```sh |
52 |
| -cd /path/to/local/haraka |
53 |
| -npm install haraka-plugin-template |
54 |
| -echo "template" >> config/plugins |
55 |
| -service haraka restart |
56 |
| -``` |
57 |
| - |
58 |
| -### Configuration |
59 |
| - |
60 |
| -If the default configuration is not sufficient, copy the config file from the distribution into your haraka config dir and then modify it: |
61 |
| - |
62 |
| -```sh |
63 |
| -cp node_modules/haraka-plugin-template/config/template.ini config/template.ini |
64 |
| -$EDITOR config/template.ini |
65 |
| -``` |
66 | 8 |
|
67 | 9 | ## USAGE
|
68 | 10 |
|
69 | 11 |
|
70 | 12 | <!-- leave these buried at the bottom of the document -->
|
71 |
| -[ci-img]: https://github.com/haraka/haraka-plugin-template/actions/workflows/ci.yml/badge.svg |
72 |
| -[ci-url]: https://github.com/haraka/haraka-plugin-template/actions/workflows/ci.yml |
73 |
| -[clim-img]: https://codeclimate.com/github/haraka/haraka-plugin-template/badges/gpa.svg |
74 |
| -[clim-url]: https://codeclimate.com/github/haraka/haraka-plugin-template |
75 |
| -[npm-img]: https://nodei.co/npm/haraka-plugin-template.png |
76 |
| -[npm-url]: https://www.npmjs.com/package/haraka-plugin-template |
| 13 | +[ci-img]: https://github.com/haraka/message-stream/actions/workflows/ci.yml/badge.svg |
| 14 | +[ci-url]: https://github.com/haraka/message-stream/actions/workflows/ci.yml |
| 15 | +[clim-img]: https://codeclimate.com/github/haraka/message-stream/badges/gpa.svg |
| 16 | +[clim-url]: https://codeclimate.com/github/haraka/message-stream |
| 17 | +[npm-img]: https://nodei.co/npm/haraka-message-stream.png |
| 18 | +[npm-url]: https://www.npmjs.com/package/haraka-message-stream |
0 commit comments