deployment-helper/README.md
Frank Agerholm a545c66c3e
All checks were successful
Build and Push Docker Image / build (push) Successful in 14s
Configuration file example added.
2026-01-23 17:43:23 +01:00

1.5 KiB

deployment-helper für Nikola based Websites

ENV-Variables

  • LFTP_PASSWORD (Deployment-Passwort for sftp-Upload)
  • SSH_HOST (Deployment-Host for sftp-Upload)
  • SSH_USER (Deployment-User for sftp-Upload)

Python 3.11 and Nikola 8.x

This image is based on the python:3.11-alpine image and includes additional Python-packages for building nikola-sites.

Configure your project

Variable Default Description
DEPLOY_HELPER_ENABLE_NIKOLA true Build Nikola-Website in website/
DEPLOY_HELPER_ENABLE_NODE false Enable nodejs Build in node/
DEPLOY_HELPER_CONTENT_DIR website/output/ Default Content-Directory for publishing

Create a configuration file in your git-repo: .deployment-helper:

DEPLOY_HELPER_ENABLE_NIKOLA=false
DEPLOY_HELPER_ENABLE_NODE=true
DEPLOY_HELPER_CONTENT_DIR="node/.output/public/"

This example disables the niko build and enables node. The finished website is copied from the node/.output/public/ directory to the target server.

lftp for sftp-Uploads

This image includes lftp to upload files to a sftp-server and use the sftp-password from LFTP_PASSWORD environment variable.

lftp -e 'set sftp:auto-confirm yes; mirror -R ./<LOCAL_DIR>/ ./<REMOTE_DIR>/; bye' --env-password -u USER sftp://<TARGET_FQDN>