1MUNIN-GET(1)          User Contributed Perl Documentation         MUNIN-GET(1)
2
3
4

Name

6       munin-get - a simple tool for managing plugins from remote repositories
7

Features

9       The small management tool "munin-get" supports the following actions:
10
11       clone one or more git repositories containing munin plugins
12       multiple remote repositories can be used
13       list all found plugins (including change timestamp and description)
14       "install" a plugin (by default to: /var/lib/munin/munin-get-plugins)
15       "enable" a plugin (create a symlink to /etc/munin/plugins/)
16       upgrade plugins (and review changes before)
17
18       The primary purpose of this tool is the simplification of the process
19       of using plugins from munin's contrib repository.
20

Usage

22       All actions except "install", "enable" and "disable" can be run as a
23       regular user.  Please note that the non-privileged commands use
24       directories relative to $HOME by default (can be overridden).  Thus
25       sudo or a similar tool should be used for gaining privileges.  Of
26       course, everything can also be done as root.
27
28       The separate "install" step works around potential problems with
29       systemd hardening flags or other security policies, which may prevent
30       files in /root/ or below /home/ from being accessed by the "munin-node"
31       service process.
32

Examples

34   Discover, inspect, install, enable and test a plugin
35           munin-get update
36           munin-get list
37           munin-get search throughput
38           munin-get doc contrib/traffic
39           munin-get install contrib/traffic
40           munin-get enable contrib/traffic
41           munin-run traffic
42           service munin-node restart   # for systemd: systemctl restart munin-node
43
44   Review and apply changes from the upstream repository
45           munin-get update
46           munin-get list-upgradeable
47           munin-get diff-upgradeable
48           munin-get upgrade
49
50   Add custom 3rd party git repositories
51           munin-get add-repository foo http://example.org/repos/munin-plugins.git
52           munin-get add-repository bar http://example.org/repos/munin-stuff.git branch-tested plugins/
53           munin-get update
54

Internals

56       Repositories are cloned below ~/.cache/munin/munin-get/repositories
57       (see REPOSITORY_CACHE_BASE_DIR).
58
59       Manual changes in the cloned repositories should be avoided.
60
61       The separate "install" and "enable" procedure is necessary due to
62       possible process namespace / hardening features enabled for "munin-
63       node". Thus the target of the symlink is located in a path that can be
64       expected to be usable even for a restricted "munin-node" process.
65
66       Additionally the separate "install" location allows the manual review
67       of upstream changes before applying these locally.
68

Author

70       Lars Kruse <devel@sumpfralle.de>
71

License

73         GPLv3+
74
75
76
77perl v5.34.0                      2021-07-22                      MUNIN-GET(1)
Impressum