headscale icon indicating copy to clipboard operation
headscale copied to clipboard
verified publisher icon juanfont

feat: HTML template to register a node

Open longregen opened this issue 1 year ago • 2 comments

I was trying to get a somewhat non-technical user to access my network. When using the tailscale app on iOS, we got presented with an HTML for registering the node. This was a little shocking in comparison with the rest of the experience.

So, I went on to https://v0.dev; asked it to craft a little QR code registration website, and exported it as a static HTML page. I connected it with https://github.com/davidshimjs/qrcodejs/. I then added some js code to add a copy button. I made sure it all works without javascript. I copied the "embed" approach from the OIDC routes.

This can be a controversial PR; but I think it adds some value. Now, due to how important security is in this project, I'm not sure you will be inclined at all to accept this approach; particularly I'm not happy that:

  • This embeds too much CSS and makes the download pretty heavy (currently sitting at 93kb)
  • It clutters the repository with generated code and makes checkouts heavier
  • It's dubious whether our use case is also important for other headscale users

Here's how it looks like (on dark-mode): Screenshot 2024-06-11 at 12-05-53 Headscale Registration

Without js: Screenshot 2024-06-11 at 12-06-05 Headscale Registration

I would like to know your opinions, and I'm happy to contribute a solution with a different approach that satisfies you. One approach that I thought of involved allowing for the configuration of a templates folder; so that it can be modified at runtime and not compile time.

Looking forward to your comments!

Summary by CodeRabbit

  • New Features

    • Introduced a new registration interface for Headscale nodes with a responsive design.
    • Added functionality for dynamic QR code generation to simplify machine registration.
    • Enabled users to copy registration commands easily from the interface.

  • Improvements

    • Enhanced maintainability of the registration web API by separating HTML content from source code.

longregen avatar Jun 11 '24 10:06 longregen

Walkthrough

The recent changes introduce a new registration template for Headscale nodes, enhancing user experience with a responsive HTML design that utilises Tailwind CSS. The HTML content is embedded within the Go code, improving maintainability by separating the template from the logic. This approach streamlines the registration process, allowing users to register their devices easily through a QR code or command display, while enhancing the overall structure of the codebase.

Changes

Files Change Summary
hscontrol/assets/register_template.html
hscontrol/handlers.go		 Introduced a new HTML template for registration, utilising Tailwind CSS for styling. The HTML is now embedded in Go, replacing an inline string for improved maintainability. The primary functionality remains unchanged.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant WebAPI
    participant Template

    User->>WebAPI: Request registration page
    WebAPI->>Template: Serve register_template.html
    Template->>User: Display registration interface
    User->>Template: Scan QR code or copy command
    Template->>User: Show command for registration

🐇 In fields of green, I hop with glee,
A new template shines, oh can you see?
With QR codes and commands to share,
Registration's a breeze, without a care!
Tailwind’s touch makes it quite a sight,
Hopping along, everything feels just right! 🌼

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

coderabbitai[bot] avatar Aug 20 '24 18:08 coderabbitai[bot]

This was a little shocking in comparison with the rest of the experience

Considering Headscale no UI and CLI approach I am not sure if I would call it "shocking" :P

I am failing to see how having the command encoded into a QR code will help?

In any case, CSS is fine, but embedding tailwindcss is too much, both as an external dependency or embedding.

I am sure someone (or an llm) can vipp up something that we can comfortably add to make it prettier if that is desired.

kradalby avatar Sep 05 '24 11:09 kradalby

Closing due to no response

kradalby avatar Nov 28 '24 09:11 kradalby