diff --git a/README b/README index 710c8e57..d71ee4a8 100644 --- a/README +++ b/README @@ -1,39 +1,27 @@ -kronosnet ---------- - - -The TODO list has moved to: https://trello.com/b/Aqq9xJfF/todo - -Please read https://trello.com/c/JQIRSPE2/1-how-to-use-this-board - +Upstream resources +------------------ + +https://github.com/kronosnet/kronosnet/ +https://ci.kronosnet.org/ +https://trello.com/kronosnet (TODO list and activities tracking) +https://goo.gl/9ZvkLS (google shared drive) +https://github.com/kronosnet/knet-ansible-ci +https://lists.kronosnet.org/mailman/listinfo/users +https://lists.kronosnet.org/mailman/listinfo/devel +https://lists.kronosnet.org/mailman/listinfo/commits +https://kronosnet.org/ (web 0.1 style) +IRC: #kronosnet on Freenode Architecture ------------ -Please refer to -http://kronosnet.org/docs/kronosnet_architecture.odp -for a few fancy drawings and schemas - -WARNING -------- +Please refer to the google shared drive Presentations directory for +diagrams and fancy schemas -kronosnet is currently in very early stages of its development. -on-wire and configuration compatibility between versions will not -be guaranteed till 1.0 release. +Running knet on FreeBSD +----------------------- -QUICK SETUP ------------ +knet requires big socket buffers and you need to set: +kern.ipc.maxsockbuf=18388608 +in /etc/sysctl.conf or knet will fail to run. -* build/install -* create /etc/pam.d/kronosnetd - - the users that can login with those credentials will gain access - to kronosnetd read only view of the setup -* add kronosnetadm system group - - user in this group, after login to kronosnetd (auth via pam), will - be allowed to perform configuration tasks within kronosnetd -* start kronosnetd - - there is no requirement for kronosnetd to have a configuration file - to start. Configuration can be created at runtime by: - "telnet localhost 50000" -* always refer to http://kronosnet.org/ user manual for latest - information on how to perform runtime configuration tasks