nils-kt / scriptable-proxmox-status Goto Github PK

The project is divided into two parts. The "Server" part and the "Scriptable" part.
Actually self-explanatory. The server part takes care of the connection with Proxmox and reads the status of your virtual machines.
The scriptable part prepares this data and shows it to you.

You don't have to change anything in the server's Javascript code.
You only have to adjust the following config.json. That's it.
And of course don't forget to start the server with node main.js.
Here is the config.json first, then I explain the configuration.

{
  "proxmox": {
    "user": "root@pam!widget",
    "token": "YOURTOKEN",
    "hostname": "HOSTNAME:PORT"
  },
  "webserver": {
    "port": 3000
  },
  "settings": {
    "refresh": 10000
  }
}

In this example, a token with the name "widget" was created.
The field user is self-explanatory, there you enter the username.
In the Token field, enter the token (secret) that you have created.
At Hostname enter the URL where you can reach Proxmox, with Port.

Now the configuration for Proxmox is complete. 🥳
Let's continue with the configuration for the web server.

At Port you enter any port under which our server should be reachable later.
Remember that this port should be reachable from the outside, so that the widget works.

Very good, you can optionally adjust refresh. With the configuration you can define how often the server refreshes the state of your virtual machines (milliseconds).

The configuration from the client is quite simple.
As a test, just try to open the server URL in the browser.
Get the current script for the widget like this: http://IP:PORT/scriptable
After paste the code in Scriptable, run the script. A message window will open
where you have to enter the address of your server once (http://IP:PORT) and then you are ready to go!

Not quite understood yet? No problem! We have prepared a video for you: streamable.com/bhq3ik