{"id":13567128,"url":"https://github.com/Eugeny/tabby-web","last_synced_at":"2025-04-04T01:31:04.063Z","repository":{"id":38261430,"uuid":"376269131","full_name":"Eugeny/tabby-web","owner":"Eugeny","description":"Tabby Web - an SSH/Telnet/Serial client in your browser.","archived":false,"fork":false,"pushed_at":"2023-12-30T16:09:22.000Z","size":9612,"stargazers_count":1010,"open_issues_count":65,"forks_count":139,"subscribers_count":10,"default_branch":"master","last_synced_at":"2025-04-03T08:08:47.846Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://tabby.sh","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Eugeny.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2021-06-12T11:05:44.000Z","updated_at":"2025-04-03T01:59:02.000Z","dependencies_parsed_at":"2024-02-16T03:43:29.977Z","dependency_job_id":null,"html_url":"https://github.com/Eugeny/tabby-web","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Eugeny%2Ftabby-web","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Eugeny%2Ftabby-web/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Eugeny%2Ftabby-web/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Eugeny%2Ftabby-web/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Eugeny","download_url":"https://codeload.github.com/Eugeny/tabby-web/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247107816,"owners_count":20884793,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-01T13:02:24.367Z","updated_at":"2025-04-04T01:31:04.028Z","avatar_url":"https://github.com/Eugeny.png","language":"Python","funding_links":[],"categories":["Python","HarmonyOS","others"],"sub_categories":["Windows Manager"],"readme":"# Tabby Web\n\n![](docs/screenshot.png)\n\nThis is the Tabby terminal, served as a web app. It also provides the config sync service for the Tabby app.\n\n# How it works\n\nTabby Web serves the [Tabby Terminal](https://github.com/Eugeny/tabby) as a web application while managing multiple config files, authentication, and providing TCP connections via a [separate gateway service](https://github.com/Eugeny/tabby-connection-gateway).\n\n# Requirements\n\n* Python 3.7+\n* A database server supported by Django (MariaDB, Postgres, SQLite, etc.)\n* Storage for distribution files - local, S3, GCS or others supported by `fsspec`\n\n# Quickstart (using `docker-compose`)\n\nYou'll need:\n\n* OAuth credentials from GitHub, GitLab, Google or Microsoft for authentication.\n* For SSH and Telnet: a [`tabby-connection-gateway`](https://github.com/Eugeny/tabby-connection-gateway) to forward traffic.\n* Docker BuildKit: `export DOCKER_BUILDKIT=1`\n\n```bash\n    docker-compose up -e SOCIAL_AUTH_GITHUB_KEY=xxx -e SOCIAL_AUTH_GITHUB_SECRET=yyy\n```\n\nwill start Tabby Web on port 9090 with MariaDB as a storage backend.\n\nFor SSH and Telnet, once logged in, enter your connection gateway address and auth token in the settings.\n\n## Environment variables\n\n* `DATABASE_URL` (required).\n* `APP_DIST_STORAGE`: a `file://`, `s3://`, or `gcs://` URL to store app distros in.\n* `SOCIAL_AUTH_*_KEY` \u0026 `SOCIAL_AUTH_*_SECRET`: social login credentials, supported providers are `GITHUB`, `GITLAB`, `MICROSOFT_GRAPH` and `GOOGLE_OAUTH2`.\n\n## Adding Tabby app versions\n\n* `docker-compose run tabby /manage.sh add_version 1.0.163`\n\nYou can find the available version numbers [here](https://www.npmjs.com/package/tabby-web-container).\n\n# Development setup\n\nPut your environment vars (`DATABASE_URL`, etc.) in the `.env` file in the root of the repo.\n\nFor the frontend:\n\n```shell\ncd frontend\nyarn\nyarn run build # or yarn run watch\n```\n\nFor the backend:\n\n```shell\ncd backend\npoetry install\n./manage.py migrate # set up the database\n./manage.py add_version 1.0.156-nightly.2 # install an app distribution\nPORT=9000 poetry run gunicorn # optionally with --reload\n```\n\n# Security\n\n* When using Tabby Web for SSH/Telnet connectivity, your traffic will pass through a hosted gateway service. It's encrypted in transit (HTTPS) and the gateway servers authenticate themselves with a certificate before connections are made. However there's a non-zero risk of a MITM if a gateway service is compromised and the attacker gains access to the service's private key.\n* You can alleviate this risk by [hosting your own gateway service](https://github.com/Eugeny/tabby-connection-gateway), or your own copy of Tabby Web altogether.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FEugeny%2Ftabby-web","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FEugeny%2Ftabby-web","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FEugeny%2Ftabby-web/lists"}