Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/haraka/haraka-plugin-template
Clone me, to create a new Haraka plugin!
https://github.com/haraka/haraka-plugin-template
haraka haraka-plugin plugin template
Last synced: about 2 months ago
JSON representation
Clone me, to create a new Haraka plugin!
- Host: GitHub
- URL: https://github.com/haraka/haraka-plugin-template
- Owner: haraka
- License: mit
- Created: 2017-02-02T18:00:04.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2024-05-08T18:23:07.000Z (8 months ago)
- Last Synced: 2024-10-12T16:54:01.456Z (3 months ago)
- Topics: haraka, haraka-plugin, plugin, template
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/haraka-plugin-template
- Size: 2.93 KB
- Stars: 1
- Watchers: 6
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
[![CI Test Status][ci-img]][ci-url]
[![Code Climate][clim-img]][clim-url]
[![NPM][npm-img]][npm-url]
# haraka-plugin-template
Clone me, to create a new Haraka plugin!
## Template Instructions
These instructions will not self-destruct after use. Use and destroy.
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.
## Create a new repo for your plugin
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.
Once you've settled on a name, create the GitHub repo. On the [template repo's main page](https://github.com/haraka/haraka-plugin-template), click the _Use this template_ button and create your new repository. Then paste that URL into a local ENV variable with a command like this:
```sh
export MY_GITHUB_ORG=haraka
export MY_PLUGIN_NAME=haraka-plugin-SOMETHING
```
Clone and rename the template repo:
```sh
git clone [email protected]:haraka/$MY_PLUGIN_NAME.git
cd $MY_PLUGIN_NAME
```
Now you'll have a local git repo to begin authoring your plugin
## rename boilerplate
Replaces all uses of the word `template` with your plugin's name.
./redress.sh [something]
You'll then be prompted to update package.json and then force push this repo onto the GitHub repo you've created earlier.
# Add your content here
## INSTALL
```sh
cd /path/to/local/haraka
npm install haraka-plugin-template
echo "template" >> config/plugins
service haraka restart
```
### Configuration
If the default configuration is not sufficient, copy the config file from the distribution into your haraka config dir and then modify it:
```sh
cp node_modules/haraka-plugin-template/config/template.ini config/template.ini
$EDITOR config/template.ini
```
## USAGE
[ci-img]: https://github.com/haraka/haraka-plugin-template/actions/workflows/ci.yml/badge.svg
[ci-url]: https://github.com/haraka/haraka-plugin-template/actions/workflows/ci.yml
[clim-img]: https://codeclimate.com/github/haraka/haraka-plugin-template/badges/gpa.svg
[clim-url]: https://codeclimate.com/github/haraka/haraka-plugin-template
[npm-img]: https://nodei.co/npm/haraka-plugin-template.png
[npm-url]: https://www.npmjs.com/package/haraka-plugin-template