haraka-plugin-firebase

    1.0.0 • Public • Published

    Unix Build Status Windows Build Status Code Climate NPM

    haraka-plugin-firebase

    Clone me, to create a new Haraka plugin!

    firebase Instructions

    These instructions will not self-destruct after use. Use and destroy.

    See also, How to Write a Plugin and 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 page and a Google search to see what plugins already exist.

    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:

    export MY_GITHUB_ORG=haraka
    export MY_PLUGIN_NAME=haraka-plugin-SOMETHING

    Clone and rename the firebase repo:

    git clone git@github.com:haraka/haraka-plugin-firebase.git
    mv haraka-plugin-firebase $MY_PLUGIN_NAME
    cd $MY_PLUGIN_NAME
    git remote rm origin
    git remote add origin "git@github.com:$MY_GITHUB_ORG/$MY_PLUGIN_NAME.git"

    Now you'll have a local git repo to begin authoring your plugin

    rename boilerplate

    Replaces all uses of the word firebase 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

    cd /path/to/local/haraka
    npm install haraka-plugin-firebase
    echo "firebase" >> 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:

    cp node_modules/haraka-plugin-firebase/config/firebase.ini config/firebase.ini
    $EDITOR config/firebase.ini

    USAGE

    Install

    npm i haraka-plugin-firebase

    DownloadsWeekly Downloads

    2

    Version

    1.0.0

    License

    MIT

    Unpacked Size

    11.6 kB

    Total Files

    16

    Last publish

    Collaborators

    • digimbyte