https://github.com/pforret/landeploy
automatic deploy on LAN/localhost upon 'git push'
https://github.com/pforret/landeploy
bashew cloudflared devops github ngrok webhook
Last synced: 6 months ago
JSON representation
automatic deploy on LAN/localhost upon 'git push'
- Host: GitHub
- URL: https://github.com/pforret/landeploy
- Owner: pforret
- License: mit
- Created: 2024-12-30T13:33:27.000Z (9 months ago)
- Default Branch: master
- Last Pushed: 2025-01-08T20:39:56.000Z (9 months ago)
- Last Synced: 2025-04-12T10:09:33.427Z (6 months ago)
- Topics: bashew, cloudflared, devops, github, ngrok, webhook
- Language: Shell
- Homepage:
- Size: 780 KB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[](https://www.basher.it/package/)
# landeploy
This script will help you if you need to set up Continuous Deployment on a local/LAN server without a public IP address and/or website.
It will
* install [ngrok](https://ngrok.com/) (`landeploy --FORCE init`) or [Cloudflare Tunnel](https://developers.cloudflare.com/cloudflare-one/connections/connect-apps/install-and-setup/tunnel) (`landeploy --TUNNEL cloudflare --FORCE init`)
* install [webhook](https://github.com/adnanh/webhook) (`landeploy --FORCE init`)
* set up the ngrok/cloudflared config (you will need to create a free account on [ngrok.com](https://ngrok.com/) or [dash.cloudflare.com](https://dash.cloudflare.com/))
* set up the webhook config (`landeploy --FORCE init`)
* set up the `redeploy` script (`landeploy --FORCE init`)
* run the webhook server and ngrok/cloudflared tunnel (`landeploy serve`)
* give you the URL to use as webhook in your GitHub/BitBucket repository (`landeploy serve`)
## 🔥 Usage
```
Program : landeploy by peter@forret.com
Version : v1.1.0 (2025-01-08 21:27)
Purpose : automatic deploy on LAN/localhost upon 'git push'
Usage : landeploy [-h] [-Q] [-V] [-f] [-B ] [-D ] [-E ] [-H ] [-L ] [-P ] [-R ] [-T ] [-U ] [-Y ]
Flags, options and parameters:
-h|--help : [flag] show usage [default: off]
-Q|--QUIET : [flag] no output [default: off]
-V|--VERBOSE : [flag] also show debug messages [default: off]
-f|--FORCE : [flag] do not ask for confirmation (always yes) [default: off]
-B|--BRANCH > : [option] remote repo branch [default: main]
-D|--DOMAIN > : [option] ngrok domain to use
-E|--ENVIRONMENT >: [option] deployment type (only php for now) [default: php]
-H|--HOOKS > : [option] webhook config file [default: landeploy.yaml]
-L|--LOG_DIR > : [option] folder for log files [default: log/landeploy]
-P|--PORT > : [option] local port for ngrok service [default: 8008]
-R|--REMOTE > : [option] remote repo name [default: origin]
-T|--TMP_DIR > : [option] folder for temp files [default: .tmp]
-U|--TUNNEL > : [option] tunnel provider: ngrok/cloudflare [default: ngrok]
-Y|--REDEPLOY >: [option] deploy script file [default: redeploy.sh]
: [choice] action to perform [options: init,serve,check,env,update]
### TIPS & EXAMPLES
* use landeploy init to do/check the installation of ngrok and webhook
landeploy init
* use landeploy serve to start local webhook server and remote tunnel
landeploy serve
* use landeploy check to check if this script is ready to execute and what values the options/flags are
landeploy check
* use landeploy env to generate an example .env file
landeploy env > .env
* use landeploy update to update to the latest version
landeploy update
* >>> bash script created with pforret/bashew
* >>> for bash development, also check out pforret/setver and pforret/progressbar
```
## ⚡️ Examples
```bash
> landeploy --FORCE init
# install ngrok and webhook binaries, create config files
> landeploy init
# check if ngrok, webhook and all config files are OK
✅ Found binary: /usr/local/bin/ngrok
✅ Found config: Valid configuration file at $HOME/.config/ngrok/ngrok.yml
✅ Found binary: /usr/bin/webhook
✅ Found config: landeploy.yaml
✅ Found config: redeploy.sh
> landeploy serve
# start local webhook and remote ngrok tunnel
⏳ Starting webhook server on port 8008
Log : log/landeploy/serve.2025-01-01.log
Local : http://localhost:8008/hooks/redeploy
Remote: https://[custom].ngrok-free.app/hooks/redeploy (use this as webhook in GitHub/BitBucket)
Admin : http://localhost:4040 (use this to check what is received by ngrok)
```
## 🚀 Installation
with [basher](https://github.com/basherpm/basher)
$ basher install pforret/landeploy
or with `git`
$ git clone https://github.com/pforret/landeploy.git
$ cd landeploy
The following programs are also required:
### [ngrok](https://ngrok.com/) (free):
* create a free account on [dashboard.ngrok.com](https://dashboard.ngrok.com/) - this includes 2 free endpoints (e.g. 1 for development/testing and 1 for production)
* install Linux client: [Setup & Installation](https://dashboard.ngrok.com/get-started/setup/linux) -- will happen automatically when using `landeploy --FORCE init`
```bash
curl -sSL https://ngrok-agent.s3.amazonaws.com/ngrok.asc | sudo tee /etc/apt/trusted.gpg.d/ngrok.asc >/dev/null \
&& echo "deb https://ngrok-agent.s3.amazonaws.com buster main" | sudo tee /etc/apt/sources.list.d/ngrok.list \
&& sudo apt update && sudo apt install ngrok
```
### [adnanh/webhook](https://github.com/adnanh/webhook) (Golang - open-source)
```bash
sudo apt-get install webhook
```
## 📝 Acknowledgements
* script created with [bashew](https://github.com/pforret/bashew)
* [ngrok: GitHub Repository Webhooks](https://ngrok.com/docs/integrations/github/webhooks/)
© 2024 Peter Forret