README.md

docker-node-deploy

A node.js based deployment server that allows you to deploy and manage your docker containers

Running it locally

• Clone this repo
• Install it's dependencies by running yarn in the root of the project
• Build the deployment server using yarn build
• Make sure to set environment variables in .env (example can be found in .env.example)
• Run the deployment server using yarn start

Methods

Deploy an environment

POST http://localhost:6969/deploy

Payload:

{
  "url": "GIT_REPO_URL",
  "branch": "REPO_BRANCH",
  "envName": "ENVIRONMENT_NAME",
  "containers": [
    {
      "dir": "CONTAINER_DIRECTORY",
      "envVars": [
        {
          "key": "ENV_VAR_KEY",
          "value": "ENV_VAR_VALUE"
        }
      ]
    }
  ]
}

Returns:

{
  "success": true,
  "data": {
    "name": "ENVIRONMENT_NAME"
  }
}

Terminate an environment

POST http://localhost:6969/terminate

Payload:

{
  "envName": "ENVIRONMENT_NAME"
}

Returns:

{
  "success": true,
  "data": {
    "name": "ENVIRONMENT_NAME"
  }
}

Maintainers

• @amitojsingh366

License

docker-node-deploy is licensed under the MIT License

Contributing

Find something that is lacking? Fork the project and pull request!