juanfont/headscale

[Feature] Setting DisplayName and ProfilePicURL for headscale users

Open

#2,166 opened on 2024年10月2日

GitHub で見る
 (7 comments) (9 reactions) (0 assignees)Go (38,374 stars) (2,104 forks)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
Issue 種別
feature
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3 hours
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
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.