Boiler is a tool to create, distribute, install, and update unRAID packages (plugins) easily. It extends Slackware's native package system to provide conveniences to devs (like config persistence) as well as users (like no need to reboot when installing or removing a package and easy updating).
Visit the registry to see all available packages.
Install for unRAID
curl -s http://getboiler.com/install | sh
convert PLG # Convert a plg to boiler package deploy DIR HOST # Pack and copy to an unRAID machine (for testing) help [COMMAND] # Describe available commands or one specific command info NAME # Get info on installed package init [DIRECTORY] # Create a boiler.json in the specified directory install NAME [VERSION] # Install a package by name list [NAME] # List installed packages open NAME # Open a package's homepage pack DIR # Pack a directory for distribution register NAME URL # Register a package remove NAME # Remove (uninstall) a package search NAME # Search for packages update NAME [VERSION] # Update package by name version # Prints version
Creating a package
The simplest package is just directory with a boiler.json file. This project is a boiler package itself (meta!).
- Create a directory for your project
boiler initin that directory
Registering a package
Boiler packages use git as the distribution mechanism. Your package must be a publicly available git repo (Github recommended, but not required).
boiler register NAME URL, where NAME is the name of your package, and URL is the git url (use the git:// protocol!)
Maintaining your package
Once a package is registered, it does not need to be updated through boiler. Boiler makes use of git tags (use semver!) to deliver a package version. Commit and tag as normal to release your package.
There are some special files boiler looks for when creating the final package.
config/*.json - (prefix:
If your project has config files, place them here.
bin/*, lib/*, Gemfile* - (prefix:
post_install option in
boiler.json appends lines here. It's okay to create this file to have more complex code and allow
post_install to append simpler parts.
boiler.json - (prefix:
The meat-and-potatoes of a boiler package. It is required to register a package.
README.*, LICENSE* - (prefix:
You should include a readme in your project detailing what your project is, how it install it, where to find configurations, etc.
See this project's boiler.json for a working example.
name string (required) - The name of your package
version string (required) - The version of your package. Should be semver and match git tags
description string - A description of your package. This helps people discover your package.
arch string - Defaults to
build string - Defaults to
authors array - An array of authors/contributors.
license string - Specify a license for your package so people know how they're permitted to use it and any restrictions you're placing on it
homepage string - Url to the project's homepage
dependencies string - A hash of Slackware dependencies (
"openssl": ">=1.0.1c"). May use version constraints
ignore array - Ignore files or directories when building the package
prefix array - Prefix files or directories with a path during packaging. Useful for mapping directories (say
symlink hash - Define files to be symlinked on install
post_install array - Define commands to run during post install
- Convert plgs more accurately
- Setup as gem? Useful for development (convert, pack)
- Refactor helpers, updater, register
Boiler loves contributors!
- Fork it
- Create your feature branch (git checkout -b my-new-feature)
- Commit your changes (git commit -am 'Add some feature')
- Push to the branch (git push origin my-new-feature)
- Create new Pull Request
MIT. Copyright 2014 Nic Aitch