continuwuity-bsd/docs/freebsd/README.md

2.1 KiB

Continuwuity for FreeBSD

Installation instructions

Using a package repository

  1. Define a new package repository in /usr/local/etc/pkg/repos/continuwuity.conf:
continuwuity: {
  url: "https://pkg.kat5.dev/continuwuity/${ABI}",
  signature_type: "fingerprints",
  fingerprints: "/usr/local/etc/pkg/fingerprints/continuwuity",
  enabled: yes
}
  1. Create the signing key at /usr/local/etc/pkg/fingerprints/continuwuity/trusted/repo.fingerprint:
function: sha256
fingerprint: 89d3c8643a95f43292e88309fc9abfe8b9603d24d24e2f617ceb1bd4b8788fe5

Important

You can verify the fingerprint yourself by downloading continuwuity.pub (a GPG signature for which is saved in continuwuity.pub.asc) and running:

sha256sum continuwuity.pub
  1. Update the repo and ensure no signing-related errors are displayed:
pkg update -r continuwuity
  1. Install continuwuity according to the CPU flavor you've chosen:
pkg install continuwuity-generic
  1. Upgrade it with:
pkg upgrade continuwuity-generic

Using .pkg files

  1. Download the latest package build for your FreeBSD version and architecture from the releases page
  2. If upgrading from a previous version, uninstall it first:
pkg remove continuwuity-generic
  1. Install the continuwuity package:
pkg add continuwuity-generic-0.5.5-freebsd15-amd64.pkg

Configuration

  1. Enable the continuwuity service:
service continuwuity enable
  1. Edit the continuwuity config file at /usr/local/etc/continuwuity/continuwuity.toml:

    • Set a server name using the server_name option
    • If your reverse proxy will run on another system, update the address option to listen on a non-loopback interface, e.g. address = ["0.0.0.0", "::"] to listen on all IPv4 and IPv6 addresses
  2. Configure your reverse proxy using the continuwuity docs.

  3. Start continuwuity and check its logs:

service continuwuity start
tail -f /var/log/daemon.log | grep continuwuity