Brick Work GitHub
Menu
Home / Install

Install Brick Work in about five minutes.

It runs in a container on your own computer or server. Your data stays in one folder you back up.

Docker Compose

Pulls the published image for amd64 and arm64. Then open it in the browser.

git clone --branch v1.0.1 https://github.com/Ulef1005/brick-work.git && cd brick-work
mkdir -p data && sudo chown 1000:1000 data
cp .env.sample data/.env # set BW_AUTHENTICATION_PASSWORD
docker compose pull
docker compose up -d

Then open http://localhost:3333 and sign in with your password.

Single user, home networkBrick Work is meant for a home network or a VPN, not the open internet. Without a password the server refuses to start, because anyone who can reach it could edit the collection.
No server, no Git

Docker Desktop on Windows or Mac

About 15 minutes and a few GB of disk space. Tested on macOS; the Windows steps are the same, typed in PowerShell, but no test on a real Windows computer is recorded yet.

  1. 1
    Install Docker Desktop
  2. 2
    Make a Brick Work folder
  3. 3
    Add two files
  4. 4
    Start Brick Work
  5. 5
    Open it
Docker Desktop guide

Unraid

Run the same image and set the user to 99:100, the ids Unraid gives a shared folder.

NAS

If the shared folder is not owned by uid 1000, set the user to the folder owner's ids instead of changing ownership. Put the pictures on the NAS with BW_MEDIA_PATH and keep the database on fast local storage.

Read the notes in the README
After you install

Get started takes four steps.

Every step can be skipped for now and taken back. It opens again from Tools & Admin.

1

Load the catalogue

Needs no key.

2

Set up your keys

Optional.

3

Bring your collection in

Or add your first set.

4

See how the inventory works

A short tour.

Try the demo firstMoving an old collection over?Upgrade and back up