knot

knot

Knot is a powerful tool to manage Cloud Development Environment within a Nomad cluster or local environments. It provides a seamless blend of a user-friendly web interface and a command line interface. This dual approach streamlines the deployment process and simplifies access to development environments, making management an effortless endeavor and eliminating the need for each developer to manage their own configurations.

Features

• Web-Based Management Interface: Provides an easy-to-use, browser-based interface for managing environments.
• Visual Studio Code Integration: Allows access to Visual Studio Code right from your browser.
• Code Server Integration: Offers access to Code Server right from your browser.
• Terminal Access: Offers in-browser terminal access for seamless command-line operations.
• Command-Line Tools: Simplifies container access with handy command-line tools.
• User & Permission Management: Effectively manage users and their permissions.
• Groups: Control which templates are available to users.
• Environment Templates: Customizable templates for creating consistent development environments.
• Integration with Nomad: Ensures seamless integration with Nomad for efficient cluster management.
• Local Containers: Run containers on the local machine using Docker or Podman.
• Quotas: Limit by resource usage and by number of spaces per user.
• Development URL Management: Automatically generated URLs for development spaces.
• Support for VNC: Support for web based VNC servers such as KasmVNC.
• Remote Servers Maximize performance by deploying environment close to developers but manage templates and users from anywhere, no single point failure.
• Custom Roles: Create custom roles to manage permissions.
• Sharing: Spaces can be shared with other users allowing SSH and terminal access.
• Logging: Syslog compatible interface allows logging and display within a window.
• Tunneling: Securely expose development environments to the internet when required.
• Local Services Securely connect to services on your local machine from within a space.
• API: Provides an API for integration with other systems.

API Versioning

The API version is specified in the request header:

X-Knot-Api-Version: 2025-03-10

Any non-breaking changes are available in all versions of the API while breaking changes are only available in the latest version of the API.

Security

knot is designed to be used within trusted environments rather than on the open internet, that is it is expected to be run on a private network with developers connecting to the it via a VPN or similar technology.

For complex deployments over many different locations a mesh network may be appropriate.

When tunneling is enabled the tunnel port is separate from the web interface and the agent interface, it is expected that public traffic be directed to the tunnel interface only.

Time-based one-time passwords (TOTP) should be enabled if the web interface is exposed to the internet. The TOTP code works with Google Authenticator, Microsoft Authenticator, and other TOTP apps.

Documentation

Documentation and Getting Started

Icons

Icons are sourced from:

• https://heroicons.com/outline
• https://flowbite.com/icons/
• https://github.com/homarr-labs/dashboard-icons
• https://github.com/devicons/devicon

Legal

Disclaimer: All product names, trademarks, and registered trademarks are the property of their respective owners. Icons are used for identification purposes only and do not imply endorsement.