Skip to main content

local htop-like status monitor for remote Proxmox VE servers

Project description

proxcat

A htop-like status monitor for Proxmox VE servers, powered by python curses, with support for multiple nodes, VM (QEMU) and Container (LXC) status and node status.

Screenshot

connected to my own PVE server

Installation

pip install proxmoxer proxcat

Or, clone repository and run pip install ..

Usage

  1. On your PVE server, create an API token in WebUI under Datacenter -> Permissions -> API Tokens. Remember to deselect "Priviledge Separation". For security concerns, it is recommended to use it with a dedicated low-level user - for example, one with the "PVEAuditor" role assigned - instead of root or other administrators.

  2. Create a config file. proxcat will look for config.ini under

    • $XDG_CONFIG_HOME/proxcat/ or
    • ~/.proxcat/

    Or, you can specify a custom config file with the -c / --config flag.

    Then fill in the config file like this:

    [Account]
    # address of PVE host
    Host = 
    # Username (format: <username>@<realm)
    User = 
    # name of your token
    TokenName = 
    # your token value
    Token = 
    
    [Settings]
    # set data update interval (in ms), optional
    UpdateInterval = 1000
    
  3. run the proxcat command.

Changelog

see CHANGELOG.md.

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

proxcat-0.2.tar.gz (6.3 kB view details)

Uploaded Source

Built Distribution

proxcat-0.2-py3-none-any.whl (7.1 kB view details)

Uploaded Python 3

File details

Details for the file proxcat-0.2.tar.gz.

File metadata

  • Download URL: proxcat-0.2.tar.gz
  • Upload date:
  • Size: 6.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.10.4

File hashes

Hashes for proxcat-0.2.tar.gz
Algorithm Hash digest
SHA256 42c1b37cb6f1b55a5d83921c0f583f6fd8adb4c7103af793ed5a0614896f4b2d
MD5 e822a7ac7790df906c88ecb3f3221fee
BLAKE2b-256 c83af3ea46bb6b39e5e02db26cf1ad3224e117d6066acba6dc1629bd9a14b819

See more details on using hashes here.

File details

Details for the file proxcat-0.2-py3-none-any.whl.

File metadata

  • Download URL: proxcat-0.2-py3-none-any.whl
  • Upload date:
  • Size: 7.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.10.4

File hashes

Hashes for proxcat-0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 581639130508517fac1245166713c339e857201e703f515f6c9d77f74adbbfda
MD5 782b68fb0ea7152e7a0b5bd1fc1443ef
BLAKE2b-256 2902f1ec519c0587ab3ed3c9346b06e151c238c19675fc383a2c6a6290963212

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page