Simpler server list format, document adding servers in CONTRIBUTING

This commit is contained in:
2026-10-14 11:03:35 +00:00
parent 00e30cb858
commit 9ca55a4d40
3 changed files with 58 additions and 45 deletions
+35 -5
View File
@@ -9,7 +9,8 @@ Issues and pull requests go to the repository on [Gitea](https://git.skysparkle.
## Ways to help
- **Report a bug** — use the *Bug report* template.
- **Suggest a DoH server or blocklist** — use the *DoH server or blocklist* template.
- **Add a DoH server** — add one line to [`servers/servers.txt`](servers/servers.txt), see [Adding a DoH server](#adding-a-doh-server).
- **Suggest a blocklist** — use the *DoH server or blocklist* template.
- **Suggest a feature** — use the *Feature request* template; check [Out of scope](#out-of-scope) first.
- **Fix a translation** — use the *Translation fix* template or send a pull request.
- **Write code** — see [Pull requests](#pull-requests).
@@ -35,12 +36,41 @@ These will not be accepted:
- Logging, uploading or sharing users' DNS queries.
- Features that require Google Play Services or a proprietary SDK.
## DoH servers and blocklists
## Adding a DoH server
- **DoH servers** must be public, support RFC 8484 and publish a privacy policy.
- **Blocklists** must be public, actively maintained and licensed for this kind of use.
The server list lives in [`servers/servers.txt`](servers/servers.txt). The app downloads it when the user taps **Update server list**, so a new server reaches users without a new release.
Include links to the server's documentation or the list's homepage in the request.
To add a server, open the file on Gitea, click **Edit**, add one line at the end and send it as a pull request:
```
Name | DoH URL | Privacy policy | h3
```
- **Name** — how the server appears in the app, up to 40 characters.
- **DoH URL** — the full `https://` address of the DoH endpoint.
- **Privacy policy** — an `https://` link to the operator's privacy policy. Lines without one are ignored.
- **h3** — optional. Add it only if the server supports HTTP/3.
Example:
```
Example DNS | https://dns.example.org/dns-query | https://example.org/privacy | h3
```
The server must:
- be public and free, without an account;
- support RFC 8484;
- publish what it logs, and not sell or share query data;
- be run by a non-profit, a community or an individual rather than a large company.
Before sending, check that it works: in the app choose **Custom server**, enter the URL and tap **Test server**.
Please don't change the lines of the servers that ship with the app (SkySparkle, Quad9, Digitale Gesellschaft, UncensoredDNS, Freifunk München): the app always keeps their built-in addresses. If you are unsure whether a server fits, open an issue with the *DoH server or blocklist* template instead.
## Blocklists
Blocklist presets must be public, actively maintained and licensed for this kind of use. Use the *DoH server or blocklist* template and include a link to the list's homepage.
## Translations