# MyProx
A simple web frontend for accessing and managing VMs running on Proxmox VE. It is targeted on end-users.
---
## Main Features
- List all VMs a user has permissions on
- Manage VM state, e.g. starting and stopping
- Open SPICE console (virt-viewer)
- Authentication against Proxmox
- Web frontend has responsive design
- Does not require root privileges
- Built on light-weight CherryPy framework
- No JavaScript bloat; no external font/JS includes
- Simple installation using pip, few dependencies
---
## Installation
Install using PyPi:
```shell
pip3 install myprox
```
---
## Quickstart
After installing "MyProx" as shown above, just execute the tool to get it running:
```shell
myprox
```
Configuration can be done in the file `/etc/myprox/myprox.conf`. A commented example file can be downloaded at <a href="https://github.com/towalink/myprox/blob/main/src/myprox/templates/myprox.conf" target="_blank">https://github.com/towalink/myprox/blob/main/src/myprox/templates/myprox.conf</a>.
---
## Screenshots
<img src="https://raw.githubusercontent.com/towalink/myprox/main/screenshots/list-machines.png" width="450" alt="screenshot: show list of VMs">
See additional screenshots in the "screenshots" folder.
---
## Reporting bugs
In case you encounter any bugs, please report the expected behavior and the actual behavior so that the issue can be reproduced and fixed.
---
## Developers
### Clone repository
Clone this repo to your local machine using `https://github.com/towalink/myprox.git`
Install the module temporarily to make it available in your Python installation:
```shell
pip3 install -e <path to directory with setup.py>
```
---
## License
[](https://opensource.org/licenses/AGPL-3.0)
- **[AGPL3 license](https://opensource.org/licenses/AGPL-3.0)**
- Copyright 2022 © <a href="https://github.com/towalink/myprox" target="_blank">Dirk Henrici</a>.
- Note: This project is not affiliated with [Proxmox](https://www.proxmox.com/), it just accesses its REST API.
Raw data
{
"_id": null,
"home_page": "https://www.github.com/towalink/myprox",
"name": "MyProx",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "Proxmox frontend gui",
"author": "Dirk Henrici",
"author_email": "pypi.myprox@henrici.name",
"download_url": "https://files.pythonhosted.org/packages/20/a0/f957b3d54b2faafa871cf1fc3d1b535721f0d020c45e625e3cc0e083718b/MyProx-0.6.0.tar.gz",
"platform": null,
"description": "# MyProx\n\nA simple web frontend for accessing and managing VMs running on Proxmox VE. It is targeted on end-users.\n\n---\n\n## Main Features\n\n- List all VMs a user has permissions on\n- Manage VM state, e.g. starting and stopping\n- Open SPICE console (virt-viewer)\n- Authentication against Proxmox\n- Web frontend has responsive design\n- Does not require root privileges\n- Built on light-weight CherryPy framework\n- No JavaScript bloat; no external font/JS includes\n- Simple installation using pip, few dependencies\n\n---\n\n## Installation\n\nInstall using PyPi:\n\n```shell\npip3 install myprox\n```\n\n---\n\n## Quickstart\n\nAfter installing \"MyProx\" as shown above, just execute the tool to get it running:\n\n```shell\nmyprox\n```\n\nConfiguration can be done in the file `/etc/myprox/myprox.conf`. A commented example file can be downloaded at <a href=\"https://github.com/towalink/myprox/blob/main/src/myprox/templates/myprox.conf\" target=\"_blank\">https://github.com/towalink/myprox/blob/main/src/myprox/templates/myprox.conf</a>.\n\n---\n\n## Screenshots\n\n<img src=\"https://raw.githubusercontent.com/towalink/myprox/main/screenshots/list-machines.png\" width=\"450\" alt=\"screenshot: show list of VMs\">\n\nSee additional screenshots in the \"screenshots\" folder.\n\n---\n\n## Reporting bugs\n\nIn case you encounter any bugs, please report the expected behavior and the actual behavior so that the issue can be reproduced and fixed.\n\n---\n\n## Developers\n\n### Clone repository\n\nClone this repo to your local machine using `https://github.com/towalink/myprox.git`\n\nInstall the module temporarily to make it available in your Python installation:\n```shell\npip3 install -e <path to directory with setup.py>\n```\n\n---\n\n## License\n\n[](https://opensource.org/licenses/AGPL-3.0)\n\n- **[AGPL3 license](https://opensource.org/licenses/AGPL-3.0)**\n- Copyright 2022 \u00a9 <a href=\"https://github.com/towalink/myprox\" target=\"_blank\">Dirk Henrici</a>.\n- Note: This project is not affiliated with [Proxmox](https://www.proxmox.com/), it just accesses its REST API.\n",
"bugtrack_url": null,
"license": null,
"summary": "simple web frontend for Proxmox VE users",
"version": "0.6.0",
"project_urls": {
"Documentation": "https://www.github.com/towalink/myprox",
"Homepage": "https://www.github.com/towalink/myprox",
"Project homepage": "https://www.henrici.name/projects/myprox",
"Repository": "https://www.github.com/towalink/myprox"
},
"split_keywords": [
"proxmox",
"frontend",
"gui"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e370b074aeb5e09655e6375da59e1beebd3988c4af23de27dc56da288669d892",
"md5": "0cca85e9b4ac950adfa0a202f56b987f",
"sha256": "3f8317e6d861667783fbb154ef2b4340bbe3961d7f280f01fcf0c1ca304df6bd"
},
"downloads": -1,
"filename": "MyProx-0.6.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0cca85e9b4ac950adfa0a202f56b987f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 35050,
"upload_time": "2024-05-05T09:54:48",
"upload_time_iso_8601": "2024-05-05T09:54:48.179665Z",
"url": "https://files.pythonhosted.org/packages/e3/70/b074aeb5e09655e6375da59e1beebd3988c4af23de27dc56da288669d892/MyProx-0.6.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "20a0f957b3d54b2faafa871cf1fc3d1b535721f0d020c45e625e3cc0e083718b",
"md5": "64036a890548dfc1da1af3a6dc1da909",
"sha256": "75897e86324f4c514c3b392371d1a40ed5df60de1af4bc3ec8e02d3b8d2c1813"
},
"downloads": -1,
"filename": "MyProx-0.6.0.tar.gz",
"has_sig": false,
"md5_digest": "64036a890548dfc1da1af3a6dc1da909",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 31630,
"upload_time": "2024-05-05T09:54:53",
"upload_time_iso_8601": "2024-05-05T09:54:53.959767Z",
"url": "https://files.pythonhosted.org/packages/20/a0/f957b3d54b2faafa871cf1fc3d1b535721f0d020c45e625e3cc0e083718b/MyProx-0.6.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-05 09:54:53",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "towalink",
"github_project": "myprox",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "myprox"
}
JSON
