diff options
Diffstat (limited to 'README.rst')
| -rw-r--r-- | README.rst | 54 |
1 files changed, 25 insertions, 29 deletions
@@ -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,27 +182,21 @@ 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 ------------------------------------------ +PyPI: PipX, the alternative way +------------------------------- -To install both dependencies and the latest Glances production ready version -(aka *master* branch), just enter the following command line: +Install PipX on your system (apt install pipx on Ubuntu). -.. code-block:: console - - curl -L https://bit.ly/glances | /bin/bash - -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 fun way -------------------- +Docker: the cloudy way +---------------------- Glances Docker images are availables. You can use it to monitor your server and all your containers ! @@ -245,9 +239,9 @@ variable setting parameters for the glances startup command): .. code-block:: console - docker run -e TZ="${TZ}" -v `pwd`/glances.conf:/root/.config/glances/glances.conf -v /var/run/docker.sock:/var/run/docker.sock:ro -v /run/user/1000/podman/podman.sock:/run/user/1000/podman/podman.sock:ro --pid host -e GLANCES_OPT="-C /root/.config/glances/glances.conf" -it nicolargo/glances:latest-full + docker run -e TZ="${TZ}" -v $HOME/.config/glances/glances.conf:/glances.conf:ro -v /var/run/docker.sock:/var/run/docker.sock:ro -v /run/user/1000/podman/podman.sock:/run/user/1000/podman/podman.sock:ro --pid host -e GLANCES_OPT="-C /glances.conf" -it nicolargo/glances:latest-full -Where \`pwd\`/glances.conf is a local directory containing your glances.conf file. +Where $HOME/.config/glances/glances.conf is a local directory containing your glances.conf file. Run the container in *Web server mode*: @@ -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 @@ -268,7 +262,8 @@ may not be the latest version and only basics plugins are enabled. Note: The Debian package (and all other Debian-based distributions) do not include anymore the JS statics files used by the Web interface (see ``issue2021``). If you want to add it to your Glances installation, -follow the instructions: ``issue2021comment``. +follow the instructions: ``issue2021comment``. In Glances version 4 and +higher, the path to the statics file is configurable (see ``issue2612``). FreeBSD ------- @@ -490,6 +485,7 @@ Glances is distributed under the LGPL version 3 license. See ``COPYING`` for mor .. _package: https://repology.org/project/glances/versions .. _sponsors: https://github.com/sponsors/nicolargo .. _wishlist: https://www.amazon.fr/hz/wishlist/ls/BWAAQKWFR3FI?ref_=wl_share -.. _issue2021: https://github.com/nicolargo/glances/issues/2021#issuecomment-1197831157 +.. _issue2021: https://github.com/nicolargo/glances/issues/2021 .. _issue2021comment: https://github.com/nicolargo/glances/issues/2021#issuecomment-1197831157 +.. _issue2612: https://github.com/nicolargo/glances/issues/2612 .. _Docker: https://github.com/nicolargo/glances/blob/develop/docs/docker.rst |