docs: add reverse proxy deployment guide - #8
Conversation
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 5cc9f4d1f5
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| proxy_send_timeout 120s; | ||
| } | ||
|
|
||
| location /admin/ { |
There was a problem hiding this comment.
Route the
/admin entry point too
This Nginx location only matches /admin/..., not /admin itself. The generated Next.js app defines an /admin route and the README/getting-started flow tells users to open /admin, so following this example can leave the documented entry point unproxied unless another server block happens to redirect it. Add an exact /admin redirect or proxy rule so both /admin and /admin/... work.
Useful? React with 👍 / 👎.
| If uploads fail with `413 Request Entity Too Large`, raise the proxy limit before changing application code. | ||
|
|
||
| ## Timeouts | ||
|
|
There was a problem hiding this comment.
Mention the backend 10s timeout before recommending 120s
Raising only the proxy timeouts to 120s does not let long exports/uploads run that long in the documented setup: both pkg/server/handler.go and the generated backend install requestTimeout(10 * time.Second), so the backend request context is canceled first. This guidance should call out the application timeout/configuration requirement, otherwise users can follow the deployment guide and still see long operations fail after about 10 seconds.
Useful? React with 👍 / 👎.
…ployment-6 # Conflicts: # README.md
Summary
Adds a focused reverse proxy deployment guide for GoMyAdmin. The new page covers:
PublicURL/GOMYADMIN_PUBLIC_URLbehaviorNEXT_PUBLIC_ADMIN_API_URLfor production frontends/admin/and/admin/api/The guide is linked from the README documentation list.
Related issue
Closes #6
Verification
git diff --checkgo test ./...