diff --git a/README.md b/README.md index 8423202fe..43535fb1e 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,6 @@ License Copyright (C) 2006-2012 Adam Armstrong - Copyright (C) 2013 LibreNMS Contributors This program is free software: you can redistribute it and/or modify @@ -41,11 +40,22 @@ The Debian Social Contract will be the basis of our priority system, and mutual respect the basis of our behaviour towards others. +For more about the culture we're trying to build, please read the Freenode +[guidelines for running an IRC channel][6] and [being a community +catalyst][7]. + + +Documentation +------------- + +For now documentation can be found in the [doc directory][5]. + Installation ------------ -See `INSTALL.md` for details. +See `doc/INSTALL.md` for details. + Contributing ------------ @@ -53,15 +63,15 @@ Contributing You can participate in the project by: - Joining the [librenms-project][1] mailing list to post questions and suggestions. -- Following [@LibreNMS on Twitter][2]. -- Chatting with developers and users on [IRC][3]! We're on the `irc.freenode.net` - server, in the `##LibreNMS` channel. -- Cloning the [repo][4] and filing bug reports and pull requests on github. -- Improving the [wiki][5]. +- Cloning the [repo][2] and filing bug reports and pull requests on github. +- Talking to us on [Twitter][3] or [IRC][4]. +- Improving the [documentation][5]. [1]: https://groups.google.com/forum/#!forum/librenms-project "LibreNMS" -[2]: https://twitter.com/librenms -[3]: irc://irc.freenode.net/##librenms -[4]: https://github.com/librenms/librenms -[5]: https://github.com/librenms/librenms/wiki +[2]: https://github.com/librenms/librenms "Main LibreNMS GitHub repo" +[3]: https://twitter.com/librenms "@LibreNMS on Twitter" +[4]: irc://irc.freenode.net/##librenms "LibreNMS IRC channel" +[5]: https://github.com/librenms/librenms/tree/master/doc/ +[6]: http://freenode.net/channel_guidelines.shtml "Freenode channel guidelines" +[7]: http://freenode.net/catalysts.shtml "Freenode community catalysts" diff --git a/config.php.default b/config.php.default index 2a73fff40..53e4b4569 100755 --- a/config.php.default +++ b/config.php.default @@ -34,8 +34,10 @@ $config['snmp']['community'] = array("public"); $config['auth_mechanism'] = "mysql"; # default, other options: ldap, http-auth #$config['http_auth_guest'] = "guest"; # remember to configure this user if you use http-auth -### List of networks to allow scanning-based discovery -$config['nets'][] = "172.22.0.0/16"; -$config['nets'][] = "192.168.0.0/24"; +### List of RFC1918 networks to allow scanning-based discovery +#$config['nets'][] = "10.0.0.0/8"; +#$config['nets'][] = "172.16.0.0/12"; +#$config['nets'][] = "192.168.0.0/16"; + ?> diff --git a/INSTALL.md b/doc/INSTALL.md similarity index 100% rename from INSTALL.md rename to doc/INSTALL.md diff --git a/INSTALL_RHEL.md b/doc/INSTALL_RHEL.md similarity index 100% rename from INSTALL_RHEL.md rename to doc/INSTALL_RHEL.md diff --git a/doc/ROADMAP.md b/doc/ROADMAP.md new file mode 100644 index 000000000..1205af7ff --- /dev/null +++ b/doc/ROADMAP.md @@ -0,0 +1,18 @@ +Roadmap +------- + +- Device support: + + - Ruckus wireless controllers + + - Investigate generic device support based on MIBs. It should be + possible to do basic graphs based just on the MIB. They would + obviously not be as customised as the specifically supported devices + but should still be useful to users. + +- Investigate solutions for poller performance improvement. + +- Investigate solutions for multiple communities per device. + +- Integrate Nagios-based alerting. +