You are here: start » en » Internal Documentation » DokuWiki extensions (WvdS) » Resource » Quickstart: catalogue the first endpoint

Quickstart: catalogue the first endpoint

The shortest way from “the plugin is installed” to “an endpoint is in a searchable list with host, port, folder and tags”. Two steps, about five minutes.

Prerequisites

  • wkresource, wkcore and wkstorage are installed and enabled. The latter two are required, not optional.
  • You are signed in as superuser — the screen is administrators only.
  • Optional: wkvault. With it the syntax of a vault: reference is validated on save; without it the reference is stored unchecked.
This plugin is a label, not a client. It resolves no secret and opens no connection — no SSH session, no SQL query, no Azure DevOps call. There is therefore deliberately no reveal, no connect and no test connection control. Anybody expecting those is looking at the wrong plugin.

Step 1: open the screen and choose the kind

Admin → Resources, directly /doku.php?do=admin&page=wkresource.

Under New resource choose a Kind and then Continue. Available are SSH, RDP, HTTPS, SQL, Azure DevOps and Git. The kind decides which fields appear next and cannot be changed afterwards — an entry of the wrong kind is deleted and created again.

Step 2: fill in the entry

Field What goes in it
Id The entry's key.
Name The label in the list.
Folder The grouping the list can be filtered by.
Tags Comma-separated.
Host, port and the other fields of the kind The connection details.
Secret reference A reference, never the secret itself: vault:<id>, env:<NAME>, file:<path>, enc:<value> or plain:<value>. Leave empty if this resource needs none.

Choose Save.

Check the result

  • The entry is in the Entries table with name, kind, folder, tags, secret reference and changed timestamp.
  • The Secret reference column shows the reference string itself, for example vault:mail-smtp — not the value. There is no route from this list to the value; resolving is wkvault's job, called by whichever plugin actually opens the connection.
  • The filter over Kind, Folder and Tag narrows the list.

Next step

  • wkvault — create the entry the reference points at.
  • wkresource (German) — the package page: the fields per kind and the boundary against wkvault.
en/wiki/dwe/wkresource/quickstart.txt · Last modified: by 0.0.0.0