{"id":21428931,"url":"https://github.com/notcoffee418/docker-compose-deploy-action","last_synced_at":"2026-01-02T23:34:05.480Z","repository":{"id":162570488,"uuid":"637094263","full_name":"NotCoffee418/docker-compose-deploy-action","owner":"NotCoffee418","description":"Action to deploy a docker-compose file from from GitHub.","archived":false,"fork":false,"pushed_at":"2024-11-03T10:36:59.000Z","size":15,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-23T08:16:11.733Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"unlicense","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/NotCoffee418.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-05-06T13:43:02.000Z","updated_at":"2024-11-03T10:37:03.000Z","dependencies_parsed_at":null,"dependency_job_id":"a76ab15e-b849-4d4e-a9bb-7c30dedd377f","html_url":"https://github.com/NotCoffee418/docker-compose-deploy-action","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NotCoffee418%2Fdocker-compose-deploy-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NotCoffee418%2Fdocker-compose-deploy-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NotCoffee418%2Fdocker-compose-deploy-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NotCoffee418%2Fdocker-compose-deploy-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/NotCoffee418","download_url":"https://codeload.github.com/NotCoffee418/docker-compose-deploy-action/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243940060,"owners_count":20372044,"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":[],"created_at":"2024-11-22T22:15:16.095Z","updated_at":"2026-01-02T23:34:05.454Z","avatar_url":"https://github.com/NotCoffee418.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"\n# Docker Compose Deploy Action\n\nThis GitHub Action deploys a repository using Docker Compose on a remote server through SSH.\n\n## Usage\n\nTo use this action, add the following YAML code to your GitHub Actions workflow:\n\n```yaml\nname: Deploy My App\non:\n  push:\n    branches:\n      - main\njobs:\n  deploy:\n    runs-on: ubuntu-latest\n    steps:\n    - name: Deploy\n      uses: notcoffee418/docker-compose-deploy-action@v5\n      with:\n        ssh_host: ${{ secrets.SSH_HOST }}\n        ssh_user: ${{ secrets.SSH_USERNAME }}\n        ssh_key: ${{ secrets.SSH_PRIVATE_KEY }}\n        ssh_port: ${{ secrets.SSH_PORT }}\n        ssh_deployer_path: /path/to/deployer/directory\n        repository: yourusername/yourrepository\n        docker_compose_file: docker-compose.yml\n```\n\nReplace `/path/to/deployer/directory` with your own values. Also, make sure to have a valid `SSH_HOST`, `SSH_USERNAME` and `SSH_PRIVATE_KEY` secret in your repository's secrets.\n\nGot it. Here’s an updated version with clear instructions on giving your server access to your GitHub repositories, and placing the SSH key in a specific directory:\n\n\n## Accessing Private Repositories\n\nTo give your server access to your GitHub repositories using SSH keys, follow these steps:\n\n1. **Generate SSH Key Pair on Deployment Server:**\n   ```bash\n   su YOUR_DEPLOYER_USER\n   mkdir -p ~/.ssh/github-keys\n   ssh-keygen -t rsa -b 4096 -C \"your_github_email@github.com\" -f ~/.ssh/github-keys/id_rsa\n   chmod 400 ~/.ssh/github-keys/id_rsa\n   ```\n   You can find the email address in your [GitHub Settings](https://github.com/settings/emails).\n\n2. **Add Public Key to GitHub:**\n   - Copy the public key:\n     ```bash\n     cat ~/.ssh/github-keys/id_rsa.pub\n     ```\n   - Go to your repository on GitHub \u003e Settings \u003e Deploy keys.\n   - Click \"Add deploy key\" and paste your public key as authentication key.\n\n3. **Configure Git to Use the SSH Key:**\n   - Edit your SSH configuration file (`~/.ssh/config`) to use the new key for GitHub:\n    ```bash\n    echo -e \"Host github.com\\n  IdentityFile ~/.ssh/github-keys/id_rsa\\n  User git\" \u003e\u003e ~/.ssh/config\n    chmod 600 /home/runner/.ssh/config\n    ```\n   - Test the connection and approve fingerprint on first time connecting:\n    ```bash\n    ssh -T git@github.com\n    # yes\n    ```\n\n\n## Contributing\n\nIf you have suggestions for how this GitHub Action could be improved, or want to report a bug, please open an issue or a pull request in this repository.\n\n## License\n\nThis GitHub Action is licensed under the [MIT License](LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnotcoffee418%2Fdocker-compose-deploy-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnotcoffee418%2Fdocker-compose-deploy-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnotcoffee418%2Fdocker-compose-deploy-action/lists"}