diff options
Diffstat (limited to 'README.rst')
| -rw-r--r-- | README.rst | 90 |
1 files changed, 59 insertions, 31 deletions
@@ -1,5 +1,3 @@ -Follow Glances on Twitter: `@nicolargo`_ or `@glances_system`_ - =============================== Glances - An eye on your system =============================== @@ -15,10 +13,9 @@ Glances - An eye on your system .. image:: https://pypip.in/d/Glances/badge.png :target: https://pypi.python.org/pypi/Glances/ :alt: Downloads -.. image:: https://d2weczhvl823v0.cloudfront.net/nicolargo/glances/trend.png - :target: https://bitdeli.com/nicolargo -.. image:: https://badges.gitter.im/Join%20Chat.svg - :target: https://gitter.im/nicolargo/glances?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge + + +Follow Glances on Twitter: `@nicolargo`_ or `@glances_system`_ **Glances** is a cross-platform curses-based system monitoring tool written in Python. @@ -34,14 +31,19 @@ Requirements - ``psutil >= 2.0.0`` - ``setuptools`` -Optional dependencies: +Optionals dependencies: - ``bottle`` (for Web server mode) - ``py3sensors`` (for hardware monitoring support) [Linux-only] - ``hddtemp`` (for HDD temperature monitoring support) [Linux-only] - ``batinfo`` (for battery monitoring support) [Linux-only] +- ``pymdstat`` (for RAID support) [Linux-only] - ``pysnmp`` (for SNMP support) - ``zeroconf`` and ``netifaces`` (for the auto discoverer mode) +- ``influxdb`` (for the InfluxDB export module) +- ``statsd`` (for the StatsD export module) +- ``pystache`` (for the action script feature) +- ``docker-py`` (for the Docker monitoring support) [Linux-only] Installation ============ @@ -49,22 +51,28 @@ Installation Glances Auto Install script --------------------------- -To install both dependacies and latest Glances version, just enter the following command line: +To install both dependencies and latest Glances production ready version (aka *master* branch), just enter the following command line: .. code-block:: console curl -L http://bit.ly/glances | /bin/bash -*Note*: Only supported on some GNU/Linux distributions. -If you want to support others distribs, please contribute to `glancesautoinstall`_. +or + +.. code-block:: console + + wget -O- http://bit.ly/glances | /bin/bash + +*Note*: Only supported on some GNU/Linux distributions. If you want to +support other distributions, please contribute to `glancesautoinstall`_. PyPI: The simple way -------------------- -Glances is on `PyPI`_. By using PyPI, you are sure to have the latest +Glances is on ``PyPI``. By using PyPI, you are sure to have the latest stable version. -To install, simply use `pip`_: +To install, simply use ``pip``: .. code-block:: console @@ -73,12 +81,25 @@ To install, simply use `pip`_: *Note*: Python headers are required to install psutil. For example, on Debian/Ubuntu you need to install first the *python-dev* package. +*Note 2*: You can also install the following libs in order to use optionnal features: + +.. code-block:: console + + pip install bottle batinfo https://bitbucket.org/gleb_zhulik/py3sensors/get/tip.tar.gz zeroconf netifaces pymdstat influxdb statsd pystache + To upgrade Glances to the latest version: .. code-block:: console pip install --upgrade Glances +If you need to install Glances in a specific user location, use: + +.. code-block:: console + + export PYTHONUSERBASE=~/mylocalpath + pip install --user Glances + GNU/Linux --------- @@ -101,12 +122,6 @@ To install the binary package: .. code-block:: console - # pkg_add -r py27-glances - -Using pkgng: - -.. code-block:: console - # pkg install py27-glances To install Glances from ports: @@ -119,7 +134,7 @@ To install Glances from ports: OS X ---- -OS X users can install Glances using `Homebrew`_ or `MacPorts`_. +OS X users can install Glances using ``Homebrew`` or ``MacPorts``. Homebrew ```````` @@ -141,13 +156,13 @@ Windows - Install Python for Windows: http://www.python.org/getit/ - Install the psutil library: https://pypi.python.org/pypi?:action=display&name=psutil#downloads -- Install the `colorconsole`_ library: http://code.google.com/p/colorconsole/downloads/list -- Download Glances from here: http://nicolargo.github.io/glances/ +- Install the colorconsole library: https://pypi.python.org/pypi/colorconsole +- Install Glances Download Glances from here: http://nicolargo.github.io/glances/ Source ------ -To install Glances version X.Y from source: +To install Glances from source: .. code-block:: console @@ -162,7 +177,7 @@ on Debian/Ubuntu you need to install first the *python-dev* package. Puppet ------ -You can install Glances using `Puppet`_: https://github.com/rverchere/puppet-glances +You can install Glances using ``Puppet``: https://github.com/rverchere/puppet-glances Usage ===== @@ -173,7 +188,6 @@ For the standalone mode, just run: $ glances - For the Web server mode, run: .. code-block:: console @@ -196,20 +210,36 @@ on the server side and run: on the client one. -You can also detect and display all Glances servers available on your network or defined in the configuration file: +You can also detect and display all Glances servers available on your +network or defined in the configuration file: .. code-block:: console $ glances --browser -And RTFM, always. +and RTFM, always. Documentation ============= For complete documentation see `glances-doc`_. -If you have any question (after RTFM !), please post it on the official Q&A `forum`_. +If you have any question (after RTFM!), please post it on the official Q&A `forum`_. + +Gateway to other services +========================= + +Glances can export stats to: ``CSV`` file, ``InfluxDB`` and ``StatsD`` server. + +How to contribute ? +=================== + +If you want to contribute to the Glances project, read this `Wiki`_ page. + +There is also a chat dedicated to the Glances' developpers: + +.. image:: https://badges.gitter.im/Join%20Chat.svg + :target: https://gitter.im/nicolargo/glances?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge Author ====== @@ -221,12 +251,10 @@ License LGPL. See ``COPYING`` for more details. -.. _psutil: https://code.google.com/p/psutil/ +.. _psutil: https://github.com/giampaolo/psutil .. _glancesautoinstall: https://github.com/nicolargo/glancesautoinstall .. _@nicolargo: https://twitter.com/nicolargo .. _@glances_system: https://twitter.com/glances_system -.. _PyPI: https://pypi.python.org/pypi -.. _pip: http://www.pip-installer.org/ -.. _colorconsole: https://pypi.python.org/pypi/colorconsole .. _glances-doc: https://github.com/nicolargo/glances/blob/master/docs/glances-doc.rst .. _forum: https://groups.google.com/forum/?hl=en#!forum/glances-users +.. _Wiki: https://github.com/nicolargo/glances/wiki/How-to-contribute-to-Glances-%3F |