https://github.com/vitalyliber/dokku-github-action

Deploy applications to Dokku
https://github.com/vitalyliber/dokku-github-action

action actions deployment dokku dokku-act github-action github-actions

Last synced: about 2 months ago
JSON representation

Deploy applications to Dokku

• Host: GitHub
• URL: https://github.com/vitalyliber/dokku-github-action
• Owner: vitalyliber
• License: mit
• Created: 2019-06-10T08:55:42.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-05-24T07:27:44.000Z (7 months ago)
• Last Synced: 2024-10-31T10:38:05.527Z (about 2 months ago)
• Topics: action, actions, deployment, dokku, dokku-act, github-action, github-actions
• Language: Shell
• Homepage: https://vitalyliber.com/courses/deploj-prilozhenij-s-dokku
• Size: 54.7 KB
• Stars: 78
• Watchers: 0
• Forks: 33
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Dokku for GitHub Actions

Deploy your App to the Dokku server.

This action will deploy the Application to your Dokku server via SSH.

## Usage

To use the action simply add the following lines to your `.github/workflows/main.yml`

```

name: CD

on:

  push:

    branches:

      - master

      - main

jobs:

  build:

    runs-on: ubuntu-latest

    steps:

    - uses: actions/checkout@v1

    - name: Dokku deploy

      uses: vitalyliber/[email protected]

      env:

        PRIVATE_KEY: ${{ secrets.PRIVATE_KEY }}

        HOST: ${{ secrets.HOST }}

        PROJECT: ${{ secrets.PROJECT }}

        APP_CONFIG: ${{ secrets.APP_CONFIG }}

```

### Required Secrets

You'll need to provide some env to use the action. 

Set them to the Project Secrets:

`Settings -> Secrets -> Actions -> New Repository Secret`

- **PRIVATE_KEY**: Your SSH private key to access to Dokku. Get it via command: `pbcopy < ~/.ssh/id_rsa`.

- **HOST**: The host or IP of the Dokku server. ie, `your.site.com` or `192.168.1.1`.

- **PROJECT**: Dokku project name.

### Optional Environments

You can optionally provide the following:

- **PORT**: Port of the sshd listen to, `22` is set by default.

- **FORCE_DEPLOY**: Force push the project to dokku, e.g. `FORCE_DEPLOY=true`

- **HOST_KEY**: The results of running `ssh-keyscan -t rsa $HOST`. Use this if you want to check that the host you're deploying to is the right one (e.g. has the same keys).

- **APP_CONFIG**: Set dokku config through github secrets. Example: `RAILS_MAX_THREADS=25 SECRET_KEY_BASE=xyz123&$%`.

- **BRANCH**: The ability to deploy from a non-master branch.

## License

The Dockerfile and associated scripts and documentation in this project are released under the [MIT License](LICENSE).