X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=README;h=7cdca157a51d613a3670a9a0dffb50ab68cd1f2d;hb=3a5182f49dd2bf9e617566a8a9ec7689db4f4f8b;hp=82b268a82262df0d15c8731c5d9540dee78f4cb4;hpb=ae76aa9dd083489e3d99561ae167ecb3f7b1e50d;p=collection4.git diff --git a/README b/README index 82b268a..7cdca15 100644 --- a/README +++ b/README @@ -53,6 +53,43 @@ Concepts solution integrated in the C code (creating rendered graphics) and / or a JavaScript-based solution which renders graphs in the browser. + In the future it shall be possible to use multiple data providers in + parallel. The vision is to have multiple servers running RRDCacheD. Data is + distributed to those servers using the "Hashed" match of collectd and then a + unified interface is provided via c4. + + +Dependencies +------------ + + c4 currently requires the following libraries: + + * libfcgi + + + * librrd_th (thread-safe version of librrd) + + + * libyajl + + + The "configure" script is currently kept minimal. It may therefore be + necessary to set the CPP- and LD-flags manually. In case of libyajl, which is + not built with libtool, you may need to set the rpath, too. + + +Bugs +---- + + * Sending a FLUSH command to the collectd process is not yet possible. + * "*_get_rrdargs" functions and other RRDtool specific cruft is still all + over the code-base. + * The JSON-based interface is unstable. + * Currently it's not possible to display more than one graph at a time. + (With a very limited and undocumented exception.) + * Speaking of which: There is no documentation. + * ... (to be added) + License ------- @@ -61,6 +98,15 @@ License version 2.1. The exact license terms are available in the file "COPYING" in the top source directory. + c4 includes the JavaScript library "jQuery" which is dual-licensed under the + MIT license and the GPL. The file "share/jquery-1.4.2.min.js" includes a + license header which points you to more detailed information. + + c4 includes the JavaScript libraries "Raphaël" and "gRaphaël" which are + licensed under the MIT license. The files "share/raphael-min.js", + "share/g.raphael-min.js", and "share/g.line-min.js" each include a license + header which points you to more detailed information. + Author ------