Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 87 lines (55 sloc) 2.533 kb
413b848 @mlavin Porting over templates and Python code.
authored
1 Sick Muse - Collectd Front-end
3811c07 @mlavin Adding basic packaging files.
authored
2 =============================================
42359bf @mlavin Restarting the project with a new name.
authored
3
4 Sick Muse is an open source web application graphing RRD data stored by
5 `collectd <http://collectd.org/>`_.
775d64c @mlavin License information for the project and its requirements.
authored
6
c3da39b @mlavin Add header file install to Travis configuration.
authored
7 .. image::
8 https://secure.travis-ci.org/mlavin/sickmuse.png?branch=master
9 :alt: Build Status
10 :target: https://secure.travis-ci.org/mlavin/sickmuse
11
775d64c @mlavin License information for the project and its requirements.
authored
12
977d8dd @mlavin Expanding on documentation started from the README. See #3
authored
13 Installation Dependencies
775d64c @mlavin License information for the project and its requirements.
authored
14 ----------------------------------------
15
16 Requires Python 2.6 or 2.7 and the following Python libraries:
17
18 - tornado >= 2.4 (Available under Apache v2)
19 - python-rrdtool >= 1.4 (Available under LGPL v3)
20
bbfa296 @mlavin README format.
authored
21 These dependencies do not ship with the library but will be resolved during the install::
775d64c @mlavin License information for the project and its requirements.
authored
22
1d4e056 @mlavin Information about running the server in the README.
authored
23 pip install sickmuse
24
25
26 Running the Server
27 ----------------------------------------
28
29 Sick Muse runs on the `Tornado <http://www.tornadoweb.org/>`_ webserver which is a
30 single-threaded non-blocking server. Once installed you run this server using the ``sickmuse``
bbfa296 @mlavin README format.
authored
31 command::
1d4e056 @mlavin Information about running the server in the README.
authored
32
33 sickmuse
34
35 This will start the server running on the default port ``8282``. You can change the port
bbfa296 @mlavin README format.
authored
36 using the ``--port`` option::
1d4e056 @mlavin Information about running the server in the README.
authored
37
38 sickmuse --port=8080
39
977d8dd @mlavin Expanding on documentation started from the README. See #3
authored
40
3bcae8a @mlavin Adding screenshots.
authored
41 Screenshots
42 ----------------------------------------
43
d74e38a @mlavin Update README images so that they render on Github as well as Read th…
authored
44 .. figure:: https://raw.github.com/mlavin/sickmuse/master/docs/_static/home.png
3bcae8a @mlavin Adding screenshots.
authored
45 :alt: Homepage screenshot
46 :width: 600
47
d74e38a @mlavin Update README images so that they render on Github as well as Read th…
authored
48 Homepage/Host Listing
3bcae8a @mlavin Adding screenshots.
authored
49
d74e38a @mlavin Update README images so that they render on Github as well as Read th…
authored
50 .. figure:: https://raw.github.com/mlavin/sickmuse/master/docs/_static/host.png
3bcae8a @mlavin Adding screenshots.
authored
51 :alt: Host detail screenshot
52 :width: 600
53
d74e38a @mlavin Update README images so that they render on Github as well as Read th…
authored
54 Host Details
55
3bcae8a @mlavin Adding screenshots.
authored
56
977d8dd @mlavin Expanding on documentation started from the README. See #3
authored
57 Documentation
58 ----------------------------------------
59
f370efe @mlavin Fixing small formatting issues and adding release history docs.
authored
60 You can find a complete set of documentation on `Read The Docs <https://sickmuse.readthedocs.org>`_.
775d64c @mlavin License information for the project and its requirements.
authored
61
62
63 License
64 ----------------------------------------
65
66 sickmuse is released under the BSD License. See the
67 `LICENSE <https://github.com/mlavin/sickmuse/blob/master/LICENSE>`_ file for more details.
68
69 In addition to the previously listed Python dependencies, this library makes use of
70 the following projects which are included in the distribution:
71
72 - Twitter Bootstrap (Licensed under Apache v2)
8590b30 @mlavin Adding Backbone and Underscore.
authored
73 - RequireJS (Licensed under BSD/MIT)
775d64c @mlavin License information for the project and its requirements.
authored
74 - jQuery (Licensed under MIT)
75 - Font Awesome (Licensed under CC BY 3.0)
76 - Flot (Licensed under MIT)
8590b30 @mlavin Adding Backbone and Underscore.
authored
77 - Backbone (Licensed under MIT)
78 - Underscore (Licensed under MIT)
775d64c @mlavin License information for the project and its requirements.
authored
79
80
81 Contributing
82 --------------------------------------
83
84 This project is still in its early stages and there may be bugs or rapid
85 changes to the internal APIs. If you think you've found a bug or are interested in
86 contributing to this project check out `sickmuse on Github <https://github.com/mlavin/sickmuse>`_.
Something went wrong with that request. Please try again.