https://github.com/marcosnicolau/docker-deploy
Automated instance set up with bash file
https://github.com/marcosnicolau/docker-deploy
Last synced: 3 months ago
JSON representation
Automated instance set up with bash file
- Host: GitHub
- URL: https://github.com/marcosnicolau/docker-deploy
- Owner: MarcosNicolau
- Created: 2021-08-05T02:14:08.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2021-08-12T17:41:53.000Z (almost 4 years ago)
- Last Synced: 2024-10-05T12:41:05.139Z (8 months ago)
- Language: Shell
- Size: 45.9 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# Automated Docker deployments with bash file and CD
This script is to be run on an instance set up.
Important, before running the script, make sure you have added the IPV4 to your dns. Otherwise, you won't get https
If the script fails at some stage, it won't stop, but it doesn't matter, just run it again and everything will be overwritten
## How it works
### Steps
1. Update OS
2. Install Docker
3. Nginx set up
4. Get certbot certificate
5. Enable HTTP/2
6. Docker run
7. Set CD webhook listener
### How to run it
```
git clone https://github.com/MarcosNicolau/docker-deploy.git
cd docker-deploy/scripts/deploy
chmod +x ./index.bash
./index.bash \
-a DOMAIN="www.yourwebsite.com yourwebsite.com" \
-a [email protected] \
-a DOCKER_IMAGE_NAME=user/imagename:latest \
-a DOCKER_EXPOSE_PORT=8080 \
-a PIPELINE_TOKEN=SECRET_TOKEN \
```
## Options
### List of options
#### Required
- `-a DOMAIN`: your domain.
- `-a EMAIL`: your email.
- `-a DOCKER_IMAGE_NAME`: if you are working on a private repo, you will have to pass your docker credentials.
- `-a DOCKER_EXPOSE_PORT`: the expose port you have set in your image.
#### Optional
if you are working with a private repo, you will have to pass your docker credentials:
- `-a DOCKER_USERNAME`: your docker username
- `-a DOCKER_PASSWORD`: your docker password. You should pass an ssh key
#### Continuos delivery:
If you want to set a webhook listener to pull the image for you, you will have to pass -a CD_PIPELINE_TOKEN=SECRET_TOKEN.
Also, on docker you will have to create a webhook pointing
to the endpoint you provided. More on that in here [docker-webhooks-docs](https://docs.docker.com/docker-hub/webhooks/)
By the way, this the repo we are using for it: [webhook-listener-repo](https://github.com/MarcosNicolau/web-hook-listener)
Options:
- `-a PIPELINE_ROUTE`: the route for the auto deploy endpoint, it defaults to /deploy. Note that all the routes that start with `PIPELINE_ROUTE` will be redirected to the webhook
- `-a PIPELINE_TOKEN`: the token for your webhook
- `-a PIPELINE_CONTAINER_PORT`: the port you want the webhook to be, it default to 3000
If you want to be notified on every pull, you will have to pass an email config:
- `-a NOTIFICATIONS_EMAIL_HOST`: mail transporter host example `smtp.mandrillapp.com`
- `-a NOTIFICATIONS_EMAIL_USER`: mail transporter auth user
- `-a NOTIFICATIONS_EMAIL_PASSWORD`: mail transporter auth password
- `-a NOTIFICATION_EMAIL_FROM`: mail transporter from
- `-a NOTIFICATION_EMAIL_TO`: mail transporter to
Alternatively, you can pass all the options in a ~/app/.deploy.env
## Pass env variables to your Docker image
If you need to pass env variables to your image, you can do so by passing -d flag
```
./docker-deploy/scripts/deploy/docker-deploy.bash \
-d ENV_VARIABLE_FOR_CONTAINER_DOCKER=hello!
```
Alternatively, you can pass all the options in a ~/app/.docker.env