Skip to content

Commit 08386d1

Browse files
committed
update readme
1 parent e8aecc5 commit 08386d1

2 files changed

Lines changed: 8 additions & 8 deletions

File tree

subdomains/README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
# Subdomains (by Boy132 & HarlequinSin)
22

3-
Allows users to create and manage custom subdomains for their game servers using Cloudflare DNS.
3+
Allows users to create and manage custom subdomains (A/AAAA or SRV) for their game servers using Cloudflare DNS.
44

5-
## Features
5+
## Setup
66

7-
- Create custom subdomains for game servers
8-
- Cloudflare DNS integration for automatic record management
9-
- Admin management of Cloudflare domains
10-
- Per-server subdomain limits
7+
Create a Cloudflare API token and enter it via the plugin settings.
8+
The token needs to have read permissions for `Zone.Zone` and write for `Zone.Dns`. For better security you can also set the `Zone Resources` to exclude certain domains and add the panel ip to the `Client IP Address Filtering`.
9+
10+
Note: You can't create subdomains for servers with `0.0.0.0` or `::` as allocation!
1111

1212
## SRV Records
1313

1414
In order to create SRV records instead of A/AAAA you need to do the following:
1515

1616
1. Set a `SRV target` for the node
17-
2. Add a [SRV service type](https://github.com/pelican-dev/plugins/blob/main/subdomains/src/Enums/SRVServiceType.php#L10-L16) to the features of the egg, e.g. `srv-minecraft`
17+
2. Add a [SRV service type](https://github.com/pelican-dev/plugins/blob/main/subdomains/src/Enums/SRVServiceType.php#L10-L15) to the features of the egg. The format is `srv-` and then the service name, e.g. `srv-minecraft` or `srv-rust`.

subdomains/lang/en/strings.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
'sync' => 'Sync',
2222

2323
'api_token' => 'Cloudflare API Token',
24-
'api_token_help' => 'The token needs to have read permissions for Zone.Zone and write for Zone.Dns. For better security you can also set the "Zone Resources" to exclude certain domains and add the panel ip to the "Client IP Adress Filtering".',
24+
'api_token_help' => 'The token needs to have read permissions for Zone.Zone and write for Zone.Dns. For better security you can also set the "Zone Resources" to exclude certain domains and add the panel ip to the "Client IP Address Filtering".',
2525

2626
'notifications' => [
2727
'synced' => 'Domain synced with cloudflare',

0 commit comments

Comments
 (0)