Skip to content

Commit 8747f91

Browse files
committed
Update test documentation with GitHub secrets
Document the accounts and repo-specific domain names required to run the dynamic DNS tests. Also document the GitHub "secrets" that must be stored for CI testing to work.
1 parent b2e4d73 commit 8747f91

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

test/README-Testing.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,23 @@ For continuous integration testing we have the following:
1010
2. Then runs the `bats` test scripts (all the files with a ".bats" extension) for each OS (alpine, centos6, debian, ubuntu)
1111
3. Runs the `bats` test script against the staging server (using ubuntu docker image and duckdns.org)
1212

13+
Tests can also be triggered manually from the GitHub website.
14+
15+
For dynamic DNS tests, you need accounts on duckdns.org and dynu.com, and need to create 4 domain names in each account.
16+
17+
For duckdns.org:
18+
- Add DUCKDNS_TOKEN to your repository's environment secrets. The value is your account's token
19+
- Add domains <reponame>-centos7-getssl.duckdns.org, wild-<reponame>-centos7.duckdns.org, <reponame>-ubuntu-getssl.duckdns.org, and wild-<reponame>-ubuntu-getssl.duckdns.org
20+
21+
For dynu.com:
22+
- Add DYNU_API_KEY to your repository's environment secrets. The value is your account's API Key.
23+
- Add domains <reponame>-centos7-getssl.freedns.org, wild-<reponame>-centos7.freedns.org, <reponame>-ubuntu-getssl.freedns.org, and wild-<reponame>-ubuntu-getssl.freedns.org
24+
25+
To run dynamic DNS tests outside the CI environment, you need accounts without <reponame> in the domain names. Export the environment variable corresponding to the secrets (with the same values).
26+
27+
For individual accounts, <reponame> is your github account name.
28+
29+
1330
## To run all the tests on a single OS
1431

1532
1. Start `pebble` and `challtestsrv` using ```docker-compose up -d --build```

0 commit comments

Comments
 (0)