LICENSE Documentation

1. Project Overview & Quickstart (go-vikunja/LICENSE) Copy Chapter

1. Project Overview & Quickstart (go-vikunja/LICENSE) Copy Chapter

LICENSE

Open-source repository go-vikunja/LICENSE

Repository Details Copy Section

• Repository: go-vikunja/LICENSE
• Primary Language: Code

Note: High-volume repository documentation is actively indexed and synchronized by YakaAI.

2. Official Technical Reference & Guides (go-vikunja/website) Copy Chapter

Vikunja Homepage

This project holds the source code for the Vikunja homepage at vikunja.io.

🚀 Project Structure Copy Chapter

Inside of your Astro project, you'll see the following folders and files:

/
├── public/
│   └── favicon.svg
├── src/
│   ├── components/
│   │   └── Card.astro
│   ├── layouts/
│   │   └── Layout.astro
│   └── pages/
│       └── index.astro
└── package.json

Astro looks for .astro or .md files in the src/pages/ directory. Each page is exposed as a route based on its file name.

There's nothing special about src/components/, but that's where we like to put any Astro/React/Vue/Svelte/Preact components.

Any static assets, like images, can be placed in the public/ directory.

🧞 Commands Copy Chapter

All commands are run from the root of the project, from a terminal:

👀 Want to learn more? Copy Chapter

Feel free to check our documentation or jump into our Discord server.

2. Official Technical Reference & Guides (go-vikunja/website) Copy Chapter

File: README.md Copy Chapter

Vikunja Homepage

This project holds the source code for the Vikunja homepage at vikunja.io.

🚀 Project Structure Copy Chapter

Inside of your Astro project, you'll see the following folders and files:

/
├── public/
│   └── favicon.svg
├── src/
│   ├── components/
│   │   └── Card.astro
│   ├── layouts/
│   │   └── Layout.astro
│   └── pages/
│       └── index.astro
└── package.json

Astro looks for .astro or .md files in the src/pages/ directory. Each page is exposed as a route based on its file name.

There's nothing special about src/components/, but that's where we like to put any Astro/React/Vue/Svelte/Preact components.

Any static assets, like images, can be placed in the public/ directory.

🧞 Commands Copy Chapter

All commands are run from the root of the project, from a terminal:

👀 Want to learn more? Copy Chapter

Feel free to check our documentation or jump into our Discord server.

File: scripts/screenshots/README.md Copy Chapter

Screenshot Automation

Automated screenshot capture for the Vikunja website using Playwright.

Prerequisites Copy Chapter

• Vikunja backend running on :3456 with testing token enabled:
  yaml Copy

  service:
    testingtoken: averyLongSecretToSe33dtheDB
    interface: ":3456"

• Vikunja frontend served on :4173 (e.g. pnpm build && pnpm preview or pnpm dev)

Usage Copy Chapter

# Install dependencies
pnpm install

# Run all screenshot specs
pnpm screenshots

# Run a specific spec
pnpm screenshots -- specs/dashboard.spec.ts

# Run in headed mode (see the browser)
pnpm screenshots:headed

# Run with Playwright inspector for debugging
pnpm screenshots:debug

Spec Files Copy Chapter

Help page specs (`specs/*.spec.ts`) Copy Section

Generate screenshots for the end-user help documentation. Output: src/assets/images/help/

Homepage carousel (`specs/homepage-carousel.spec.ts`) Copy Section

Generates 8 full-page (1280×900) screenshots used in the homepage image carousel. Output: src/assets/images/vikunja/

Features page (`specs/features-page.spec.ts`) Copy Section

Generates 5 cropped content-area screenshots for the features page. Output: src/assets/images/vikunja/features/

Flathub images Copy Section

After all specs run, copy-flathub.ts copies select homepage carousel images to public/flathub-images/ for the Flathub app listing.

Output Directories Copy Chapter

The screenshot fixture accepts a dir option to control the output subdirectory under src/assets/images/:

await screenshot('my-shot', page, {dir: 'vikunja'})       // → src/assets/images/vikunja/my-shot.png
await screenshot('my-shot', page, {dir: 'vikunja/features'}) // → src/assets/images/vikunja/features/my-shot.png
await screenshot('my-shot', page)                          // → src/assets/images/help/my-shot.png (default)

