juanfont/headscale

[Feature] Setting DisplayName and ProfilePicURL for headscale users

Open

#2,166 建立於 2024年10月2日

在 GitHub 查看
 (7 留言) (9 反應) (0 負責人)Go (38,374 star) (2,104 fork)batch import
CLIenhancementgood first issuehelp wantedno-stale-bot

描述

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

貢獻者指南

技術棧
go
領域
backendcli
議題類型
feature
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 hours
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
fresh
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
Go programmingheadscale user modelCLI command implementationdatabase schema changes
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
60
研究方向
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.