Getting Help

1. Check the Docs First

Most problems already have an answer here. Working through these in order is usually the fastest path:

1. FAQ — the high-frequency issues: CGO build failures, database connection problems, dependency install errors, and more;
2. Config Reference — if a setting doesn't seem to take effect, Redis is configured but nothing changes, or the token lifetime looks wrong, check this page first to confirm the field is actually being read;
3. Quick Start — if a step in the startup flow fails, walk back through this page step by step;
4. Search existing issues — search the error text on GitHub issues; a lot of problems have already come up, including in closed issues, so it's worth checking those too.

2. Filing an Issue

If self-service doesn't turn up an answer, open an issue — it's welcome.

Including the following speeds things up considerably; "it errors on startup" alone usually means several rounds of back-and-forth before anyone can start diagnosing:

# 1. Version number
$ ./go-admin version

# 2. Go version and OS
$ go version

Also worth including:

• The full error output, not a single truncated line. Wrap logs in a code block rather than a screenshot — a screenshot can't be searched, so the next person hitting the same problem won't find this issue;
• Steps to reproduce, and at which step it fails;
• The relevant config, with the database password, jwt.secret, and other sensitive fields removed first;
• Database type and version (MySQL / PostgreSQL / SQLite / SQL Server).

3. Contributing

• Found a mistake in the docs? The source for this site is at go-admin-doc — issues and PRs are both welcome;
• Contributing code: the development conventions live in the repository's root-level AGENTS.md; the standard shape for a module is in app/demo/;
• Feature requests: also go through issues — describing the use case helps more than describing the feature itself.

4. Community

This project's most active community channels — WeChat, a QQ group, and a Bilibili channel — are Chinese-language. If you're comfortable there, they're listed on the Chinese version of this page. Otherwise, GitHub issues is the best place to ask in English — it's also searchable and stays useful to the next person with the same question.

5. Commercial Support

For more complete features and technical support, see commercial licensing.