Reading the repo

Opening the box…

How to install zerobyte on macOS (nicotsx/zerobyte) · gitmanual

How to install on macOS

nicotsx/zerobyte

Backup automation for self-hosters. Built on top of restic

Node.jsVite#backup#backup-utility#restic#self-hosted

Difficulty: Moderate
Time: about 15 min
Stars: ★ 7,264
Activity: Updated this month
License: AGPL-3.0
Open issues: 117
Got it running: Be the first
Looked up: 2 h ago

Saved setup from 2 h ago

Start here

Website ↗zerobyte.appThe project's own site.Docs ↗zerobyte.appLinked from the README.

Will it work on my device?

Yes, it installs on your macOS

A ready-made macOS download is in the latest release.

Checking for

macOS Windows Linux

Download for macOS

v0.44.0 · 10/31/2026 ↗

zerobyte-v0.44.0-mac-arm64.dmg

dmg · Apple Silicon · 180.9 MB · 22 downloads · best match

Download

Drag the app into Applications.

curl -LO "https://github.com/nicotsx/zerobyte/releases/download/v0.44.0/zerobyte-v0.44.0-mac-arm64.dmg"
open "zerobyte-v0.44.0-mac-arm64.dmg"

Run it with Docker

A self-hosted app: Docker runs it on your computer and you open it in the browser. Needs Docker Desktop (or Docker Engine on Linux). Run docker compose commands inside the cloned repo folder.

Docker

docker compose up -d

From the README, exactly as the maintainers wrote it.

Did you get it running?

No reports for macOS yet.

Still stuck? Ask an AI

Opens a chat with this manual already filled in, for macOS. It uses your own account; gitmanual sends nothing.

Ask Claude Ask ChatGPT

Parts list

1×Node.js LTS (no version pinned)runtime
1×Bun runtime
1×Docker tool
1×bun bun@1.4.4package manager

16× settings in .env

TZ
HOST_DATA_DIR
SERVER_IP
ZEROBYTE_DATABASE_URL
RESTIC_CACHE_DIR
ZEROBYTE_REPOSITORIES_DIR
ZEROBYTE_VOLUMES_DIR
ENABLE_REMOTE_AGENTS
ZEROBYTE_AGENT_ALLOW_INSECURE_HTTP
APP_SECRETsecret
BASE_URL
TRUST_PROXY
PORT
RCLONE_CONFIG_DIR
ZEROBYTE_AWS_ACCESS_KEY_IDsecret
ZEROBYTE_WEBDAV_PASSWORDsecret

Featured in Zain Finds

See the poster ↗Wow 🤩, restic (backup program) with an actual UI? 😳

Share this manual

Is this your repo?

Add a badge to your README so newcomers find these steps.

[![Setup manual](https://gitmanual.com/nicotsx/zerobyte/badge.svg)](https://gitmanual.com/nicotsx/zerobyte)

Good to know

Monorepo (workspaces) — install from the repo root.
Dockerfile available (base image: oven/bun:1.4.4-alpine@sha256:4cf82f5686b196504fe119db3fcd9185b191f82ece82c40680e597228ec6070a).
Has AGENTS.md — instructions for coding agents. You can open Claude Code (or another agent) in the cloned folder and ask it to do the setup for you.
Nested projects: apps/agent/package.json, apps/desktop/package.json, apps/docs/package.json, packages/contracts/package.json and 1 more

package.json scripts (35)

fmtbun fmt --no-script
fmt:checkbun fmt --no-script --check
lintbunx --bun oxlint --type-aware
lint:fixbunx --bun oxlint --type-aware --fix --no-error-on-unmatched-pattern
lint:cibunx --bun oxlint --type-aware --deny-warnings
checkbun run lint && bun run typecheck && bun run fmt:check
devNODE_ENV=development portless --tailscale run bunx --bun vite
dev:agentbun scripts/deploy-dev-agent.ts
dev:desktopbun run --cwd apps/desktop start
buildbunx --bun vite build && bun build apps/agent/src/index.ts --outfile .output/agent/index.mjs --target bun
build:api-docsNODE_ENV=test dotenv run -f .env.test -- bun scripts/export-api-docs.ts
build:agentbun build apps/agent/src/index.ts --compile --no-compile-autoload-dotenv --no-compile-autoload-bunfig --env 'ZEROBYTE_AGENT_VERSION*'
build:desktopbun run --cwd apps/desktop make
startbun run .output/server/index.mjs
test:integrationbash app/test/integration/run.sh
previewbunx --bun vite preview
cli:devbun run app/server/cli/main.ts
cliZEROBYTE_CLI=1 bun .output/server/_chunks/ssr.mjs
tscbun run typecheck
start:devdocker compose down && docker compose up --build zerobyte-dev
start:proddocker compose down && docker compose up --build zerobyte-prod
start:e2edocker compose down && mkdir -p playwright/data playwright/temp playwright/tinyauth/app-data playwright/tinyauth/caddy-data && rm -rf playwright/data/* playwright/.auth/user.json playwright/restic.pass playwright/temp/* playwright/tinyauth/app-data/* playwright/tinyauth/caddy-data/* && docker compose up --build zerobyte-e2e zerobyte-e2e-https
start:distrolessdocker compose down && docker compose up --build zerobyte-distroless
gen:api-clientNODE_TLS_REJECT_UNAUTHORIZED=0 dotenv run -f .env.local -- openapi-ts
gen:migrationsdotenv run -f .env.local -- drizzle-kit generate

Files we read (17)

.env.example

.github/workflows/agent-image.yml

.github/workflows/api-docs-deploy.yml

.github/workflows/branch-image.yml

.github/workflows/checks.yml

.github/workflows/desktop-alpha.yml

.github/workflows/desktop-build.yml

CONTRIBUTING.md

Dockerfile

README.md

compose.yaml

examples/basic-docker-compose/.env.example

examples/directory-bind-mount/.env.example

examples/provisioned-resources/.env.example

examples/rclone-config-mount/.env.example

examples/simplified-docker-compose/.env.example

package.json

Branch main · 1,297 files in the repo