Merge branch 'master' of github.com:sarveshwarge/n8n-docker

.github/workflows/dockerimage.yml

@@ -0,0 +1,18 @@
+name: Docker Image CI
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Build the Docker image
+      run: docker build . --file Dockerfile --tag my-image-name:$(date +%s)

.github/workflows/dockerpublish.yml

@@ -0,0 +1,76 @@
+name: Docker
+
+on:
+  push:
+    # Publish `master` as Docker `latest` image.
+    branches:
+      - master
+
+    # Publish `v1.2.3` tags as releases.
+    tags:
+      - v*
+
+  # Run tests for any PRs.
+  pull_request:
+
+env:
+  # TODO: Change variable to your image's name.
+  IMAGE_NAME: n8n-heroku
+
+jobs:
+  # Run tests.
+  # See also https://docs.docker.com/docker-hub/builds/automated-testing/
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Run tests
+        run: |
+          if [ -f docker-compose.test.yml ]; then
+            docker-compose --file docker-compose.test.yml build
+            docker-compose --file docker-compose.test.yml run sut
+          else
+            docker build . --file Dockerfile
+          fi
+
+  # Push image to GitHub Packages.
+  # See also https://docs.docker.com/docker-hub/builds/
+  push:
+    # Ensure test job passes before pushing image.
+    needs: test
+
+    runs-on: ubuntu-latest
+    if: github.event_name == 'push'
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Build image
+        run: docker build . --file Dockerfile --tag image
+
+      - name: Log into registry
+        run: echo "${{ secrets.GITHUB_TOKEN }}" | docker login docker.pkg.github.com -u ${{ github.actor }} --password-stdin
+
+      - name: Push image
+        run: |
+          IMAGE_ID=docker.pkg.github.com/${{ github.repository }}/$IMAGE_NAME
+          
+          # Change all uppercase to lowercase
+          IMAGE_ID=$(echo $IMAGE_ID | tr '[A-Z]' '[a-z]')
+
+          # Strip git ref prefix from version
+          VERSION=$(echo "${{ github.ref }}" | sed -e 's,.*/\(.*\),\1,')
+
+          # Strip "v" prefix from tag name
+          [[ "${{ github.ref }}" == "refs/tags/"* ]] && VERSION=$(echo $VERSION | sed -e 's/^v//')
+
+          # Use Docker `latest` tag convention
+          [ "$VERSION" == "master" ] && VERSION=latest
+
+          echo IMAGE_ID=$IMAGE_ID
+          echo VERSION=$VERSION
+
+          docker tag image $IMAGE_ID:$VERSION
+          docker push $IMAGE_ID:$VERSION

README.md

@@ -2,4 +2,69 @@
 
 ### n8n(Nodemation) - Free and Open Workflow Automation Tool
 
-This is a heroku focused container implementation for the n8n Automation Tool. Just connect your fork of this repo to heroku and let it work as a charm!
+This is a [Heroku](https://heroku.com/) focused container implementation for the [n8n Automation Tool](https://n8n.io/). Just connect your fork of this repo to heroku and let it work as a charm!
+
+## Requirements
+* Heroku CLI
+
+## Setup
+
+you need to prepare your heroku app before deploying this project. given below in 3 simple steps!
+
+### STEP 1: CHANGE your App Stack to container
+you can change your app's stack using heroku cli, make sure you have heroku cli installed.
+
+#### login into heroku account
+    heroku login
+
+#### change app stack
+    heroku stack:set contaner --app APP_NAME
+replace APP_NAME with your heroku app name
+
+### STEP 2: ADD Config Vars for enabling basic authentication (Optional)
+It's recommended that you enable basic authentication when deployingn n8n on web. You need to set the following Environment Variables(Config Vars) in your App settings.
+
+    N8N_BASIC_AUTH_ACTIVE=true
+    N8N_BASIC_AUTH_USER=SET_USERNAME
+    N8N_BASIC_AUTH_PASSWORD=SET_PASSWORD
+
+### STEP 3: DONE! Now CONNECT Github repo and Deploy.
+
+## Using Container Registry
+
+you can also deploy this project using container registry (requires aditional requirements installed). Just clone/download this repository on your local machine.
+
+### Additional Requirements (for building on local)
+* docker
+* docker-compose
+
+### Steps
+cd into your project directory
+
+    cd n8n-heroku/
+
+login into heroku account
+
+    heroku login
+
+create heroku app
+
+    heroku create APP_NAME
+
+change app stack
+
+    heroku stack:set contaner --app APP_NAME
+
+set config vars(optional)
+
+    heroku config:set N8N_BASIC_AUTH_ACTIVE=true
+    heroku config:set N8N_BASIC_AUTH_USER=SET_USERNAME
+    heroku config:set N8N_BASIC_AUTH_PASSWORD=SET_PASSWORD
+
+build and push container image to heroku
+
+    heroku container:push web --app APP_NAME
+
+release new build
+
+    heroku container:release web --app APP_NAME