mirror of
https://github.com/jason5ng32/MyIP.git
synced 2026-11-04 08:55:47 +00:00
jason5ng32andClaude Fable 5
9a534e6497
SECURITY.md used to ask for vulnerability reports in public issues while requesting no public disclosure in the same breath; it now points at GitHub's private advisory form, states the latest-release-only support policy and scopes out non-code findings. The Code of Conduct's enforcement contact — a literal blank since the file landed — now uses the same private form. New SUPPORT.md and an issue-chooser config send questions to Discussions Q&A and docs before they become issues, and CONTRIBUTING drops its stale "questions also go to Issues" line. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
42 lines
2.1 KiB
Markdown
42 lines
2.1 KiB
Markdown
# Getting help
|
|
|
|
Start with the docs, then pick the channel that matches what you need.
|
|
|
|
## Documentation first
|
|
|
|
The **[MyIP Docs Center](https://docs.ipcheck.ing)** covers most questions, in English,
|
|
中文, français and русский:
|
|
|
|
- **[Developer Guide](https://docs.ipcheck.ing/developer)** — deployment (Node, Docker,
|
|
Vercel), MaxMind setup, reverse proxies and `ALLOWED_DOMAINS`, environment variables,
|
|
architecture.
|
|
- **[Knowledge Base](https://docs.ipcheck.ing/knowledge-base)** — what each tool measures
|
|
and how to read its results.
|
|
|
|
Two settings account for most self-hosting problems: MaxMind credentials (without them
|
|
the MaxMind source returns 503) and `ALLOWED_DOMAINS` (without it every request from a
|
|
non-localhost domain gets 403).
|
|
|
|
## Where to ask
|
|
|
|
| You want to… | Go to |
|
|
|---|---|
|
|
| Ask how to do something, or why a result looks odd | [Discussions → Q&A](https://github.com/jason5ng32/MyIP/discussions/categories/q-a) |
|
|
| Report a bug you can reproduce | [New issue → Bug report](https://github.com/jason5ng32/MyIP/issues/new?template=bug_report.md) |
|
|
| Suggest a feature | [New issue → Feature request](https://github.com/jason5ng32/MyIP/issues/new?template=feature_request.md) |
|
|
| Report a security vulnerability | [Private advisory](https://github.com/jason5ng32/MyIP/security/advisories/new) — see [SECURITY.md](SECURITY.md) |
|
|
| Contribute code or a translation | [CONTRIBUTING.md](CONTRIBUTING.md) · [TRANSLATING.md](TRANSLATING.md) |
|
|
|
|
There are no chat channels — everything happens on GitHub, in the open, so the next
|
|
person with the same question can find the answer.
|
|
|
|
## Making your question answerable
|
|
|
|
Deployment questions need: how you're running it (Docker / Node / Vercel), the version,
|
|
what you set for `ALLOWED_DOMAINS` and MaxMind, and the backend terminal output.
|
|
Page questions need: browser, what you saw versus what you expected, and any errors from
|
|
the browser console.
|
|
|
|
MyIP is maintained by one person in their spare time. Replies aren't instant, and a
|
|
question that already contains the details above gets answered a lot sooner.
|