Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/eddiejibson/update
Auto-update a git repo you store locally on push.
https://github.com/eddiejibson/update
Last synced: about 1 month ago
JSON representation
Auto-update a git repo you store locally on push.
- Host: GitHub
- URL: https://github.com/eddiejibson/update
- Owner: eddiejibson
- Created: 2019-06-08T14:28:20.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-12-10T19:57:41.000Z (almost 2 years ago)
- Last Synced: 2024-03-02T05:35:25.254Z (9 months ago)
- Language: JavaScript
- Size: 52.7 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Update
Auto-update (pull) your GitHub or GitLab repository and execute optional tasks/commands on push in the background (building e.t.c).
## Installation
You're going to need the `screen` package if you plan to execute background tasks. If not, you'll be fine without it:
Ubuntu/Debain: `sudo apt-get install screen -y`
CentOS: `yum install screen`
Clone the repository:
```bash
git clone https://github.com/eddiejibson/update.git
```
Enter into repository's directory and install the dependencies:
```bash
cd update/ && npm install
```
You'll now [need to configure](#configuration) the platform, [setup your webserver](#configuring-web-server) and [add the webhook](#adding-a-webhook-to-a-repository) before you continue.
Starting:
```bash
node app.js
```
Alternatively, you may start it as a process, with PM2 (recommended):
```bash
npm install pm2 -g
pm2 start processes.json
```
## Configuration
All configuration should be done in a `config.json` file. Here's an example:
```javascript
{
"port": "8090", //Port of the server to listen onto. Defaults to 8090
"repos": {
"eddiejibson/testupdate": { //Enter full repo name here ((username or organization)/repo)
"secret": "test", //Optionally set a secret "key" to make sure
"gitlab": false, //Is the repo from GitLab?
//the webhook is indeed from Github and not an attacker
"path": "/opt/testupdate", //The root path of the repository stored on your local system
"cmds": [ //Optional. An array of commands you want executed after pull
"npm install",
{ //Instead of a string with the command, you can also specify extra options
"background": true, //This command will be ran in the background (not slowing down the request)
//This is reccomended for intensive commands that may take some time.
"cmd": "npm run build"
}
]
}
}
}
```
## Configuring web server
Example NGINX configuration (reverse proxy) with SSL. You can get a free SSL certificate for your domain/subdomain from [Let's Encrypt](https://letsencrypt.org/getting-started/).
```
server {
listen 80;
server_name ;
return 301 https://$server_name$request_uri;
}
server {
listen 443 ssl http2;
listen [::]:443 ssl http2;
ssl_certificate ;
ssl_certificate_key ;
server_name ;
location / {
proxy_pass http://127.0.0.1:8090;
proxy_http_version 1.1;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection 'upgrade';
proxy_set_header Host $host;
proxy_cache_bypass $http_upgrade;
proxy_set_header X-Forwarded-Referrer $http_referer;
proxy_set_header Authorization $http_authorization;
proxy_pass_header Authorization;
}
}
```
## Adding a webhook to a repository
Step 1:
Step 2:
