Source: https://www.brixit.io/docs/installation

# Installation and setup

## Requirements

| | Minimum | Comfortable |
| --- | --- | --- |
| CPU | 2 cores | 4 cores |
| Memory | 4 GB | 8 GB |
| Disk | 40 GB SSD | 80 GB SSD |

You also need Docker with the Compose plugin, a domain name with an A record pointing at the
server, and ports 80 and 443 reachable from the internet. Port 80 has to be open even if you
only intend to serve HTTPS — that is how the TLS certificate is issued and renewed.

## Install

Download the release bundle, unpack it, and run the installer from the directory it creates:

```bash
tar -xzf brixit-*.tar.gz
cd brixit
./install.sh
```

The script asks for your domain, an administrator email and password, and the country you
operate in. It then writes the configuration, starts the containers, applies the database
schema, and issues a TLS certificate.

The country matters more than it looks: it sets your default currency and timezone, and it
decides which property portals are offered to you. You can change it later in
**Settings → Company**, but starting with the right one saves correcting several things.

## First run

When the script finishes, open your domain and sign in with the administrator account you just
created. Three things are worth checking straight away.

**Email.** Go to **Settings → Notifications** and send a test message. Nothing else in the
product works properly until mail does — invitations, password resets and enquiry alerts all
depend on it.

**Your company details.** **Settings → Company** holds the name, logo and currency that appear
on everything your clients see, including shared listing pages.

**Your first colleague.** Add someone under **Employees**. You can either let Brixit generate a
password and email it to them, or set one yourself and pass it on another way — useful when the
address you have for them is not reachable yet.

## Upgrading

Updates appear under **Settings → Updates**. Installing one takes a few minutes, during which
the application restarts and is briefly unavailable. Your data is backed up before the upgrade
begins, and if anything fails the previous version is restored automatically.

## If something goes wrong

Check the container logs first:

```bash
docker compose logs --tail=200 backend
```

The installer is safe to run again. It detects what already exists and only fills in what is
missing, so a run that failed part way through can be resumed rather than started over.
