Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/virb3/http-ci-deployer
An extremely simple HTTP-based deployment solution for Continuous Integration services
https://github.com/virb3/http-ci-deployer
ci continuous-deployment continuous-integration deploy gitlab golang http
Last synced: 2 months ago
JSON representation
An extremely simple HTTP-based deployment solution for Continuous Integration services
- Host: GitHub
- URL: https://github.com/virb3/http-ci-deployer
- Owner: ViRb3
- Created: 2019-04-10T18:38:58.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-04-24T16:15:11.000Z (8 months ago)
- Last Synced: 2024-04-24T19:06:27.763Z (8 months ago)
- Topics: ci, continuous-deployment, continuous-integration, deploy, gitlab, golang, http
- Language: Go
- Size: 237 KB
- Stars: 6
- Watchers: 3
- Forks: 1
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# HTTP CI Deployer
An extremely simple HTTP-based deployment solution for Continuous Integration services. Originally designed as a safer, simpler alternative to SSH and SCP for GitLab's CI/CD.
## Usage
### General
A single wildcard endpoint is exposed:
```
/deploy/*
```
If you want to deploy `localfile.zip` to `archive/localfile.zip`, you would submit a `POST` request to: `/deploy/archive/localfile.zip`, with the file content as form data and the deployment key as a `KEY` header.
Note that all deployment paths are relative to the working directory of the deployer binary!
### Curl command
```bash
curl -F [email protected] -H "KEY: 123" "https://website.com/deploy/archive/localfile.zip"
```
### CI/CD
Example variables:
* DEPLOY_FILE: `localfile.zip`
Example secrets:
* DEPLOY_KEY: `123`
* DEPLOY_URL: `https://website.com/deploy/archive`
#### Drone CI
```yml
steps:
- name: deploy
image: alpine
environment:
DEPLOY_KEY:
from_secret: DEPLOY_KEY
DEPLOY_URL:
from_secret: DEPLOY_URL
commands:
- apk add --no-cache curl
- >
STATUS=$(curl --write-out %{http_code} --silent --output /dev/null
-F file=@$DEPLOY_FILE -H "KEY: $DEPLOY_KEY" "$DEPLOY_URL/$DEPLOY_FILE")
- >
echo "Result: $STATUS"
- >
[ "$STATUS" = "200" ] || exit 1
```
#### GitLab
```yml
deploy:
image: ubuntu
stage: alpine
before_script:
- apk add --no-cache curl
script:
- >
STATUS=$(curl --write-out %{http_code} --silent --output /dev/null
-F file=@$DEPLOY_FILE -H "KEY: $DEPLOY_KEY" "$DEPLOY_URL/$DEPLOY_FILE")
- >
echo "Result: $STATUS"
- >
[ "$STATUS" == "200" ] || exit 1
```
## Installation
1. Set a deployment key in `key.txt` in the deployer's working directory. It must be longer than **10 characters** or you will get a `bad key` error.
```bash
echo "SUPER_LONG_AND_SECRET_KEY" > key.txt
```
2. Run the webserver
```bash
/home/deploy/deployer-amd64 --port 5000
```
3. *(optional)* Install the systemd unit [deployer.service](deployer.service). Make sure you tweak or satisfy the configuration inside it.