local-it/vikunja-api
Archived
0
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
This repository has been archived on 2025-10-28. You can view files and clone it, but you cannot make any changes to it's state, such as pushing and creating new issues, pull requests or comments.
vikunja-api/docs/content/doc/setup/install.md

2.8 KiB
Raw Blame History

date title draft type menu
2019-02-12:00:00+02:00 Installing false doc
sidebar
parent weight
setup 10

Installing

Vikunja consists of two parts: API and frontend.

You will always need to install at least the API. To actually use Vikunja you'll also need to somehow install a frontend to use it. You can either:

  • [Install the web frontend]({{< ref "install-frontend.md">}})
  • Use the desktop app, which is essentially a web frontend packaged for easy installation on desktop devices
  • Use the mobile app only, but as of right now it only supports the very basic features of Vikunja

Vikunja can be installed in various ways. This document provides an overview and instructions for the different methods.

  • [API]({{< ref "install-backend.md">}})
    • [Installing from binary]({{< ref "install-backend.md#install-from-binary">}})
      • [Verify the GPG signature]({{< ref "install-backend.md#verify-the-gpg-signature">}})
      • [Set it up]({{< ref "install-backend.md#set-it-up">}})
      • [Systemd service]({{< ref "install-backend.md#systemd-service">}})
      • [Updating]({{< ref "install-backend.md#updating">}})
      • [Build from source]({{< ref "install-backend.md#build-from-source">}})
    • [Docker]({{< ref "install-backend.md#docker">}})
    • [Debian packages]({{< ref "install-backend.md#debian-packages">}})
    • [Configuration]({{< ref "config.md">}})
    • [UTF-8 Settings]({{< ref "utf-8.md">}})
  • [Frontend]({{< ref "install-frontend.md">}})
    • [Docker]({{< ref "install-frontend.md#docker">}})
    • [NGINX]({{< ref "install-frontend.md#nginx">}})
    • [Apache]({{< ref "install-frontend.md#apache">}})
    • [Updating]({{< ref "install-frontend.md#updating">}})
  • [Reverse proxies]({{< ref "reverse-proxies.md">}})
  • [Full docker example]({{< ref "full-docker-example.md">}})
  • [Backups]({{< ref "backups.md">}})

Installation on kubernetes

A third-party Helm Chart is available from the k8s-at-home project here.

Other installation resources