tabby-web: Run Tabby Terminal in a Browser

Overview

Tabby Web runs the Tabby Terminal as a web application. It also manages multiple configuration files and provides the config sync service for the Tabby app.

SSH and Telnet connections use a separate connection gateway. The project is aimed at users who want to host browser-based terminal access, rather than install and run the terminal only as a local desktop application.

Key Features

• Serves the Tabby terminal through a web app.
• Provides configuration sync for the Tabby app and manages multiple config files.
• Supports social login through configured providers including GitHub, GitLab, Google, Microsoft, Auth0, and generic OIDC.
• Uses a separate gateway service to provide TCP connections for SSH and Telnet.
• Supports database backends supported by Django, including MariaDB, PostgreSQL, and SQLite.
• Stores application distributions locally or with storage supported by fsspec, including S3 and GCS.

Use Cases

• A team wants to provide browser access to Tabby and centrally manage configuration files.
• A self-hosting administrator wants to run a web-based terminal service and configure an identity provider for login.
• An organization using an OIDC provider wants to connect its existing identity service to Tabby Web.
• A Tabby user wants config sync across app use and can set up the web service and, for SSH or Telnet, a connection gateway.

Project Facts

• Language: Python
• License: MIT
• Stars: 1.5k
• Forks: 185
• Topics: none listed
• Archived: no

Getting Started

For a prebuilt Docker image, run:

docker-compose -f docker-compose.prebuilt.yml up -d

The service starts on port 9090 with MariaDB in the provided setup. Configure OAuth credentials for a login provider, and set up a connection gateway for SSH or Telnet. See the deployment guide and README for configuration and deployment details.

Considerations

The maintainer says they do not currently have time to work on the project or provide support, though fixes and improvements may be submitted as pull requests. Deployment requires a database, storage for app distributions, and authentication credentials. SSH and Telnet require the separate gateway service; the README notes a non-zero man-in-the-middle risk if a hosted gateway is compromised, and suggests hosting your own gateway or Tabby Web instance. Building from source also requires Node.js and can be memory-intensive during frontend compilation.