plugn

Hook system that lets users extend your application with plugins

  • Owner: dokku/plugn
  • Platform:
  • License:: MIT License
  • Category::
  • Topic:
  • Like:
    0
      Compare:

Github stars Tracking Chart

plugn Build Status

Hook system that lets users extend your application with plugins

Installation

$ wget -qO /tmp/plugn_latest.tgz https://github.com/dokku/plugn/releases/download/v0.3.2/plugn_0.3.2_linux_x86_64.tgz
$ tar xzf /tmp/plugn_latest.tgz -C /usr/local/bin

Usage

$ PLUGIN_PATH=/var/lib/dokku/plugins plugn

Available commands:
  config                       Plugin configuration
  disable                      Disable a plugin
  enable                       Enable a plugin
  help                         Shows help information for a command
  init                         Initialize an empty plugin path
  install                      Install a new plugin from a Git URL
  list                         List all local plugins
  source                       Source commands for sourcable plugins
  trigger                      Triggers hook in enabled plugins
  uninstall                    Remove plugin from available plugins
  update                       Update plugin and optionally pin to commit/tag/branch
  version                      Show version

Building & Testing (in docker)

$ docker-machine create -d virtualbox plugn-dev
$ eval $(docker-machine env plugn-dev)
$ make build-in-docker
$ make test

Plugin directory structure example

ps (plugin name)
├── [-rw-r--r--]  plugin.toml (metadata)
├── [-rwxr-xr-x]  post-deploy (trigger)
├── [-rwxr-xr-x]  post-stop  (trigger)
└── [-rwxr-xr-x]  pre-deploy (trigger)

plugin.toml format example

[plugin name]
description = "plugin description"
version = "0.1.0"

Releases

Anybody can propose a release. First bump the version in Makefile, make sure CHANGELOG.md is up to date, and make sure tests are passing. Then open a Pull Request from master into the release branch. Once a maintainer approves and merges, CircleCI will build a release and upload it to Github.

License

BSD

Main metrics

Overview
Name With Ownerdokku/plugn
Primary LanguageShell
Program languageMakefile (Language Count: 3)
Platform
License:MIT License
所有者活动
Created At2014-10-17 01:53:08
Pushed At2025-06-11 19:11:55
Last Commit At
Release Count28
Last Release Namev0.16.0 (Posted on )
First Release Namev0.1.0 (Posted on )
用户参与
Stargazers Count84
Watchers Count7
Fork Count23
Commits Count351
Has Issues Enabled
Issues Count16
Issue Open Count0
Pull Requests Count140
Pull Requests Open Count3
Pull Requests Close Count63
项目设置
Has Wiki Enabled
Is Archived
Is Fork
Is Locked
Is Mirror
Is Private