SaaShup/netbox-docker-plugin

:children_crossing: Add xtermjs terminal to `Exec` tab in container view

Open

#163 opened on Oct 4, 2024

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Python (12 forks)auto 404
V3V4enhancementgood first issuehelp wanted

Repository metrics

Stars
 (78 stars)
PR merge metrics
 (PR metrics pending)

Description

Netbox version Plugin Version Agent version Docker API Version
3.6.* & 4.* 1.* & 2.* 0.35.* *

Actual Behavior

The Exec tab is built around a text input which sends the command to the agent and then display the logs in a div bellow. The user experience is not that great.

Desired Behavior

Using https://xtermjs.org, we could improve the user experience by providing a fake terminal. For a first iteration, we could have a fake prompt that sends the command to the agent just like now, for a future update (when the agent supports forwarding the pty), we could attach a real shell to the fake terminal.

Contributor guide

Research direction
Investigate the current Exec tab implementation in the Netbox Docker Plugin and integrate xtermjs to create a fake terminal that sends commands to the agent, possibly with a fake prompt.
Tech stack
javascriptpython
Domain
frontendbackend
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.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
JavaScriptNetbox plugin development
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60