{"id":17357055,"url":"https://github.com/dixonwille/aws-ddns","last_synced_at":"2025-04-15T00:29:04.792Z","repository":{"id":76099018,"uuid":"289165737","full_name":"dixonwille/aws-ddns","owner":"dixonwille","description":"AWS API Gateway and Lambda DDNS provider using Rust","archived":false,"fork":false,"pushed_at":"2024-07-24T18:07:49.000Z","size":404,"stargazers_count":10,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-28T12:21:18.108Z","etag":null,"topics":["aws-api-gateway","aws-lambda","aws-route53","ddns-server","rust-lang","rustlang","serverless","serverless-applications"],"latest_commit_sha":null,"homepage":"","language":"Rust","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/dixonwille.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","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},"funding":{"github":"dixonwille"}},"created_at":"2020-08-21T03:12:20.000Z","updated_at":"2024-08-03T09:52:35.000Z","dependencies_parsed_at":"2024-03-05T20:47:50.688Z","dependency_job_id":null,"html_url":"https://github.com/dixonwille/aws-ddns","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dixonwille%2Faws-ddns","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dixonwille%2Faws-ddns/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dixonwille%2Faws-ddns/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dixonwille%2Faws-ddns/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dixonwille","download_url":"https://codeload.github.com/dixonwille/aws-ddns/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248983374,"owners_count":21193551,"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","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":["aws-api-gateway","aws-lambda","aws-route53","ddns-server","rust-lang","rustlang","serverless","serverless-applications"],"created_at":"2024-10-15T18:59:56.842Z","updated_at":"2025-04-15T00:29:04.773Z","avatar_url":"https://github.com/dixonwille.png","language":"Rust","funding_links":["https://github.com/sponsors/dixonwille"],"categories":[],"sub_categories":[],"readme":"# AWS DDNS\n\nUsing AWS API Gateway and Lambda functions, create a DDNS provider for personal use.\n\nThis application is very minimum! It only has two endpoints. One is to create users to be authenticated with and the other is the actual endpoint routers can hit.\n\n## Tools needed\n\n- https://www.serverless.com/framework/docs/getting-started/\n- https://www.serverless.com/plugins/serverless-rust\n    - can use `sls plugin install serverless-rust`\n- https://www.rust-lang.org/tools/install\n    - will also need to run `rustup target add x86_64-unknown-linux-musl` so it can install on local instead of docker\n\n## Deploy\n\nTo deploy this serverless application you will need to setup AWS Credentials (https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html)\n\nAfter that is setup you can install as many stages as you want.\n\nThe following will deploy to the `dev` stage. This stage is useful for testing out changes.\n\n\n```sh\nsls deploy --conceal #hide the secret api key from output\n```\n\nThe following will deploy to the `prod` stage. I use this stage for the final API that is used by my router.\n\n```sh\nsls deploy -s prod --conceal #hide the secret api key from output\n```\n\n## Getting the settings\n\nAfter everything is deployed, you can go through the AWS console and setup custom domains and retrieve the API key used for the Create User endpoint.\n\n## Usage\n\n### POST /user\n\nCreates a user that can be used to authenticate with.\n\nYou will need the following headers set:\n\n- `Content-Type: application/json`\n- `x-api-key: \u003cKEY\u003e` - The key can be found in the API Gateway portion of AWS console. This is the Admin key and with it, users can be created. So don't share it.\n\nThe following is an example body:\n\n- `username` - cannot contain a colon (:) and be greater than 7 characters\n- `password` - greater than 7 characters\n\n```json\n{\n    \"username\": \"someuser\",\n    \"password\": \"awesomePass\",\n    \"domains\": [\n        \"home.domain.com\"\n    ]\n}\n```\n\n### GET /nic/update\n\nThis endpoint is what routers should hit. It is roughtly based on this https://help.dyn.com/remote-access-api/perform-update/. I do not follow it completley but this could be made to follow it more closely if desired.\n\n\u003e For my case I did not need to follow it completley so only used it as a guide\n\nThis endpoint requires just the `Authorization` header with a value in `Basic` auth format.\n\nQuery parameters are needed\n\n- `hostname` - comma seperated list of hostnames to update\n    - you can supply multiple hostname parameters instead\n    - cannot have a duplicate entry\n- `myip` - expects to be the IPv4 to update the record to\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdixonwille%2Faws-ddns","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdixonwille%2Faws-ddns","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdixonwille%2Faws-ddns/lists"}