Skip to content

About

Publish a static website to a personal web directory served by Apache's mod_userdir

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

userdir-publish

License PyPI package Supported Python versions pre-commit.ci status CI status Test coverage Spelling checked code style: prettier uv Ruff ty

userdir-publish copies a built static website to a personal web directory, such as https://web.example.edu/~jdoe/, that Apache serves with mod_userdir. It uses rsync, either over SSH or to a local path when the web directory is mounted or you are logged in on the server. It removes stale files, sets permissions the web server can read, and refuses to publish a build that lacks index.html or the current .htaccess rules.

Installation

The tool requires rsync on your machine and on the server. On macOS, install GNU rsync (for instance with brew install rsync), because the built-in openrsync ignores the permission settings. Install it from PyPI:

uv tool install userdir-publish

or with pipx install userdir-publish. Then run userdir-publish --help.

Documentation

See rub-ep1.github.io/userdir-publish for other installation methods, configuration, group pages, and task runner integration.

About

Publish a static website to a personal web directory served by Apache's mod_userdir

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Contributors

Languages