Test Image Assets Copy Chapter

Two test images are stored in support/ for use in specs that need task attachments or project backgrounds:

• test-image.jpg — Used as an inline task attachment in task detail screenshots
• test-background.jpg — Used as a project background in the kanban background screenshot

To replace them, drop in new JPEG files with the same filenames and re-run the specs.

Adding New Screenshots Copy Chapter

1. Create a new spec file in specs/ (or add to an existing one)
2. Use the test and screenshot fixtures from support/fixtures.ts
3. Use createPopulatedProject() from support/seed-helpers.ts to seed realistic data
4. Pass {dir: 'your/subdir'} to screenshot() for non-help output directories
5. Use locator targets for cropped shots of specific UI elements
6. Use page.screenshot({ clip }) via the options parameter for custom-cropped areas
7. Run the spec to verify the screenshot looks correct

File: scripts/README.md Copy Chapter

Scripts

publish-release Copy Chapter

Cross-posts a release blog post to Mastodon, Bluesky, GitHub Releases, Discourse, Matrix, LinkedIn, and Listmonk.

Usage Copy Section

node scripts/publish-release.js <version> [--dry-run]

Example:

node scripts/publish-release.js 2.2.0
node scripts/publish-release.js 2.2.0 --dry-run

The script:

1. Finds the blog post at src/content/changelog/release-<version>.mdx
2. Generates short (tweet-style) and LinkedIn content variants using claude -p
3. Opens $EDITOR to review and edit the generated content
4. Posts to each platform with a [Y/n] confirmation prompt
5. Prints a summary of all posted links

--dry-run skips all API calls and prints what would be posted.

Prerequisites Copy Section

• Node.js 20+
• Claude CLI (claude must be on PATH)
• GitHub CLI (gh) authenticated for GitHub Releases

API setup Copy Section

Create a .env file in the project root (already gitignored) with the credentials for each platform. Platforms with missing credentials are skipped automatically.

# Mastodon (social.linux.pizza)
# Create an application at: https://social.linux.pizza/settings/applications
# Required scopes: write:statuses
MASTODON_TOKEN=

# Bluesky
# Create an app password at: https://bsky.app/settings/app-passwords
BLUESKY_HANDLE=
BLUESKY_APP_PASSWORD=

# Discourse (community.vikunja.io)
# Create an API key at: https://community.vikunja.io/admin/api/keys
# Scope: topics (create)
DISCOURSE_API_KEY=
DISCOURSE_USERNAME=

# Matrix (#vikunja:matrix.org)
# Get an access token by logging in via the client-server API or from Element's settings
MATRIX_ACCESS_TOKEN=
MATRIX_HOMESERVER=https://matrix.org
MATRIX_ROOM_ID=

# Listmonk
# Create an API user and token at: Admin -> Users
# Required permissions: campaigns:manage
LISTMONK_URL=https://your-listmonk-instance.example.com
LISTMONK_API_USER=
LISTMONK_API_TOKEN=
# List ID to send the campaign to (find at Lists -> click list -> ID in URL)
LISTMONK_LIST_ID=

GitHub Releases uses the gh CLI's existing authentication — no extra credentials needed. Run gh auth status to verify.

LinkedIn has no API integration — the script prints the post text for you to copy and post manually.

File: src/content/help/accessibility.mdx Copy Chapter

title: Accessibility slug: accessibility How to use Vikunja with a keyboard, adjust display and sound, and what works with screen readers, plus current limitations and how to report problems. Copy Chapter

import Callout from '../../components/Callout.astro';

Vikunja is built to work without a mouse and to adapt to how you read and hear the interface. This page covers the keyboard shortcuts, the display and sound settings, and what currently works with assistive technology, including the parts that are still rough.

Using Vikunja with a keyboard Copy Chapter

You can reach and open every task without dragging, clicking, or pointing. The shortcuts below work throughout the app; press ? at any time to open the shortcut reference for wherever you happen to be.

On every page Copy Section

