No project description provided
Project description
mkdocs-build-webhook
A webhook that builds your mkdocs projects.
Run it with
Installation
mkdir -p /var/share/mkdocs-build-webhook/ /var/www/ /etc/mkdocs-build-webhook/ /var/www/.ssh/
ssh-keyscan github.com >> /var/www/.ssh/known_hosts
ssh-keygen -t ed25519 -f /var/www/.ssh/deploy_key -C "mkdocs-build-webhook" -N ''
chown -R www-data:www-data /var/share/mkdocs-build-webhook/ /var/www/
Add this config to /etc/mkdocs-build-webhook/mkdocs-build-webhook.conf:
[paths]
git = "/var/share/mkdocs-build-webhook/"
www = "/var/www/"
[auth]
secret = "<secret>"
[gunicorn]
bind = "0.0.0.0:5000"
workers = 4
/var/www/.ssh/config:
Host github.com
HostName github.com
Port 22
User git
CheckHostIP no
IdentityFile "~/.ssh/deploy_key"
Install pipx:
apt install pipx
su www-data -s /bin/bash
pipx install mkdocs-build-webhook
/etc/systemd/system/mkdocs-build-webhook.service:
[Unit]
Description=mkdocs-build-webhook Service
After=network.target
[Service]
Type=simple
ExecStart=/var/www/.local/pipx/venvs/mkdocs-build-webhook/bin/mkdocs-build-webhook
User=www-data
Group=www-data
Restart=always
RestartSec=3
[Install]
WantedBy=multi-user.target
Activate with:
sudo systemctl daemon-reload
sudo systemctl enable mkdocs-build-webhook.service
sudo systemctl start mkdocs-build-webhook.service
Does it work?
sudo journalctl -u mkdocs-build-webhook.service -f
Docker
podman build -t mkdocs-build-webhook .
podman run --userns keep-id --rm --name mkdocs-build-webhook -v ./dist/www/:/var/www/:z -e WEBHOOK_SECRET=secret -p 5000:5000 localhost/mkdocs-build-webhook
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for mkdocs_build_webhook-0.1.13.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 790c109a1e6fc76cbc561cc29e194d73f4a33ea5f3fbc9f17d2f477b0495a639 |
|
MD5 | 8019f13678364d3c6b5c11e23a7b67b7 |
|
BLAKE2b-256 | 1879f14d84d8e8c10e715f4b6c96cb98eafcdb9cf5d2455922513fa141ee9eb3 |
Close
Hashes for mkdocs_build_webhook-0.1.13-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9dc1da49d8f821050945b8ed90572798fb554debbb3d53ccadcb9c4cfcf84a1f |
|
MD5 | b5ee1229e4036cf492bd55a3ae140c65 |
|
BLAKE2b-256 | e84bf22fbcb2c5ff520b7a8e6f5512a3cd3c60d61842417a219896bf42bc6fb5 |