summaryrefslogtreecommitdiffstats
path: root/README.rst
diff options
context:
space:
mode:
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst40
1 files changed, 17 insertions, 23 deletions
diff --git a/README.rst b/README.rst
index 059fd379..97778e0c 100644
--- a/README.rst
+++ b/README.rst
@@ -87,7 +87,6 @@ Requirements
- ``defusedxml`` (in order to monkey patch xmlrpc)
- ``packaging`` (for the version comparison)
- ``ujson`` (an optimized alternative to the standard json module)
-- ``pytz`` (for the timezone support)
- ``pydantic`` (for the data validation support)
*Note for Python 2 users*
@@ -122,7 +121,7 @@ Optional dependencies:
- ``pygal`` (for the graph export module)
- ``pymdstat`` (for RAID support) [Linux-only]
- ``pymongo`` (for the MongoDB export module)
-- ``pysnmp`` (for SNMP support)
+- ``pysnmp-lextudio`` (for SNMP support)
- ``pySMART.smartx`` (for HDD Smart support) [Linux-only]
- ``pyzmq`` (for the ZeroMQ export module)
- ``requests`` (for the Ports, Cloud plugins and RESTful export module)
@@ -136,26 +135,27 @@ Installation
There are several methods to test/install Glances on your system. Choose your weapon!
-PyPI: The standard way
-----------------------
+PyPI: Pip, the standard way
+---------------------------
Glances is on ``PyPI``. By using PyPI, you will be using the latest
stable version.
-To install Glances, simply use ``pip``:
+To install Glances, simply use the ``pip`` command line.
+
+Warning: on modern Linux operating systems, you may have an externally-managed-environment
+error message when you try to use ``pip``. In this case, go to the the PipX section bellow.
.. code-block:: console
pip install --user glances
*Note*: Python headers are required to install `psutil`_, a Glances
-dependency. For example, on Debian/Ubuntu **the simplest** is ``apt install python3-psutil`` or alternatively need to install first
+dependency. For example, on Debian/Ubuntu **the simplest** is
+``apt install python3-psutil`` or alternatively need to install first
the *python-dev* package and gcc (*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.
-
By default, Glances is installed without the Web interface dependencies.
To install it, use the following command:
@@ -182,24 +182,18 @@ If you want to test the develop version (could be instable), enter:
pip install --user -i https://test.pypi.org/simple/ Glances
-Glances Auto Install script: the easy way
------------------------------------------
-
-To install both dependencies and the latest Glances production ready version
-(aka *master* branch), just enter the following command line:
-
-.. code-block:: console
+PyPI: PipX, the alternative way
+-------------------------------
- curl -L https://bit.ly/glances | /bin/bash
+Install PipX on your system (apt install pipx on Ubuntu).
-or
+Install Glances (with all features):
.. code-block:: console
- wget -O- https://bit.ly/glances | /bin/bash
+ pipx install 'glances[all]'
-*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`_.
+The glances script will be installed in the ~/.local/bin folder.
Docker: the cloudy way
----------------------
@@ -257,8 +251,8 @@ Run the container in *Web server mode*:
For a full list of options, see the Glances `Docker`_ documentation page.
-GNU/Linux
----------
+GNU/Linux package
+-----------------
`Glances` is available on many Linux distributions, so you should be
able to install it using your favorite package manager. Be aware that