Search doubles as a command palette, so Ctrl+K also gets you to any task or project by name and lets you create new ones without leaving the page.

Moving around Copy Section

These are chords: press the first key, release it, then press the second.

Inside a project, the same pattern switches views: g then l for List, g then t for Table, g then k for Kanban, and g then g for Gantt.

In the List view Copy Section

On a task Copy Section

When a task is open, single-key shortcuts jump straight to each field, so you never have to tab through the whole page to change one thing.

Pressing . copies the task identifier; press it twice for the identifier and title, three times to add the URL. Ctrl+. / Cmd+. copies the task URL on its own.

Doing without drag-and-drop Copy Section

Most things you can drag, you can also do from the keyboard:

• Move a task between Kanban buckets: open the task and use the bucket dropdown in the breadcrumb line at the top. You don't need to drag the card.
• Reschedule in the Gantt view: press Tab to land on a task bar, then use the Left and Right arrow keys to move it a day at a time. Separate buttons resize the start and end. Hold Shift with an arrow to extend the bar, or Ctrl / Cmd to shrink it.
• Set dates without the calendar grid: in any date picker you can type the date directly, and there are separate month, year, and time controls if you'd rather step through them.
• Write descriptions by keyboard: the rich-text editor is fully operable without a mouse. Markdown shortcuts work as you type (# for headings, - for a bullet, 1. for a numbered list, [] for a checkbox), Ctrl+S / Cmd+S saves, and Tab moves focus out of the editor rather than trapping you in it.

On Safari, Tab skips over links by default, so keyboard navigation can feel like it's missing stops. Turn on Safari → Settings → Advanced → "Press Tab to highlight each item" to Tab through everything, or hold Option while you press Tab.

Display and sound Copy Chapter

• Color scheme: choose Light, Dark, or System (which follows your operating system) under Settings → General → Color Scheme. See Settings.
• Zoom: the layout reflows at 200% browser zoom without cutting off or hiding content, so you can enlarge text with your browser's own zoom.
• Completion sound: the pop that plays when you finish a task can be turned off under Settings → General.

Screen readers and assistive technology Copy Chapter

Vikunja is built with semantic structure that assistive technology can use: page landmarks, labeled controls, a skip-to-content link, and live-region announcements that read out the result of an action. The Gantt chart carries an ARIA description of what it shows. Images you add to a task description can be given alt text: select the image and choose Alt text in the bubble menu that appears.

If you're picking a combination, VoiceOver works best with Safari, and NVDA with Chrome or Firefox. VoiceOver paired with Firefox announces headings and languages poorly; that's a limitation of the browser, not something we can fix from Vikunja's side.

What doesn't work yet Copy Chapter

We'd rather tell you plainly than have you fight the interface:

• Reordering cards within a Kanban bucket and manually reordering the List view are drag-and-drop only. The workaround is to sort instead: pick a sort order and the tasks arrange themselves.
• Renaming a Kanban bucket still needs a pointer.
• Some color-contrast and announcement issues are still being fixed. A July 2026 accessibility audit kicked off a round of improvements, and the work is ongoing.

Reporting an accessibility problem Copy Chapter

If something gets in your way, report it the same way you'd report any bug:

• Open an issue on GitHub
• Post on the community forum
• Email [email protected]

Every one of these is text-based, so you can reach us however works for you.

File: src/content/help/caldav.mdx Copy Chapter

title: CalDAV slug: caldav Sync tasks with external apps using CalDAV. Covers supported properties, URLs, and client compatibility. Copy Chapter

import Screenshot from '../../components/Screenshot.astro'
import {VIKUNJA_CLOUD_LINK} from '../../helpers/vikunjaCloudLink'

Warning: The CalDAV integration is in an early alpha stage and has bugs.
It works well with some clients while having issues with others.
If you encounter issues, please report them

Vikunja supports managing tasks via the caldav VTODO extension.

You can find your CalDAV connection details in your Settings under the CalDAV tab.

done = false && priority >= 3 && dueDate > now && dueDate < now+7d

priority >= 3

done = false && priority >= 3

(priority = 1 || priority = 2) && dueDate <= now