docs: add Zeabur one-click deployment guide#217
Open
faithleysath wants to merge 1 commit intotiann:mainfrom
Open
docs: add Zeabur one-click deployment guide#217faithleysath wants to merge 1 commit intotiann:mainfrom
faithleysath wants to merge 1 commit intotiann:mainfrom
Conversation
Add documentation for deploying HAPI Hub on Zeabur with one-click deployment. Includes setup steps, environment variables, and Telegram integration instructions. Closes tiann#216 via [HAPI](https://hapi.run) Co-Authored-By: HAPI <noreply@hapi.run>
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
|
|
||
| 1. Click [One-Click Deploy](https://zeabur.com/templates/7L445I) to create the service | ||
| 2. Configure the required environment variables: | ||
| - `PUBLIC_DOMAIN` - Your desired domain (a free `zeabur.app` domain is provided) |
There was a problem hiding this comment.
[MAJOR] Docs correctness: wrong env var name
Why this is a problem: PUBLIC_DOMAIN is not read by the hub; the documented env var for public URL is HAPI_PUBLIC_URL, so following these steps leaves the hub unaware of its public URL.
Suggested fix:
- - `PUBLIC_DOMAIN` - Your desired domain (a free `zeabur.app` domain is provided)
+ - `HAPI_PUBLIC_URL` - Public URL for external access (use your `zeabur.app` domain)
There was a problem hiding this comment.
Findings
- [Major] Wrong env var name for public URL —
PUBLIC_DOMAINis not read by the hub;HAPI_PUBLIC_URLis the supported env var, so the steps as written won't configure the public URL. Evidencedocs/guide/installation.md:149
Suggested fix:- - `PUBLIC_DOMAIN` - Your desired domain (a free `zeabur.app` domain is provided) + - `HAPI_PUBLIC_URL` - Public URL for external access (use your `zeabur.app` domain)
Summary
- One docs correctness issue: wrong env var name for public URL.
Testing
- Not run (automation)
HAPI Bot
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR adds documentation for deploying HAPI Hub on Zeabur with one-click deployment.
Changes
PUBLIC_DOMAIN,TELEGRAM_BOT_TOKEN)Motivation
Zeabur provides a simple way to deploy HAPI with:
zeabur.app)This makes it easy for users to deploy a publicly accessible HAPI hub without managing servers.
Closes #216