mirror of
https://github.com/pluginsGLPI/example.git
synced 2025-05-04 18:08:42 +02:00
54 lines
1.8 KiB
Markdown
54 lines
1.8 KiB
Markdown
# Example Plugin for GLPI
|
|
|
|
## Introduction
|
|
|
|
This plugin aims to introduce how to interact with glpi HOOKS.
|
|
Most of implemented features are for example and do nothing.
|
|
|
|
## Why and when to make a plugin? It is necessary to make a plugin when:
|
|
|
|
* We want to manage inventory items or more additional fields on existing objects.
|
|
* We want to change some behavior standards GLPI (block changes to certain fields, search for data in an external source, etc.)
|
|
|
|
## What features are provided by a plugin?
|
|
|
|
* [Plugins features](https://github.com/pluginsGLPI/example/wiki/Features)
|
|
* [Version Management for plugins](https://github.com/pluginsGLPI/example/wiki/Version-management)
|
|
|
|
## Create a new plugin for GLPI
|
|
|
|
* [Create a plugin](https://github.com/pluginsGLPI/example/wiki/Create-a-plugin)
|
|
|
|
## Ressources
|
|
|
|
* [Reserved ranges of Item type for plugins]
|
|
* [Hooks provided by plugins]
|
|
* [CSRF Protection]
|
|
|
|
## Migrations :
|
|
|
|
* 0.85 -> 0.90
|
|
* 0.84 -> 0.85
|
|
* 0.83 -> 0.84
|
|
* 0.80 -> 0.83
|
|
* 0.78 -> 0.80
|
|
* 0.72 -> 0.78
|
|
|
|
## How to make a plugin available?
|
|
|
|
Create a repository on the provider of your choice (github.com, gitlab.org, git.framasoft.org, etc).
|
|
Once it is created, you will have every opportunity to manage its evolution as you want:
|
|
|
|
* git or svn project-specific (plugin)
|
|
* Wiki
|
|
* Published Release
|
|
* Adding people in the project team
|
|
|
|
## How to see his plugin published in the catalog?
|
|
|
|
* Add to the root of your git master the plugin XML file that describes it (see http://plugins.glpi-project.org/#/submit)
|
|
* Add logo/screenshosts in png on your git master and target it in your xml.
|
|
* Submit the url of raw xml of your plugin in the catalogue http://plugins.glpi-project.org/#/submit
|
|
* The manager team will recieve a mail and after a check of your plugin and xml, it will be available in lists.
|
|
|