installation.md

Installation

Pre-built binaries

Download any package from the release page.

Homebrew

brew install kyleu/kyleu/projectforge

deb, rpm and apk packages

Download the .deb, .rpm or .apk packages from the release page and install them with the appropriate tools.

Running with Docker

docker run -p 40000:40000 ghcr.io/kyleu/projectforge:latest
docker run -p 40000:40000 ghcr.io/kyleu/projectforge:latest-debug

Built from source

go install

go install projectforge.dev/projectforge@latest

Source code

If you want to contribute to the project, please follow the steps on our contributing guide.

If you just want to build from source for whatever reason, follow these steps:

git clone https://github.com/kyleu/projectforge
cd projectforge
make build
./build/debug/projectforge --help

A script has been provided at ./bin/dev.sh that will auto-reload when the project changes.

Note that you may need to run ./bin/bootstrap.sh before building the project for the first time.