Skip to content

docs: add reverse proxy deployment guide - #8

Merged
darwvin-dev merged 2 commits into
darwvin-dev:mainfrom
wyf027:docs/reverse-proxy-deployment-6
Jun 16, 2026
Merged

docs: add reverse proxy deployment guide#8
darwvin-dev merged 2 commits into
darwvin-dev:mainfrom
wyf027:docs/reverse-proxy-deployment-6

Conversation

@wyf027

@wyf027 wyf027 commented Jun 12, 2026

Copy link
Copy Markdown
Contributor

Summary

Adds a focused reverse proxy deployment guide for GoMyAdmin. The new page covers:

  • PublicURL / GOMYADMIN_PUBLIC_URL behavior
  • NEXT_PUBLIC_ADMIN_API_URL for production frontends
  • Nginx and Caddy examples for /admin/ and /admin/api/
  • HTTPS, cookies, CSRF, upload limits, timeouts, and troubleshooting checks

The guide is linked from the README documentation list.

Related issue

Closes #6

Verification

  • git diff --check
  • go test ./...

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 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".

Comment thread docs/reverse-proxy.md
proxy_send_timeout 120s;
}

location /admin/ {

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge 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 👍 / 👎.

Comment thread docs/reverse-proxy.md
If uploads fail with `413 Request Entity Too Large`, raise the proxy limit before changing application code.

## Timeouts

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge 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 👍 / 👎.

@darwvin-dev
darwvin-dev merged commit 2fb8bd4 into darwvin-dev:main Jun 16, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document reverse proxy deployment

2 participants