Skip to content

Commit

Permalink
Improve
Browse files Browse the repository at this point in the history
  • Loading branch information
franklupo committed May 28, 2022
1 parent f9df822 commit dc031b2
Show file tree
Hide file tree
Showing 8 changed files with 766 additions and 783 deletions.
4 changes: 3 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -349,4 +349,6 @@ healthchecksdb
MigrationBackup/

# Ionide (cross platform F# VS Code tools) working folder
.ionide/
.ionide/

TestParm.parm
6 changes: 4 additions & 2 deletions .vscode/launch.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,10 @@
"request": "launch",
"preLaunchTask": "build",
// If you have changed target frameworks, make sure to update the program path.
"program": "${workspaceFolder}/src/Corsinvest.ProxmoxVE.Pepper/bin/Debug/netcoreapp3.1/cv4pve-pepper.dll",
"args": [],
"program": "${workspaceFolder}/src/Corsinvest.ProxmoxVE.Pepper/bin/Debug/net6.0/cv4pve-pepper.dll",
"args": [
"@TestParm.parm"
],
"cwd": "${workspaceFolder}/src/Corsinvest.ProxmoxVE.Pepper",
// For more information about the 'console' field, see https://aka.ms/VSCode-CS-LaunchJson-Console
"console": "internalConsole",
Expand Down
677 changes: 663 additions & 14 deletions LICENSE.md

Large diffs are not rendered by default.

70 changes: 45 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,39 +3,40 @@
[![License](https://img.shields.io/github/license/Corsinvest/cv4pve-pepper.svg)](LICENSE.md) [![AppVeyor branch](https://img.shields.io/appveyor/ci/franklupo/cv4pve-pepper/master.svg)](https://ci.appveyor.com/project/franklupo/cv4pve-pepper)

```text
______ _ __
/ ____/___ __________(_)___ _ _____ _____/ /_
/ / / __ \/ ___/ ___/ / __ \ | / / _ \/ ___/ __/
/ /___/ /_/ / / (__ ) / / / / |/ / __(__ ) /_
\____/\____/_/ /____/_/_/ /_/|___/\___/____/\__/
Description:
Launching SPICE on Proxmox VE (Made in Italy)
______ _ __
/ ____/___ __________(_)___ _ _____ _____/ /_
/ / / __ \/ ___/ ___/ / __ \ | / / _ \/ ___/ __/
/ /___/ /_/ / / (__ ) / / / / |/ / __(__ ) /_
\____/\____/_/ /____/_/_/ /_/|___/\___/____/\__/
Usage: cv4pve-pepper [options]
Launching SPICE on Proxmox VE (Made in Italy)
cv4pve-pepper is a part of suite cv4pve.
For more information visit https://www.cv4pve-tools.com
Usage:
cv4pve-pepper [command] [options]
Options:
-?|-h|--help Show help information
--version Show version information
--host The host name host[:port],host1[:port],host2[:port]
--api-token Api token format 'USER@REALM!TOKENID=UUID'. Require Proxmox VE 6.2 or later
--username User name <username>@<realm>
--password The password. Specify 'file:path_file' to store password in file.
--vmid The id or name VM
--proxy SPICE proxy server. This can be used by the client to specify the proxy server.
All nodes in a cluster runs 'spiceproxy', so it is up to the client to choose one.
By default, we return the node where the VM is currently running.
If specify http://[host]:[port] then replace proxy option in file .vv. E.g. for reverse proxy.
--viewer Executable SPICE client remote viewer.
--viewer-options Send options directly SPICE Viewer (quote value).
--host <host> (REQUIRED) The host name host[:port],host1[:port],host2[:port]
--api-token <api-token> Api token format 'USER@REALM!TOKENID=UUID'. Require Proxmox VE 6.2 or later
--username <username> User name <username>@<realm>
--password <password> The password. Specify 'file:path_file' to store password in file.
--vmid <vmid> The id or name VM/CT
--proxy <proxy> SPICE proxy server. This can be used by the client to specify the proxy server. All nodes in a cluster runs
'spiceproxy', so it is up to the client to choose one. By default, we return the node to connect. If specify
http(s)://[host]:[port] then replace proxy option in file .vv. E.g. for reverse proxy.
--viewer <viewer> (REQUIRED) Executable SPICE client remote viewer.
--viewer-options <viewer-options> Send options directly SPICE Viewer (quote value).
--version Show version information
-?, -h, --help Show help and usage information
Commands:
app-check-update Check update application
app-upgrade Upgrade application
Run 'cv4pve-pepper [command] --help' for more information about a command.
cv4pve-pepper is a part of suite cv4pve-tools.
For more information visit https://www.cv4pve-tools.com
```

## Copyright and License
Expand Down Expand Up @@ -71,6 +72,7 @@ this software aims to simplify run SPICE client from Proxmox VE using command li
* Check-Update and Upgrade application
* Use Api token --api-token parameter
* Send options directly to viewer
* Execution with file parameter e.g. @FileParameter.parm

## Api token

Expand Down Expand Up @@ -117,3 +119,21 @@ E.g. --viewer-options "-f" for full screen.
## Error

* **no spice port**: This error appears when you have not configured the display hardware on SPICE.

## Execution with file parameter

Is possible execute with file parameter

```sh
root@debian:~# cv4pve-pepper @FileParameter.parm
```

File **FileParameter.parm**

```txt
--host=192.168.0.100
--username=root@pam
--password=fagiano
--vmid 100
--viewer path-spice-viewer
```

0 comments on commit dc031b2

Please sign in to comment.