{"id":22801659,"url":"https://github.com/wuttinanhi/autodeploy","last_synced_at":"2026-04-09T17:50:02.750Z","repository":{"id":56323375,"uuid":"308601008","full_name":"wuttinanhi/autodeploy","owner":"wuttinanhi","description":"automatic deploy to server from push","archived":false,"fork":false,"pushed_at":"2021-02-28T19:16:55.000Z","size":60,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-05T22:34:06.150Z","etag":null,"topics":["deploy","deployment-automation","docker","docker-compose","git","nodejs"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/wuttinanhi.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-10-30T10:45:37.000Z","updated_at":"2021-02-28T19:16:57.000Z","dependencies_parsed_at":"2022-08-15T16:40:29.818Z","dependency_job_id":null,"html_url":"https://github.com/wuttinanhi/autodeploy","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/wuttinanhi%2Fautodeploy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wuttinanhi%2Fautodeploy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wuttinanhi%2Fautodeploy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wuttinanhi%2Fautodeploy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/wuttinanhi","download_url":"https://codeload.github.com/wuttinanhi/autodeploy/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246372503,"owners_count":20766625,"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":["deploy","deployment-automation","docker","docker-compose","git","nodejs"],"created_at":"2024-12-12T08:11:55.004Z","updated_at":"2025-12-30T22:06:21.422Z","avatar_url":"https://github.com/wuttinanhi.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch3  align=\"center\"\u003eAUTODEPLOY\u003c/h3\u003e\n\u003cp align=\"center\"\u003e\na docker image listening for commit changes and automatic deploy to server.\n\u003c/p\u003e\n\n\u003c!-- TABLE OF CONTENTS --\u003e\n\n## Table of Contents\n\n- [About the Project](#about-the-project)\n- [Getting Started](#getting-started)\n  - [Prerequisites](#prerequisites)\n  - [Installation](#installation)\n- [Available Environment Variable](#available-environment-variable)\n- [Volume](#volume)\n- [Known issues](#known-issues)\n- [License](#license)\n\n\u003c!-- ABOUT THE PROJECT --\u003e\n\n## About The Project\n\nHave you tired of SSH to your server and run deployment command?\u003cbr/\u003e\nDid you make a small project and need test on the server quickly but you don't want to setup continuous integration?\u003cbr/\u003e\nHave you tired of managing SSH key?\u003cbr/\u003e\nWell, this thing might make it easy for you.\u003cbr/\u003e\n\n\u003c!-- GETTING STARTED --\u003e\n\n## Getting Started\n\nTo get start you need to have some Docker knowledge.\u003cbr/\u003e\nIf you want to modify this repository. you need JavaScript and Node.js.\n\n### Prerequisites\n\n- [Docker](https://docs.docker.com/get-docker/)\n\n### Installation\n\n```\ndocker run -it -d \\\n\t--name=\"github-autodeploy\" \\\n\t--restart=\"always\" \\\n\t-e GITHUB_USERNAME=\"\" \\\n\t-e GITHUB_KEY=\"\" \\\n\t-e GITHUB_REPOSITORY=\"wuttinanhi/test-compose\" \\\n\t-e GITHUB_BRANCH=\"test\" \\\n\t-e DEPLOY_DIRECTORY=\"//autodeploy-repo\" \\\n\t-e REFRESH_RATE=30000 \\\n\t-v /var/run/docker.sock:/var/run/docker.sock \\\n\t-v /autodeploy:/autodeploy-repo \\\n\twuttinanhi/autodeploy:latest\n```\n\n\u003c!-- AVAILABLE ENVIRONMENT VARIABLE --\u003e\n\n## Available Environment Variable:\n\n`GITHUB_USERNAME` (Optional)\u003cbr/\u003e\nYour GitHub username.\n\u003cbr/\u003e\n\n`GITHUB_KEY` (Optional)\u003cbr/\u003e\nYour GitHub Personal Access Token.\u003cbr/\u003e\nYou can get it at [https://github.com/settings/tokens](https://github.com/settings/tokens) **repo scope are needed**.\n\u003cbr/\u003e\n\n`GITHUB_REPOSITORY` (Required)\u003cbr/\u003e\nRepository to listening for change.\u003cbr/\u003e\nExample value: `wuttinanhi/test-compose`\n\u003cbr/\u003e\n\n`GITHUB_BRANCH` (Required)\u003cbr/\u003e\nBranch to listening for change.\u003cbr/\u003e\nExample value: `test` `production`\n\u003cbr/\u003e\n\n`DEPLOY_DIRECTORY` (Optional)\u003cbr/\u003e\nDirectory path for store downloaded repository.\u003cbr/\u003e\nDefault value: `repo`\u003cbr/\u003e\nExample value: `//autodeploy-repo`\n\u003cbr/\u003e\n\n`REFRESH_RATE` (Optional)\u003cbr/\u003e\nWait for amount of milliseconds to see changes again.\u003cbr/\u003e\nDefault value: `15000`\u003cbr/\u003e\nExample value: `30000` (wait for 30 seconds) `60000` (wait 1 minute)\n\u003cbr/\u003e\n\n\u003c!-- VOLUME --\u003e\n\n## Volume:\n\n**(REQUIRED)** Socket path are needed for contact docker daemon.\n\n- For Windows:\n  `-v //var/run/docker.sock:/var/run/docker.sock`\n\n- For Linux:\n  `-v /var/run/docker.sock:/var/run/docker.sock`\n\u003cbr/\u003e\n\n**(Optional)** Volume for store downloaded repository.\u003cbr/\u003e\n*Environment variable `DEPLOY_DIRECTORY` and mounted path need to be the **same**.\u003cbr/\u003e\n*Example value:*\n\n- Relative path:\n  - `-e DEPLOY_DIRECTORY=repo`\n  - `-v /autodeploy:/nodejs/repo`\n- Absolute path:\n  - `-e DEPLOY_DIRECTORY=//autodeploy-repo`\n  - `-v /autodeploy:/autodeploy-repo`\n\n\u003c!-- KNOWN ISSUES --\u003e\n\n## Known issues\n- Rate limiting\u003cbr/\u003e\nif you encounter this issue you can solve this by authentication with `GITHUB_USERNAME` and `GITHUB_KEY` \u003cbr/\u003e\nor change the amount of `REFRESH_RATE`. \u003cbr/\u003e\n[reference about this issue](https://docs.github.com/en/free-pro-team@latest/rest/overview/resources-in-the-rest-api#rate-limiting)\n\n\u003c!-- CONTRIBUTING --\u003e\n\n## Contributing\n\nContributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.\n\n1. Fork the Project\n2. Create your Feature Branch\n3. Commit your Changes\n4. Push to the Branch\n5. Open a Pull Request\n\n\u003c!-- LICENSE --\u003e\n\n## License\n\nDistributed under the MIT License. See `LICENSE` for more information.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwuttinanhi%2Fautodeploy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwuttinanhi%2Fautodeploy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwuttinanhi%2Fautodeploy/lists"}