Skip to main content

Simple webhook service to update and deploy sites and do other maintenance and automatic tasks

Project description

PyPI version PyPI downloads PyPI license Code Quality Known vulnerabilities

webhaak is a simple webhook service to update and deploy sites and do other maintenance without having to ssh to a node.

webhaak is on ReadTheDocs

webhaak supports git push hooks from GitHub, BitBucket, gitea, and gogs; for these it can automatically update checkouts. It also recognises Sentry notifications, and of course regular calls.

Installation

From PyPI

Assuming you already are inside a virtualenv:

pip install webhaak

From Git

Create a new virtualenv (if you are not already in one) and install the necessary packages:

git clone https://github.com/aquatix/webhaak.git
cd webhaak
mkvirtualenv webhaak # or whatever project you are working on
pip install -r requirements.txt

Usage

Copy example.yaml from example_config to a directory you will use for configuration and configure to your needs. This is a yaml file with the projects to serve (see next section).

Run webhaak as a service under nginx or apache and call the appropriate url’s when wanted (e.g., on push to repository).

webhaak can also be run from the command line: uvicorn webhaak:app --reload

Be sure to export/set the SECRETKEY environment variable before running, it’s needed for some management URI’s.

Run gunicorn -k uvicorn.workers.UvicornWorker for production. For an example of how to set up a server see this article with configuration for nginx, uvicorn, systemd, security and such.

The RQ background worker can be run from the command line: rq worker --with-scheduler

Url’s are of the form https://hook.example.com/app/<appkey>/<triggerkey>

API documentation is auto-generated, and can be browsed at https://hook.example.com/docs

Example configuration

See the example hook settings for syntax of how to configure repositories, commands and directories.

Call webhaak on its endpoint /admin/SECRETKEY/get_app_key to generate a random new key for usage in the projects yaml file (so, for example https://hook.example.com/admin/abc123/get_app_key)

By default, webhaak clones projects in a directory under its REPOS_CACHE_DIR directory, but there is support for a per-repo parent dir settings with repoparent in the yaml.

This means that webhaak then doesn’t clone this repo into its default cache dir, but in a subdirectory of the directory configured in repoparent, so <repoparent>/reponame (e.g., /srv/customparent/myproject).

Server configuration

What’s new?

See the Changelog.

Developing

Running in PyCharm: tbd :)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

webhaak-0.5.4.tar.gz (19.6 kB view details)

Uploaded Source

Built Distribution

webhaak-0.5.4-py3-none-any.whl (18.5 kB view details)

Uploaded Python 3

File details

Details for the file webhaak-0.5.4.tar.gz.

File metadata

  • Download URL: webhaak-0.5.4.tar.gz
  • Upload date:
  • Size: 19.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.6

File hashes

Hashes for webhaak-0.5.4.tar.gz
Algorithm Hash digest
SHA256 ea67ebaf06292194a627c2457d56d89115ae5b7eb72f0d0edcc7763b7245d264
MD5 f83205229b5024d293508d492ddccc2c
BLAKE2b-256 4b4b550143350e77ac469130e5bf110bb894000a9cfc05cc5cb52444b7f5d792

See more details on using hashes here.

File details

Details for the file webhaak-0.5.4-py3-none-any.whl.

File metadata

  • Download URL: webhaak-0.5.4-py3-none-any.whl
  • Upload date:
  • Size: 18.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.6

File hashes

Hashes for webhaak-0.5.4-py3-none-any.whl
Algorithm Hash digest
SHA256 62e9475bb6954bf854c15b72efb0349d4fc512705e2d93d68e75b8b21b9c83a6
MD5 aee5fbdb3e630543ab0c39df74b0be57
BLAKE2b-256 503f9fc3314f149ed4d35f3e765c549cb96423ac7f9144dcf16d1177d27547ea

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page