Your own domain
Serve a product's release notes from its own domain, verified with a DNS record.
Release documentation & publishing
DocPulse keeps the full internal record of every release: changes, documents, deployments and reviews. Your customers see only the notes a second person approved, on a public page you design for each product.
// Two records, one release
Every change carries an internal description for the team and, optionally, a public one. Only changes with a public description can ever reach the public page, and only after approval.
// Publishing
The author freezes the public notes into a revision. Someone else approves exactly that revision, and an Admin or Release manager publishes it. Change a word afterwards and it needs a new revision.
Draft
Write the release and its changes. Internal notes stay internal.
Self-approval is refused by the server, even for system administrators, and every decision is in the audit log.
// Public page designer
Pick a theme, a layout and the widgets you want, preview it on desktop, tablet and mobile, then publish the design. Visitors only ever see the published version.
// GitHub import
The importer reads a repository's GitHub releases and publishes them through the same approval flow. Four-part hotfix tags become proper versions, and pull-request titles are tidied into readable public notes.
stable-3.1.03.1.0Minorstable-3.2.03.2.0Minorstable-3.2.0.13.2.0-hotfix.1Hotfixstable-3.2.43.2.4Patch* feat/k4x9q2 dark mode for reports by @octo-dev in https://github.com/acme/web/pull/128
FeatureDark mode for reports
The author handle and link stay in the internal notes. The real GitHub release date is kept, and re-running the import skips what's already there. The importer script is in the source repository.
// Everything around the notes
Serve a product's release notes from its own domain, verified with a DNS record.
Readers subscribe by feed or by email, with double opt-in and one-click unsubscribe.
Publish a release in several languages. The page comes in English, Sinhala and Tamil.
Share a release with chosen client groups instead of everyone.
Release files are checked by a malware scanner before they can be made public.
An append-only record of every change, approval and publication, exportable as CSV.
GitHub App and signed webhooks link commits and deployments to releases.
Page and release views without visitor tracking, with export for reports.
// Users & roles
Roles are set per project. System administrators manage everyone from one page, with one-time password links instead of shared passwords.
// Security
The public site can't see drafts or internal notes. Published snapshots can't be edited, only revoked.
// Setup
DocPulse ships as four Docker images. One compose file starts them with PostgreSQL and Redis, and serves the release pages and the admin portal from a single port.
Any Linux, macOS or Windows machine with Docker and Docker Compose v2 (included in current Docker Desktop and Docker Engine), and about 2 GB of free memory.
mkdir docpulse && cd docpulse
curl -fsSLO https://qulaxy.com/DocPulse-Site/setup/docker-compose.yml
curl -fsSL -o .env https://qulaxy.com/DocPulse-Site/setup/env.examplemkdir docpulse; cd docpulse
Invoke-WebRequest https://qulaxy.com/DocPulse-Site/setup/docker-compose.yml -OutFile docker-compose.yml
Invoke-WebRequest https://qulaxy.com/DocPulse-Site/setup/env.example -OutFile .envOpen .env and give POSTGRES_PASSWORD and the six secrets long random values. This fills them all in for you:
for k in POSTGRES_PASSWORD JWT_ACCESS_SECRET BOOTSTRAP_SECRET WORKER_SECRET \
NOTIFICATION_SECRET GITHUB_WEBHOOK_SECRET DEPLOYMENT_WEBHOOK_SECRET; do
sed -i.bak "s|^$k=.*|$k=$(openssl rand -hex 32)|" .env
done$rng = [Security.Cryptography.RandomNumberGenerator]::Create()
$env_ = Get-Content .env
foreach ($k in 'POSTGRES_PASSWORD','JWT_ACCESS_SECRET','BOOTSTRAP_SECRET','WORKER_SECRET',
'NOTIFICATION_SECRET','GITHUB_WEBHOOK_SECRET','DEPLOYMENT_WEBHOOK_SECRET') {
$b = New-Object byte[] 32; $rng.GetBytes($b)
$env_ = $env_ -replace "^$k=.*", ("$k=" + (($b | ForEach-Object { $_.ToString('x2') }) -join ''))
}
$env_ | Set-Content .envdocker compose up -dOpen the admin portal at http://admin.localhost:8080, choose Create its first admin and enter the BOOTSTRAP_SECRET from .env. Release pages appear on http://localhost:8080. The first start takes a minute while the database is prepared.
// Your own domain
Point two names at the server, such as releases.example.com and admin.releases.example.com, and set PUBLIC_URL and ADMIN_URL in .env. Put HTTPS in front with your usual proxy, and list it in TRUSTED_PROXY_IPS.
// Updates
docker compose pull
docker compose up -dDatabase changes apply automatically on start. Pin a version with DOCPULSE_VERSION in .env.
// Backups
docker compose exec postgres \
pg_dump -U docpulse docpulse > backup.sqlEmail delivery and malware scanning for attachments are optional and set in .env.
ghcr.io/kasunrocz-softwares/docpulse-apighcr.io/kasunrocz-softwares/docpulse-webghcr.io/kasunrocz-softwares/docpulse-workerghcr.io/kasunrocz-softwares/docpulse-migrateDocPulse is a KasunRocz Softwares project. The source code and the Docker images are public.