diff options
Diffstat (limited to 'README.rst')
-rw-r--r-- | README.rst | 120 |
1 files changed, 56 insertions, 64 deletions
@@ -57,14 +57,21 @@ add new plugins or exports modules. Requirements ============ -- ``python 2.7,>=3.4`` +- ``python>=2.7`` or ``python>=3.4`` - ``psutil>=5.3.0`` (better with latest version) +*Note for Python 2.6 users* + +Glances no longer supports Python 2.6. Please upgrade +to a minimum Python version of 2.7/3.4+ or downgrade to Glances 2.6.2 (last version +with Python 2.6 support). + Optional dependencies: - ``bernhard`` (for the Riemann export module) - ``bottle`` (for Web server mode) - ``cassandra-driver`` (for the Cassandra export module) +- ``chevron`` (for the action script feature) - ``couchdb`` (for the CouchDB export module) - ``docker`` (for the Docker monitoring support) [Linux/macOS-only] - ``elasticsearch`` (for the Elastic Search export module) @@ -73,74 +80,44 @@ Optional dependencies: - ``influxdb-client`` (for the InfluxDB version 2 export module) [Only for Python >= 3.6] - ``kafka-python`` (for the Kafka export module) - ``netifaces`` (for the IP plugin) -- ``nvidia-ml-py3`` (for the GPU plugin) +- ``py3nvml`` (for the GPU plugin) [Only for Python 3] - ``pika`` (for the RabbitMQ/ActiveMQ export module) - ``potsdb`` (for the OpenTSDB export module) - ``prometheus_client`` (for the Prometheus export module) - ``py-cpuinfo`` (for the Quicklook CPU info module) - ``pygal`` (for the graph export module) - ``pymdstat`` (for RAID support) [Linux-only] -- ``pySMART.smartx`` (for HDD Smart support) [Linux-only] - ``pysnmp`` (for SNMP support) -- ``pystache`` (for the action script feature) +- ``pySMART.smartx`` (for HDD Smart support) [Linux-only] - ``pyzmq`` (for the ZeroMQ export module) - ``requests`` (for the Ports, Cloud plugins and RESTful export module) - ``scandir`` (for the Folders plugin) [Only for Python < 3.5] +- ``sparklines`` (for the Quick Plugin sparklines option) - ``statsd`` (for the StatsD export module) - ``wifi`` (for the wifi plugin) [Linux-only] - ``zeroconf`` (for the autodiscover mode) -*Note for Python 2.6 users* - -Glances no longer supports Python 2.6. Please upgrade -to a minimum Python version of 2.7/3.4+ or downgrade to Glances 2.6.2 (last version -with Python 2.6 support). - -*Note for CentOS Linux 6 and 7 users* - -Python 2.7 and 3.4 are now available via SCL repositories. See: -https://lists.centos.org/pipermail/centos-announce/2015-December/021555.html. - Installation ============ There are several methods to test/install Glances on your system. Choose your weapon! -Glances Auto Install script: the total way ------------------------------------------- - -To install both dependencies and the latest Glances production ready version -(aka *master* branch), just enter the following command line: - -.. code-block:: console - - curl -L https://bit.ly/glances | /bin/bash - -or - -.. code-block:: console - - wget -O- https://bit.ly/glances | /bin/bash - -*Note*: This is only supported on some GNU/Linux distributions and Mac OS X. -If you want to support other distributions, please contribute to `glancesautoinstall`_. - PyPI: The simple way -------------------- Glances is on ``PyPI``. By using PyPI, you will be using the latest stable version. -To install, simply use ``pip``: +To install Glances, simply use ``pip``: .. code-block:: console - pip install glances + pip install --user glances -*Note*: Python headers are required to install `psutil`_. For example, -on Debian/Ubuntu you need to install first the *python-dev* package. -For Fedora/CentOS/RHEL install first *python-devel* package. For Windows, -just install psutil from the binary installation file. +*Note*: Python headers are required to install `psutil`_, a Glances +dependencie. For example, on Debian/Ubuntu you need to install first +the *python-dev* package (*python-devel* on Fedora/CentOS/RHEL). +For Windows, just install psutil from the binary installation file. *Note 2 (for the Wifi plugin)*: If you want to use the Wifi plugin, you need to install the *wireless-tools* package on your system. @@ -150,14 +127,14 @@ features (like the Web interface, exports modules...): .. code-block:: console - pip install 'glances[action,browser,cloud,cpuinfo,docker,export,folders,gpu,graph,ip,raid,snmp,web,wifi]' + pip install --user 'glances[action,browser,cloud,cpuinfo,docker,export,folders,gpu,graph,ip,raid,snmp,web,wifi]' To upgrade Glances to the latest version: .. code-block:: console - pip install --upgrade glances - pip install --upgrade glances[...] + pip install --user --upgrade glances + pip install --user --upgrade glances[...] If you need to install Glances in a specific user location, use: @@ -166,25 +143,50 @@ If you need to install Glances in a specific user location, use: export PYTHONUSERBASE=~/mylocalpath pip install --user glances +If you are administrator and want to install Glances for all users: + +.. code-block:: console + + sudo pip install glances + The current develop branch is also published to the test.pypi.org package index. If you want to test the develop version, enter: .. code-block:: console - pip install -i https://test.pypi.org/simple/ Glances + pip install --user -i https://test.pypi.org/simple/ Glances + + +Glances Auto Install script: the total way +------------------------------------------ + +To install both dependencies and the latest Glances production ready version +(aka *master* branch), just enter the following command line: + +.. code-block:: console + + curl -L https://bit.ly/glances | /bin/bash + +or + +.. code-block:: console + + wget -O- https://bit.ly/glances | /bin/bash + +*Note*: This is only supported on some GNU/Linux distributions and Mac OS X. +If you want to support other distributions, please contribute to `glancesautoinstall`_. Docker: the funny way --------------------- -A Glances container is available. It includes the latest development -HEAD version. You can use it to monitor your server and all your other -containers! +Glances containers are availables. You can use it to monitor your +server and all your other containers! -Get the Glances container (latest develop branch): +Get the Glances container: .. code-block:: console - docker pull nicolargo/glances:dev + docker pull nicolargo/glances:latest Note, you can choose another branch with : @@ -196,14 +198,14 @@ Run the container in *console mode*: .. code-block:: console - docker run --rm -v /var/run/docker.sock:/var/run/docker.sock:ro --pid host --network host -it nicolargo/glances:dev + docker run --rm -v /var/run/docker.sock:/var/run/docker.sock:ro --pid host --network host -it nicolargo/glances:latest Additionally, if you want to use your own glances.conf file, you can create your own Dockerfile: .. code-block:: console - FROM nicolargo/glances:dev + FROM nicolargo/glances:latest COPY glances.conf /glances/conf/glances.conf CMD python -m glances -C /glances/conf/glances.conf $GLANCES_OPT @@ -212,7 +214,7 @@ docker run options: .. code-block:: console - docker run -v `pwd`/glances.conf:/glances/conf/glances.conf -v /var/run/docker.sock:/var/run/docker.sock:ro --pid host -it nicolargo/glances:dev + docker run -v `pwd`/glances.conf:/glances/conf/glances.conf -v /var/run/docker.sock:/var/run/docker.sock:ro --pid host -it nicolargo/glances:latest Where \`pwd\`/glances.conf is a local directory containing your glances.conf file. @@ -221,7 +223,7 @@ variable setting parameters for the glances startup command): .. code-block:: console - docker run -d --restart="always" -p 61208-61209:61208-61209 -e GLANCES_OPT="-w" -v /var/run/docker.sock:/var/run/docker.sock:ro --pid host nicolargo/glances:dev + docker run -d --restart="always" -p 61208-61209:61208-61209 -e GLANCES_OPT="-w" -v /var/run/docker.sock:/var/run/docker.sock:ro --pid host nicolargo/glances:latest GNU/Linux --------- @@ -231,7 +233,6 @@ able to install it using your favorite package manager. Be aware that when you use this method the operating system `package`_ for `Glances` may not be the latest version. - FreeBSD ------- @@ -239,7 +240,7 @@ To install the binary package: .. code-block:: console - # pkg install py27-glances + # pkg install py37-glances To install Glances from ports: @@ -279,15 +280,6 @@ then run the following command: $ pip install glances -Alternatively, you could clone the repository and install with the following command. - -.. code-block:: console - - $ git clone https://github.com/nicolargo/glances.git - $ cd glances - $ python setup.py install - - Android ------- |