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:
15       /var/lib/munin-node/munin-get-plugins)
16       "enable" a plugin (create a symlink to /etc/munin/plugins/)
17       upgrade plugins (and review changes before)
18
19       The primary purpose of this tool is the simplification of the process
20       of using plugins from munin's contrib repository.
21

Usage

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

Examples

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

Internals

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

Author

71       Lars Kruse <devel@sumpfralle.de>
72

License

74         GPLv3+
75
76
77
78perl v5.38.0                      2023-11-06                      MUNIN-GET(1)
Impressum