Landeploy — Automatic LAN deployments on every GitHub…

Pitch

Description

Comments

About this project

Landeploy enables seamless continuous deployment to your local or LAN servers after every GitHub/BitBucket push. It uses ngrok and webhook technology to set up a flexible deployment pipeline without needing a public IP. Ideal for local development and LAN servers.

Landeploy: Automated Deployment on LAN/localhost

Landeploy streamlines continuous deployment for local or LAN servers that lack a public IP address or website. It leverages ngrok and webhook to enable automatic deployments upon a GitHub push event.

Key Features

Ngrok and Webhook Installation: Automates the installation and configuration processes with commands like landeploy --FORCE init.
Webhook Configuration: Provides an easy setup for GitHub or BitBucket webhooks, with the necessary URL for integration.
Local and Remote Tunneling: Uses ngrok to create secure tunnels, enabling webhook functionality even in local environments.
Redeploy Script: Offers a script to manage redeployments effectively.

Quick Usage

Landeploy is designed for simplicity and efficiency. Below are some common commands:

# Install necessary components and configuration
> landeploy --FORCE init

# Validate installations and configurations
> landeploy init

# Start the webhook server and create a secure tunnel with ngrok
> landeploy serve

Example Usage

Upon initializing, Landeploy will install required binaries and create config files. Check for existing installations and configurations with:

> landeploy init

Start your local webhook server and remote ngrok tunnel:

> landeploy serve

Inspect the logs, local server URL, and the remote ngrok URL which should be used as the webhook endpoint in repositories.

Installation

Install Landeploy using basher:

$ basher install pforret/landeploy

Or clone the repository directly from GitHub:

$ git clone https://github.com/pforret/landeploy.git
$ cd landeploy

Prerequisites

Ngrok: Sign up for a free account and follow the ngrok setup guide.
Webhook: Install using your package manager; for example, on Ubuntu, use:
```
sudo apt-get install webhook
```

Further Information

Landeploy was created with bashew and is perfect for developers looking for a straightforward deployment solution on local networks. More enhancements can be found in repositories like pforret/setver and pforret/progressbar.