Open source ยท MIT

Run Izbik on your own server

The app on izbik.com is the open-source app on GitHub. Run it on a laptop for yourself or on a server for your studio, and keep every project on your own disk.

What you need

Docker with Compose

The stack is a proxy, the frontend, the backend, MariaDB and MinIO, built and started by one command.

make and openssl

The make targets create the configuration and generate the secrets on the first run.

A modest server

The 3D work happens in the browser, so the server mostly stores and serves the projects.

Start in three commands

The first run creates .env from the example and generates the token and Mercure secrets. The backend applies the database migrations on start, so a fresh install comes with the material and furniture catalogues.

  • New users sign up at /sign-up; admins manage accounts under Users
  • Upload plans, photos and product models from the app or with make targets
  • Connect agents at http://your-host/mcp
~/izbik
# Get the code and start the stack
$ git clone https://github.com/marekskopal/izbik.git
$ cd izbik && make up
# Create the first admin account
$ make admin
# Open http://localhost:4400

Configuration

Everything is in .env, and .env.example documents each variable. The ones you will touch:

VariablePurpose
PROXY_PORTHTTP port of the proxy (default 4400)
PROXY_HOSTPublic hostname. Needed for OAuth and MCP behind a domain
AUTHORIZATION_TOKEN_KEYJWT signing key, generated on the first run. Changing it signs everyone out
MYSQL_*Database connection
S3_*Object storage; the bundled MinIO by default
FILE_MAX_SIZE_MBLargest accepted upload

HTTPS

Add the SSL compose file in .env and point it at your certificate, or terminate TLS in front of the stack.

Storage

Files go to the bundled MinIO, or to any S3-compatible service with the S3_* variables.

Updates

Pull the new release and run make up; migrations run on start. Back up the database volume first.

Rather not run a server?

izbik.com is the same app, hosted, and free while in beta.