iocage-plugin-index

A boutique set of community iocage plugins for FreeNAS, TrueOS, and FreeBSD

This project takes inspiration and direction from iXsystems' ix-plugin-hub index, which acts as the official community plugins for FreeNAS and TrueOS.

CI
License

Table of Contents

• Creating Plugins
• Installing Plugins
  • Using A Local File
  • Pulling From The Internet
• Code of Conduct
• Issues
• Contributing
• Release History
• Authors
• License

Creating Plugins

Add a plugin JSON file to this repo along with an appropriate icon in the icons directory.

After creating the JSON file and adding an icon, add the plugin to the INDEX file. If the plugin is approved, it appears in the list of iocage plugins.

For more detailed information on creating a plugin, see Create a Plugin.

Installing Plugins

Using A Local File

Install a plugin using a local file:

iocage fetch -P /path/to/local/file.json ip4_addr="vnet0|$ipaddress"

where $ipaddress is the desired IP address for the plugin. For example, ip4_addr="vnet0|10.238.4.196".

Pulling From The Internet

Install a plugin from the internet:

iocage fetch \
  -P gitea \
  -g https://github.com/fnichol/iocage-plugin-index \
  ip4_addr="vnet0|$ipaddress"

where $ipaddress is the desired IP address for the plugin. For example, ip4_addr="vnet0|192.168.0.91"

Code of Conduct

This project adheres to the Contributor Covenant code of conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to fnichol@nichol.ca.

Issues

If you have any problems with or questions about this project, please contact us through a GitHub issue.

Contributing

You are invited to contribute to new features, fixes, or updates, large or small; we are always thrilled to receive pull requests, and do our best to process them as fast as we can.

Before you start to code, we recommend discussing your plans through a GitHub issue, especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing.

Release History

This project uses a "deployable main" strategy, meaning that the main branch is assumed to be working and production ready. As such there is no formal versioning process and therefore also no formal changelog documentation.

Authors

Created and maintained by Fletcher Nichol (fnichol@nichol.ca).

License

Licensed under the Mozilla Public License Version 2.0 (LICENSE.txt).

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the MPL-2.0 license, shall be licensed as above, without any additional terms or conditions.

Note the contents of this project fall under the above license, however the liked plugin projects contain their own respective licenses.