Skip to content

Commit

Permalink
docs. Add user portal section to README
Browse files Browse the repository at this point in the history
  • Loading branch information
DavidePrincipi committed Oct 30, 2023
1 parent bec02a0 commit fc79666
Showing 1 changed file with 33 additions and 0 deletions.
33 changes: 33 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,39 @@ Create a new user and assign it to the `developers` group
}
EOF

## User management web portal

The `samba` module provides a public web portal where AD users can
authenticate and change their passwords.

The module registers a Traefik path route, with the domain name as suffix.
For instance:

https://<node FQDN>/users-admin/domain.test/

The backend endpoint is advertised as `users-admin` service and can be
discovered in the usual ways, as documented in [Service
discovery](https://nethserver.github.io/ns8-core/modules/service_providers/#service-discovery).
For instance:

api-cli run module/mymodule1/list-service-providers --data '{"service":"users-admin", "filter":{"domain":"dp.nethserver.net","node":"1"}}'

The event `service-users-admin-changed` is raised when the serivice
becomes available or is changed.

The backend of the module runs under the `api-moduled.service` Systemd
unit supervision. Refer also to `api-moduled` documentation, provided by
`ns8-core` repository.

API implementation code is under `imageroot/api-moduled/handlers/`, which
is mapped to an URL like

https://<node FQDN>/users-admin/domain.test/api/

The `.json` files define the API input/output syntax validation, using the
JSON schema language. As such they can give an idea of request/response
payload structure.

## File server

If Samba binds to the **internal VPN interface** (see `ipaddress`
Expand Down

0 comments on commit fc79666

Please sign in to comment.