FumeNodes/tabby-web
1
0
Fork 0
mirror of https://github.com/Eugeny/tabby-web.git synced 2026-08-16 22:36:02 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: document pre-built Docker image and add prebuilt compose file

Browse Source 
Add docker-compose.prebuilt.yml that uses the pre-built GHCR image,
making deployment much easier for users who don't need to customize
the build.

Update README to prominently feature the pre-built image option as
the recommended approach, reducing the barrier to entry.

Pre-built images are available at: ghcr.io/eugeny/tabby-web:latest

Fixes #115
This commit is contained in:
Brian Olson
2025-12-31 20:49:53 -05:00
parent 16847cea93
commit cc4d030b73
2 changed files with 59 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@@ -26,13 +26,29 @@ You'll need:
* OAuth credentials from GitHub, GitLab, Google or Microsoft for authentication.
* For SSH and Telnet: a [`tabby-connection-gateway`](https://github.com/Eugeny/tabby-connection-gateway) to forward traffic.
* Docker BuildKit: `export DOCKER_BUILDKIT=1`
## Option 1: Pre-built Image (Recommended)
Use the pre-built image from GitHub Container Registry - no build required:
```bash
docker-compose up -e SOCIAL_AUTH_GITHUB_KEY=xxx -e SOCIAL_AUTH_GITHUB_SECRET=yyy
docker-compose -f docker-compose.prebuilt.yml up -d
```
will start Tabby Web on port 9090 with MariaDB as a storage backend.
The image is available at `ghcr.io/eugeny/tabby-web:latest`.
## Option 2: Build from Source
If you need to customize the build:
```bash
export DOCKER_BUILDKIT=1
docker-compose up -d
```
---
Both options will start Tabby Web on port 9090 with MariaDB as a storage backend.
For SSH and Telnet, once logged in, enter your connection gateway address and auth token in the settings.