Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/munin-monitoring/munin-plugin-gallery
Build a static website listing munin plugins from a set of configurable sources
https://github.com/munin-monitoring/munin-plugin-gallery
gallery munin plugins
Last synced: about 1 month ago
JSON representation
Build a static website listing munin plugins from a set of configurable sources
- Host: GitHub
- URL: https://github.com/munin-monitoring/munin-plugin-gallery
- Owner: munin-monitoring
- License: gpl-3.0
- Created: 2020-09-23T20:01:17.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2024-06-25T13:47:41.000Z (6 months ago)
- Last Synced: 2024-06-25T15:14:49.754Z (6 months ago)
- Topics: gallery, munin, plugins
- Language: Python
- Homepage:
- Size: 126 KB
- Stars: 2
- Watchers: 7
- Forks: 1
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: COPYING
Awesome Lists containing this project
README
# Munin Plugin Gallery
The plugin gallery generator retrieves [Munin](http://munin-monitoring.org) plugins from configured
sources.
The plugins are parsed and relevant meta data is extracted (programming language, capabilities,
graph categories).
The plugin data is used for generating a static website (via [hugo](https://gohugo.io)).
The default configuration supplied with this generator (see [config.yml](blob/master/config.yml))
is used for the [Munin Plugin Gallery](https://gallery.munin-monitoring.org/).
# Supported plugin source types
* git repository
* archive (e.g. tar.gz)
* local directory
# Hugo export
The configuration and layout of the exported website uses the content of the directory `hugo-base`.
See the [Hugo documentation](https://gohugo.io/documentation/) for details.
You can explore the build result locally by running the following command:
```shell
./plugin-gallery-generator serve
```
# Contribute
You are welcome to contribute to this plugin gallery generator in order to improve the plugin
parser or details of the generated website.
The following sections include hints regarding specific parts of the build process.
## Website layout
Adjust the content of the directory `hugo-base` and rebuild the local website:
```shell
./plugin-gallery-generator serve
```
After the first run you may want to omit the plugin collection in order to speed up the process:
```shell
./plugin-gallery-generator --skip-collect serve
```
## Additional munin plugin sources (repositories)
1. Add an entry to `config.yml`
2. *optional*: specify a human-readable name for the repository in `hugo-base/content/repositories`
3. Test the collection process: `./plugin-gallery-generator --skip-website build`
4. commit the changes and propose a [pull request](https://github.com/munin-monitoring/munin-plugin-gallery/pulls)
In case of problems, you may want to speedup debugging by temporarily removing all other sources
from the list specified in `config.yml`.
## Plugin parser
Adjust the python-based [plugin-gallery-generator](blob/master/plugin-gallery-generator) and
rebuild the plugin tree:
```shell
./plugin-gallery-generator --skip-website build
```
If you want to debug only a few (local) plugins, then you should specify the relevant local
directory in your configuration file (e.g. `config.yml`) in order to reduce processing time:
```yaml
sources:
- name: foo
type: directory
location: your-local-example-directory
```
Alternatively you can output the parsed metadata of single files:
```shell
./plugin-gallery-generator --skip-website --show-metadata --plugin SOME_FILENAME build
```
## Verify changes
After changes of the the parser code you should verify that these changes have the desired effect
on the complete plugin collection. You can do this by generating the metadata before and after
your change by running the following command (hint: redirect the output to a file):
```shell
./plugin-gallery-generator --skip-website --show-metadata build
```
# Dependencies
The file `munin-plugin-gallery-dependencies.equivs` can be used for generating a dummy
dependency deb package. This simplifies the explicit documentation of all required
packages necessary for running the munin plugin generator.
Generate the dependency package:
```sh
equivs-build munin-plugin-gallery-dependencies.equivs
```