Guide
Getting Started
Deploy AuthMe in 30 seconds with Docker Compose, or build from source for full control.
Docker Quick Start
Recommended
The fastest way to get AuthMe running. Requires only Docker and Docker Compose.
Terminal
# Download the docker-compose file
curl -o docker-compose.yml \
https://raw.githubusercontent.com/Islamawad132/Authme/main/docker-compose.yml
# Start AuthMe
docker compose up -dThat's it! AuthMe will start with PostgreSQL and be ready in about 15 seconds.
Available Endpoints
Once running, these endpoints are available on your server:
| URL | Description |
|---|---|
http://localhost:3000/console | Admin Console |
http://localhost:3000/api | Swagger API Docs |
http://localhost:3000/health | Health Check |
http://localhost:3000/metrics | Prometheus Metrics |
Default Credentials
Change these before exposing AuthMe to the internet.
| Field | Default Value |
|---|---|
| Username | admin |
| Password | admin |
| API Key | ADMIN_API_KEY from your .env |
Build from Source
Prerequisites
Node.js 22+
PostgreSQL 16+
Terminal
# Clone the repository
git clone https://github.com/Islamawad132/Authme.git
cd Authme
# Install dependencies
npm install
cd admin-ui && npm install && cd ..
# Configure environment
cp .env.example .env
# Edit .env with your DATABASE_URL
# Setup database
npm run prisma:generate
npm run prisma:migrate
npm run prisma:seed # Optional: sample data
# Build & start
npm run build:all
npm run start:prodDatabase Helper Commands
| Command | Description |
|---|---|
npm run prisma:generate | Regenerate Prisma client |
npm run prisma:migrate | Apply pending migrations |
npm run prisma:seed | Seed with test data |
npm run db:setup | Generate + migrate + seed (all-in-one) |