Guide

Projects & Settings

Every project setting explained — from identity and publishing to AI synthesis, integrations, and access control.

Overview

Project settings live at Dashboard → [Project] → Settings, split into five tabs: General, AI, Integrations, Domain, and Access.

Changes to settings never affect already-published entries — only future synthesis runs.

General

Controls how your project appears publicly. Found in Settings → General.

Display name

The heading shown on your public changelog page. Defaults to the GitHub repository name.

Logo

Square image (PNG, JPG, or SVG). 256×256 pixels recommended. Shown on the public changelog page and in the dashboard sidebar.

URL slug

The path segment in your changelog URL: ollum.dev/c/[slug]. Lowercase letters, numbers, and hyphens only. Changing the slug immediately changes the public URL — update any shared links before saving.

Publishing

Controls which branch triggers synthesis and whether entries publish automatically. Found in Settings → General.

Target branch

Only pushes to this branch trigger changelog synthesis. Typically your default branch (main or master). The dropdown is populated from your repository's actual branches.

Auto-publish without review

When enabled, new entries go live immediately — no Drafts step. When disabled (default), every entry lands in Drafts for your review. Disable if you want to edit, add tags, or approve entries before they reach subscribers.

Public page

Controls what appears on the public changelog at /c/[slug]. Found in Settings → General.

Show author

Displays your name, role, and avatar on each published entry. Requires setting up your author profile in Account settings first — at minimum, add your name. The toggle is disabled until the profile is configured.

AI synthesis

Shape how Ollum generates changelog entries from your commits. Found in Settings → AI.

Writing tone

Professional

Polished, product-focused language. Good for B2B SaaS and tools where users expect formal communication.

Casual

Conversational and friendly. Good for consumer apps, indie products, and direct-to-developer tools.

Technical

Precise and developer-oriented — more technical detail, less marketing language. Good for developer tools and libraries.

Generation sensitivity

Controls how much activity must accumulate before a changelog entry is auto-generated. Prevents noisy changelogs from tiny pushes.

High

Generates sooner, on smaller batches. A few commits may be enough to trigger synthesis. Best for repos that ship infrequently but want a changelog for every change.

Medium

Balanced. Ollum waits for a meaningful batch before generating. Recommended for most repos.

Low

Accumulates significantly more changes before generating. Best for repos with very frequent small commits, such as monorepos or active open-source projects.

Context toggles

Include file diffs

Passes the actual code diff to the AI, giving it more context when writing entries. Increases synthesis quality. Disable if you want faster generation on very large PRs.

Include PR comments

Passes pull request discussion and review comments to the AI. Useful when your team documents feature decisions or tradeoffs in PR threads.

Include commit metadata

Passes author names, timestamps, and branch information to the AI. Useful for multi-contributor repos where authorship context matters.

Fine-tuning

Excluded PR labels

Comma-separated list of GitHub PR labels to skip entirely. Examples: "chore, internal, skip-changelog". Useful for filtering out dependency bumps, CI changes, and internal refactors that should not appear in the changelog.

Product context

A short description of what your product does and who uses it. Helps Ollum write user-facing language. Example: "Ollum is a changelog tool for indie founders. Users are non-technical — explain features in plain terms."

Example entry

Paste a sample changelog entry to guide the AI tone and structure. The AI will try to match the style, length, and formatting of your example.

Integrations

Found in Settings → Integrations.

Webhook URL

When a new draft is generated, Ollum sends a POST request to this URL with a JSON body containing the new draft entry. Leave blank to disable. Common uses: Slack notifications, Discord alerts, custom dashboards.

Your endpoint must respond within 10 seconds with a 2xx status. Ollum does not retry on failure.

API key

A secret key for authenticating requests to the Ollum REST API.

Generate key

Click to generate a new API key. The key is shown once — copy it immediately. Ollum stores only a hash; the raw key cannot be retrieved later.

Regenerate

Invalidates the existing key and creates a new one. The old key stops working immediately — update any integrations before clicking Regenerate.

See the API Reference for available endpoints and request examples.

Custom domain

Requires Indie or Pro plan

Point your own domain at your changelog or status page. Found in Settings → Domain. There are two independent domain cards — one for the changelog, one for the status page.

1. Enter your domain

Type your subdomain (e.g. changelog.myapp.com) and click Save.

2. Add the CNAME

Ollum shows you the exact CNAME target value after saving. Add a CNAME record in your DNS provider pointing your subdomain to that value.

3. Verify

Click Verify. DNS propagation can take a few minutes to up to 48 hours depending on your provider's TTL settings.

4. Go live

Once verified, your changelog is accessible at your custom domain.

Access

Requires Pro plan

Require a password to view your public changelog. Found in Settings → Access.

Set password

Minimum 6 characters. Once set, visitors must enter the password before viewing any entries. The password is hashed — Ollum cannot recover it.

Change password

Enter a new password and click Change. This immediately signs out all current visitors.

Remove

Removes password protection. Your changelog becomes publicly accessible again immediately.

Danger zone

Found in Settings → Access (project owner only).

Delete project

Permanently deletes this project, all published and draft changelog entries, all subscribers, and all status incidents. Type the project slug to confirm. This cannot be undone.

Working with a team? Teams & Workspaces →