Admin Quickstart (Docker)
This guide is for administrators who want to run EZ Inventory on a server using Docker Compose.
Prerequisites
- Docker Engine installed
- Docker Compose plugin installed
- A host with open ports
3000(app) and3001(api)
1. Start EZ Inventory
bash
git clone https://github.com/tobiaswaelde/ezinventory.git
cd ezinventory
cp .env.example .env
docker compose up -d --buildCheck status:
bash
docker compose psExpected services:
app(Nuxt frontend)api(NestJS backend)postgresrustfs
2. Open URLs
- App:
http://localhost:3000 - API docs:
http://localhost:3001/api/docs - Health check:
http://localhost:3001/api/v1/health
3. Complete First-Time Admin Setup
- Open
/auth/signupand create the first account. - Sign in and open
Settings. - Set
Registration ModetoADMIN_ONLY. - Create team members in
Create User (Admin). - Optionally register a passkey in
Profile Security.
4. Core Admin Configuration
Required environment settings
For production-like setups, review these values:
DATABASE_URLAUTH_ACCESS_TOKEN_SECRETAUTH_REFRESH_TOKEN_SECRETAUTH_PASSKEY_RP_IDAUTH_PASSKEY_ORIGINCORS_ORIGIN
Template files:
.env.exampleapps/api/.env.example.env.deploy.example
5. Daily Admin Commands
Update and redeploy:
bash
git pull
docker compose up -d --buildRead logs:
bash
docker compose logs -f app
docker compose logs -f apiStop everything:
bash
docker compose down6. Next Step
Continue with Admin Feature Tour for screenshots and detailed explanations of each function.