Installation

Binaries

You can get Faccina through the releases on GitHub. Binaries are still experimental and it's recommended to run Faccina with the source code directly.

You can also compile Faccina to a binary yourself. Just run build.sh (macOS/Linux) or build.ps1 (Windows) after installing the dependencies with bun install.

From Source (recommended)

First you will need to clone the repository or get an archive.

Run this command to clone the repository with git:

git clone https://github.com/LetrixZ/faccina

Now you will need to install Bun if you don't have it already. You can get it from here: https://bun.sh

Once installed, go to the folder where the source code is and install the dependencies using Bun:

bun install --frozen-lockfile

Before you can build the web app, you will need to create a configuration file named config.toml. You can use the example one for now:

cp config.example.toml config.toml

Now you can build the web app by running:

bun run build

Once finished, you can start the web app by running:

bun start

You can also start it in cluster mode so it runs many instances according to the numbers of threads you have:

bun cluster

The web app will be available at port 3000.

You can already use Faccina like this, although it's recommended that you read the rest of the documentation to know how to configure it so you can point it to where you have your content, where to store thumbnails and more.