Where do I find the documentation?

[rabol]

Hi

As a new proxmox user it's somewhat difficult to find documentation, e.g. when you are on the main Proxmox.com site, there is no clear link to e.g. https://pve.proxmox.com/pve-docs/ and when you finally find the location, searching does not exists.

e.g. I would like to find documentation on the various DNS plugins and documentation on how to create a new DNS plugin for a dns provider that does not exists.

I have some sort of idea on how the name.com dns plugin is working, but it does not really make much sense as it indicate that I need to use both the plugin and do something on the command line and that defy the idea of a UI - IMO

 

[Chris]

Hi

As a new proxmox user it's somewhat difficult to find documentation, e.g. when you are on the main Proxmox.com site, there is no clear link to e.g. https://pve.proxmox.com/pve-docs/ and when you finally find the location, searching does not exists.

Well, the read the docs button on the start page directly links you to https://www.proxmox.com/en/services/support-services/support#support-resources, containing all the relevant links for further documentation on a per-product basis.

e.g. I would like to find documentation on the various DNS plugins and documentation on how to create a new DNS plugin for a dns provider that does not exists.

I have some sort of idea on how the name.com dns plugin is working, but it does not really make much sense as it indicate that I need to use both the plugin and do something on the command line and that defy the idea of a UI - IMO

A good starting point is https://pve.proxmox.com/pve-docs/pve-admin-guide.html#sysadmin_certificate_management, which explains how to configure the plugins via the UI and also links to https://github.com/acmesh-official/acme.sh/wiki/dnsapi#how-to-use-dns-api for a more in-depth explanation.

 

[rabol]

Well, the read the docs button on the start page directly links you to https://www.proxmox.com/en/services/support-services/support#support-resources, containing all the relevant links for further documentation on a per-product basis.

Thanks for the direction.

Just one small note that you could consider:
When you arrive on the main page you see 3 big boxes, one for each product, in each there is a 'Learn more', which for me is the obvious choice.
From the 'Learn more' page, there is no 'clear' link to the documentation - sure, you can click "Get started", scroll down etc.

A good starting point is https://pve.proxmox.com/pve-docs/pve-admin-guide.html#sysadmin_certificate_management, which explains how to configure the plugins via the UI and also links to https://github.com/acmesh-official/acme.sh/wiki/dnsapi#how-to-use-dns-api for a more in-depth explanation.

I did read the documentation Section 3.12.2 has 10 - 12 Lines about the GUI.

The github page speak about acme.sh not the proxmox version / ui and the github page do assume that you will use the command line.

I use or would like to use Proxmox and the UI, so I would assume that I can do all I need to do in the Proxmox UI and do not need to go to the command line.

I have also read https://pve.proxmox.com/wiki/Developer_Documentation but again, there is no obvious link to how to develop and install a new dns plugin.

However, in section 22.7 of https://pve.proxmox.com/pve-docs/pve-admin-guide.html#sysadmin_certificate_management there is a mentioning of the "pvenode acme plugin add" command and again, not very obvious, and not UI

It would be nice to have a 'Upload new plugin' in the 'Datacenter->ACME' section - I would love to develop the ui for this function my self, but again... It's not obvious where I can find the documentation on how one can customize or extend Proxmox

 

[rabol]

and I just found out that the "pvenode plugin add" command is not for adding my own, but to add one of the existing ones to my node/datacenter

 

[Chris]

It would be nice to have a 'Upload new plugin' in the 'Datacenter->ACME' section - I would love to develop the ui for this function my self, but again... It's not obvious where I can find the documentation on how one can customize or extend Proxmox

If you are interested in developing an new DNS plugin, this might be a good starting point https://git.proxmox.com/?p=proxmox-...1cd115a765e1d1917733db84c21a6c952a441;hb=HEAD

 

[rabol]

I have the acme.sh plugin

If you are interested in developing an new DNS plugin, this might be a good starting point https://git.proxmox.com/?p=proxmox-...1cd115a765e1d1917733db84c21a6c952a441;hb=HEAD

Sorry, my bad if it was not clear: it was the UI in Proxmox that I would like to modify - but as pr. your comment on acme.sh it does not really make sense if Proxmox does not allow custom DNS plugins anyway.

 

[Chris]

it was the UI in Proxmox that I would like to modify

Not sure what you mean exactly. You mentioned name.com as dns provider (which is already present as plugin), all you have to do is to provide the api values as indicated in the docs:

As there are many DNS providers and API endpoints Proxmox VE automatically generates the form for the credentials for some providers. For the others you will see a bigger text area, simply copy all the credentials KEY=VALUE pairs in there.

but as pr. your comment on acme.sh it does not really make sense

Well, I was pointing you to the providers listed at acme.sh as there is were the expected values are documented, maybe I should point you directly to https://github.com/acmesh-official/acme.sh/wiki/dnsapi#dns_namecom so you see which values are expected by the api for that plugin.