jorouquette/obsidian-vps-publish repository overview

⁠Publish to VPS — self-hosted server

Self-hosted backend for the Publish to VPS⁠ Obsidian plugin. One image runs the whole stack:

• Node API — receives plugin uploads (/api/**, x-api-key auth), renders and stores publications, serves /content/**, /assets/**, /health.
• Angular site — the public website serving your published notes, on /.

⁠Quick start

docker run -d --name obsidian-vps-publish \
  -p 127.0.0.1:3000:3000 \
  -e API_KEY=change-me \
  -v $(pwd)/content:/content \
  -v $(pwd)/assets:/assets \
  jorouquette/obsidian-vps-publish:latest

Put a TLS reverse proxy in front and point the Obsidian plugin at your endpoint. Full production guide: VPS setup⁠.

⁠Tags

• X.Y.Z — immutable release, lockstep with the plugin version
• latest — most recent stable release
• <short-sha> — commit-pinned build

⁠Configuration

Required: API_KEY. Common: PORT (3000), BASE_URL, ALLOWED_ORIGINS, SITE_NAME, AUTHOR, LOGGER_LEVEL. Volumes: /content (rendered HTML), /assets (published files). Healthcheck: GET /health. Full reference: docker-compose.prod.yml⁠ and docs/docker.md⁠.

⁠Links

• Source & issues: https://github.com/JoRouquette/obsidian-vps-publish⁠
• Plugin on Obsidian Community: https://community.obsidian.md/plugins/vps-publish⁠

License: MIT