Guide / Getting started

Install and first launch

Get Corexar running on your computer or server and create the first account.

Corexar Home: a desktop app

Home is the quickest start: one download, no Docker and no database to set up. It runs on macOS (Apple Silicon) and Linux (x86-64 and ARM, including Raspberry Pi 4/5).

  1. Download the archive for your system from the Download page.
  2. macOS: unzip it and drag Corexar.app to Applications. The first time, right-click it, choose Open and confirm: the app is not notarized yet, so macOS asks once. Linux: unpack the archive and run ./Corexar.
  3. Your browser opens Corexar (or open http://localhost:8080 yourself).
  4. Choose Register and create the first account. That account is yours, with full control.
The registration page.

Corexar Server: for a team or your own server

Server runs in Docker Compose together with PostgreSQL, Elasticsearch, Kafka and S3-compatible storage. Follow the Server setup page; when it is up, open its address and register. The account registered with the e-mail from ADMIN_EMAIL becomes the administrator.

Other devices in the family

With Home running, anyone on your network can open http://<this computer’s address>:8080 in a browser and create their own account. If port 8080 is busy, Corexar picks the next free one and shows it.

Tip. Everything Home stores is in one data folder (on macOS: ~/Library/Application Support/Corexar). Copy that folder to make a backup or to move to another computer.