diff options
author | nico <nico@magicbroccoli.de> | 2018-09-04 02:32:57 +0200 |
---|---|---|
committer | nico <nico@magicbroccoli.de> | 2018-09-04 02:32:57 +0200 |
commit | c9e2bc743397229a930c2647d5b59034f9be08c0 (patch) | |
tree | a4ea890f11537962bb92b218928453f65d41a1b0 /README.md |
Initial Commit
+ inital plugins for nextcloud shares and user activity graphs
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..500dd75 --- /dev/null +++ b/README.md @@ -0,0 +1,27 @@ +# Nextcloud Munin Plugin +Some basic Munin Plugins gathering information from the NextCloud external API. + +## install +To use these Plugins one has to add his specific URL and credential to the script. +``` +URL = 'https://URL.TO.YOUR.NEXTCLOUD.tld/ocs/v2.php/apps/serverinfo/api/v1/info' +auth = ('username', 'password or logintoken') +``` +If these are correct the script needs to be placed in the munin directory eg. `/etc/munin/plugins/` + +The munin-node needs to be restarted to facilitate the new plugins. +`systemctl restart munin-node` + +### everything working? +To check if everything is working as expected check if the plugins actually gather data. +``` +telnet localhost 4949 # localhost or IP the munin-node +list +fetch nextcloud_shares +fetch nextcloud_users +``` + +If everything works as it should, list will return `nextcloud_shares` and `nextcloud_users` within the list of other active plugins. The `fetch` commands will run the script and return the gathered values. As long as none of them are NaN everything works as expected. + +### uninstall +To remove the plugins from munin remove both plugins from the directory and restart the node. |