juanfont/headscale

[Feature] Setting DisplayName and ProfilePicURL for headscale users

Open

#2,166 opened on Oct 2, 2024

View on GitHub
 (7 comments) (9 reactions) (0 assignees)Go (38,374 stars) (2,104 forks)batch import
CLIenhancementgood first issuehelp wantedno-stale-bot

Description

Use case

Mostly for niceness and completeness. I would like Headscale to know users by name, so that tailscale whois (and related solutions such as tailscale-nginx-auth) can know the user's display name and profile picture.

The OIDC rework document mentioned that CLI-based login should be able to populate these fields, so I hope the maintainers won't mind me filing this as an issue so it could be easily trackable (and to show that this is in fact desirable, and bikeshed over the minute details of the implementation).

Additionally, I may try my hand at implementing this. (I don't really know Go that well, but how hard could it be?)

Description

One or two commands in the Headscale CLI to set the user's display name and the profile picture. Optionally a way to set these fields on user creation.

Contribution

  • I can write the design doc for this feature
  • I can contribute this feature

How can it be implemented?

Exact subcommand/option names subject to bikeshedding.

$ headscale users set -i 1 --display-name "Vika" --profile-pic-url "https://example.com/vika.png"
$ # Additionally, consider the following, to create a user and set their personal data in one step:
$ headscale users create vika --display-name "Vika" --profile-pic-url "https://example.com/vika.png"

Alternatively:

$ headscale users set-display-name -i 1 Vika
$ headscale users set-profile-pic-url -i 1 https://example.com/vika.png

Contributor guide

Tech stack
go
Domain
backendcli
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Go programmingheadscale user modelCLI command implementationdatabase schema changes
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Examine the headscale CLI command files, particularly for user management, likely in `cmd/headscale/cli/`. Understand how user fields are stored in the database (check `db/` or models). The issue suggests implementing subcommands like `headscale users set display name` or separate commands. Review the OIDC rework document linked for context. The implementation should add fields to the user model, update CLI parsing, and potentially modify user creation. Ensure testing for new commands.
[Feature] Setting DisplayName and ProfilePicURL for headscale users · juanfont/headscale#2166 | Good First Issue