Skip to content

docs(nethforge): add Vaultwarden module documentation - #288

Open
GeneraBlack wants to merge 1 commit into
NethServer:mainfrom
BLS-ISP:docs-nethforge-vaultwarden
Open

GeneraBlack wants to merge 1 commit into
NethServer:mainfrom
BLS-ISP:docs-nethforge-vaultwarden

Conversation

@GeneraBlack

@GeneraBlack GeneraBlack commented Oct 21, 2026 •

Copy link
Copy Markdown

Add NethForge administrator documentation page for the Vaultwarden module (docs/administrator-manual/nethforge/vaultwarden.md).

@stephdl

stephdl commented Oct 23, 2026

Copy link
Copy Markdown
Contributor

Hi, thanks for writing the docs together with the module. The page follows the layout of the other NethForge pages, which is good.

The steps describe the UI well. What is missing is what the module does behind the UI. For a password manager, admins need to know this before they put it in production. Please add the points below. Some of them depend on fixes I asked for in NethServer/ns8-nethforge#46, so it makes sense to update both PRs together.

Fix in the existing text

Step 3 says the admin password is "automatically converted to an Argon2id PHC hash". That is not always true. If hashing fails, bin/write-config falls back to the clear token and only logs an info line. Please reword this step, or change the module so the configure action fails instead of falling back.

Please add a "Known limitations" section

You can use the Passbolt page as an example. I would expect at least:

  • If an LDAP domain is selected, the /admin panel is enabled even when the Admin Panel toggle is off. The LDAP sync needs it. Admins must know this, because it exposes /admin on the public hostname.
  • The NS8 UI is the only source of truth. Settings that NS8 manages (domain, SMTP, signups, push, admin token...) are removed from config.json on the next configure or restart. Changes made for these settings in /admin are lost.
  • The LDAP integration only sends email invitations to domain users. Users do not log in with their LDAP password. Vaultwarden keeps its own master password.
  • Invitations, LDAP sync and signup verification need the cluster smarthost to be configured. Without it, no email is sent.

Please add a "Backup and restore" section

A short note is enough. Say what is backed up (the vaultwarden-data volume with the SQLite database and attachments) and how restore behaves. Please wait for the restore fix in the module before writing it, so the docs match the real behavior.

Smaller suggestions

  • Step 6 links https://bitwarden.com/host as inline code. A real link would be easier to use. A short note on choosing between the US and EU push relay would help too.
  • A sentence on how to reach the web vault after setup (https://<hostname>/) and the admin panel (https://<hostname>/admin) would help new users.
  • For anything beyond NS8 integration, a link to the upstream Vaultwarden wiki is enough, like other pages do with their upstream docs.

Tooling

If you use a coding agent, our skills at https://github.com/NethServer/agents can help. nethserver-ns8-module covers the module side, and nethserver-pr covers PR descriptions.

Thanks again! Once the module PR is updated, ping me and I will review both.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants