{"id":22938249,"url":"https://github.com/dappnode/certificates-server","last_synced_at":"2025-09-13T00:39:21.988Z","repository":{"id":53019926,"uuid":"310621993","full_name":"dappnode/certificates-server","owner":"dappnode","description":"API to issue dappnode subdomain certificates","archived":false,"fork":false,"pushed_at":"2023-10-11T12:59:01.000Z","size":147,"stargazers_count":3,"open_issues_count":2,"forks_count":2,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-07-01T09:07:24.927Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dappnode.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2020-11-06T14:38:58.000Z","updated_at":"2022-10-20T19:29:48.000Z","dependencies_parsed_at":"2025-07-01T09:07:24.702Z","dependency_job_id":"1d5158da-481e-482b-872f-5c12f82796fc","html_url":"https://github.com/dappnode/certificates-server","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/dappnode/certificates-server","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dappnode%2Fcertificates-server","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dappnode%2Fcertificates-server/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dappnode%2Fcertificates-server/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dappnode%2Fcertificates-server/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dappnode","download_url":"https://codeload.github.com/dappnode/certificates-server/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dappnode%2Fcertificates-server/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":274902406,"owners_count":25371076,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-09-12T02:00:09.324Z","response_time":60,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-14T12:16:36.964Z","updated_at":"2025-09-13T00:39:21.967Z","avatar_url":"https://github.com/dappnode.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# dappnode-cert-api\n\n## Build docker image\n\n```bash\ndocker build -t dappnode-cert-api .\n```\n\nRun the server using docker\n\n```bash\ndocker run -p 5000:5000 -v \"\u003cPATH\u003e\":/etc/letsencrypt/creds.ini:ro dappnode-cert-api\n```\n\nwhere `\u003cPATH\u003e` is the path to the `creds.ini` file on your host machine eg.\n\n```\n# Target DNS server\ndns_rfc2136_server = ns.yourdomain.com\n# Target DNS port\ndns_rfc2136_port = 53\n# TSIG key name\ndns_rfc2136_name = \u003cprivate key name\u003e\n# TSIG key secret\ndns_rfc2136_secret = \u003cprivate key\u003e\n# TSIG key algorithm\ndns_rfc2136_algorithm = HMAC-SHA512\n```\nNote: Even though it is not necessary, it is a good practice to have whole `/etc/letsencrypt` folder mounted as a volume since all certificates are stored there. \n## Run tests\n\n```bash\ndocker run --rm -it -p 5000:5000 \\\n    -v \"\u003cPATH\u003e\":/etc/letsencrypt/creds.ini:ro \\\n    -e DEBUG=1 dappnode-cert-api test\n```\n\nExample:\n\n```bash\ndocker run --rm -it -p 5000:5000 \\\n    -v \"$(pwd)/creds.ini\":/etc/letsencrypt/creds.ini:ro \\\n    -e DEBUG=1 dappnode-cert-api test\n```\n\n## Configuration environment variables\n\n| Name                  | Default value              | Description                                                                           |\n| --------------------- | -------------------------- | ------------------------------------------------------------------------------------- |\n| BASE_DIR              | /etc/letsencrypt/          | Base directory in which certs are stored                                              |\n| DEBUG                 | false                      | If true, uses fake certificates                                                       |\n| RATE_LIMIT_WINDOW_MS  | 3600000                    | Size of rate limit interval                                                           |\n| RATE_LIMIT_MAX        | 5                          | Max tries in rate limit interval                                                      |\n| DYNDNS_THRESHOLD      | 600                        | Time threshold for validaeting request                                                |\n| RENEWAL_TIME_TRESHOLD | 6500000                    | If two requests for same certificate come within this time, old certificate is resent |\n| LETSENCRYPT_EMAIL     | None                       | Email for letsencrypt account                                                         |\n| CREDS_LOCATION        | /etc/letsencrypt/creds.ini | Location of credentials file                                                          |\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdappnode%2Fcertificates-server","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdappnode%2Fcertificates-server","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdappnode%2Fcertificates-server/lists"}