{"id":19387681,"url":"https://github.com/haraka/haraka-plugin-template","last_synced_at":"2025-04-23T23:31:22.003Z","repository":{"id":17069313,"uuid":"80752657","full_name":"haraka/haraka-plugin-template","owner":"haraka","description":"Clone me, to create a new Haraka plugin!","archived":false,"fork":false,"pushed_at":"2025-03-04T17:48:50.000Z","size":8,"stargazers_count":1,"open_issues_count":0,"forks_count":7,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-04-18T02:46:15.262Z","etag":null,"topics":["haraka","haraka-plugin","plugin","template"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/haraka-plugin-template","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/haraka.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-02-02T18:00:04.000Z","updated_at":"2025-03-04T17:48:53.000Z","dependencies_parsed_at":"2025-01-10T11:17:11.817Z","dependency_job_id":null,"html_url":"https://github.com/haraka/haraka-plugin-template","commit_stats":null,"previous_names":[],"tags_count":4,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/haraka%2Fharaka-plugin-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/haraka%2Fharaka-plugin-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/haraka%2Fharaka-plugin-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/haraka%2Fharaka-plugin-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/haraka","download_url":"https://codeload.github.com/haraka/haraka-plugin-template/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250531977,"owners_count":21446095,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["haraka","haraka-plugin","plugin","template"],"created_at":"2024-11-10T10:10:09.892Z","updated_at":"2025-04-23T23:31:21.978Z","avatar_url":"https://github.com/haraka.png","language":"JavaScript","readme":"[![CI Test Status][ci-img]][ci-url]\n[![Code Climate][clim-img]][clim-url]\n\n# haraka-plugin-template\n\nClone me, to create a new Haraka plugin!\n\n## Template Instructions\n\nThese instructions will not self-destruct after use. Use and destroy.\n\nSee 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.\n\n## Create a new repo for your plugin\n\nHaraka 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.\n\nOnce 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:\n\n```sh\nexport MY_GITHUB_ORG=haraka\nexport MY_PLUGIN_NAME=haraka-plugin-SOMETHING\n```\n\nClone and rename the template repo:\n\n```sh\ngit clone git@github.com:haraka/$MY_GITHUB_ORG/$MY_PLUGIN_NAME.git\ncd $MY_PLUGIN_NAME\n```\n\nNow you'll have a local git repo to begin authoring your plugin\n\n## rename boilerplate\n\nReplaces all uses of the word `template` with your plugin's name.\n\n./redress.sh [something]\n\nYou'll then be prompted to update package.json and then force push this repo onto the GitHub repo you've created earlier.\n\n# Add your content here\n\n## INSTALL\n\n```sh\ncd /path/to/local/haraka\nnpm install haraka-plugin-template\necho \"template\" \u003e\u003e config/plugins\nservice haraka restart\n```\n\n### Configuration\n\nIf the default configuration is not sufficient, copy the config file from the distribution into your haraka config dir and then modify it:\n\n```sh\ncp node_modules/haraka-plugin-template/config/template.ini config/template.ini\n$EDITOR config/template.ini\n```\n\n## USAGE\n\n\u003c!-- leave these buried at the bottom of the document --\u003e\n\n[ci-img]: https://github.com/haraka/haraka-plugin-template/actions/workflows/ci.yml/badge.svg\n[ci-url]: https://github.com/haraka/haraka-plugin-template/actions/workflows/ci.yml\n[clim-img]: https://codeclimate.com/github/haraka/haraka-plugin-template/badges/gpa.svg\n[clim-url]: https://codeclimate.com/github/haraka/haraka-plugin-template\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fharaka%2Fharaka-plugin-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fharaka%2Fharaka-plugin-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fharaka%2Fharaka-plugin-template/lists"}