/addons

Official opeNode addons

openode addons

Official addons on opeNode.io.

An addon must be placed in folder (category): category/addon-name. category must only contains alphanumeric characters and dashes (-). If the category is not currently created, please propose one in the merge request. In the folder, a config.json must be provided, see below. Addons are available on opeNode.io.

config.json schema

Variable Description
name Addon name. Must be unique.
category Category (folder) of the addon
minimum_memory_mb Minimum memory required (MB).
logo_filename Logo filename image of the addon.
documentation_filename Readme filename
image Docker image
requires_persistence true/false. true if the addon requires persistence.
persistent_path If requires_persistence is true, persistent_path corresponds to the mounted folder path which is persisted in the service docker image.
ports List of { target_port, protocol, http_endpoint }.
required_fields Array. Possible values: exported_port, persistent_path
env_variables Key-value pairs of default ENV variables values.
required_env_variables List of required ENV variables.

Contributing

Users are highly welcomed to contribute to this project.

  • Fork this project.
  • Commit and push in the forked project.
  • Create a pull request from the forked project.

Make sure to follow our convention:

See several examples in...