Quickstart

LifyGo can be used in two ways:

Hosted Cloud — Start sending emails in minutes with no infrastructure to manage.
Self-Hosted — Deploy LifyGo on your own server for complete control.

Choose the option that best fits your needs.

Hosted Cloud (2 Minutes)

No installation. No server management. No credit card required.

1. Create an Account

Visit:

https://lifygo.com/sign-up

Create your free LifyGo account.

2. Generate an API Key

From the dashboard:

Open API Keys
Click Generate Key
Copy the generated API key

The API key is shown only once.

3. Send Your First Email

curl -X POST https://api.lifygo.com/send \
  -H "X-API-Key: lfy_your_key" \
  -H "Content-Type: application/json" \
  -d '{
    "to":"hello@example.com",
    "subject":"Test",
    "body":"It works."
  }'

That’s it! The same API key can also be used for:

Email API
OTP API
Scheduled Jobs (Cron)
Webhooks

Self-Hosted (5 Minutes)

Run LifyGo on your own infrastructure.

Prerequisites

Install the following:

Docker
Docker Compose
Go 1.22+
Node.js 20+

1. Clone the Repository

git clone https://github.com/lifygo/lifygo.git
cd lifygo

2. Start Infrastructure Services

Launch PostgreSQL and Redis.

docker compose -f infra/docker/docker-compose.yml up -d

3. Configure the API

cd apps/api
cp .env.example .env

Update your .env file:

AUTH_PROVIDER=local
JWT_SECRET=at-least-32-characters
DATABASE_URL=postgres://lifygo:lifygo@localhost:5432/lifygo?sslmode=disable
REDIS_URL=redis://localhost:6379
ENCRYPTION_KEY=$(openssl rand -hex 32)

4. Run Database Migrations

migrate \
  -path migrations \
  -database "postgres://lifygo:lifygo@localhost:5432/lifygo?sslmode=disable" \
  up

5. Start the API

go run ./cmd/server/main.go

The API will be available at:

http://localhost:8080

6. Start the Dashboard

Open another terminal:

cd apps/web
cp .env.local.example .env.local
npm install
npm run dev

The dashboard will be available at:

http://localhost:3000

7. Configure SMTP

Open the dashboard and navigate to: SMTP Settings Enter your SMTP credentials.

SMTP passwords are encrypted using AES-256 before being stored.

8. Send Your First Email

curl -X POST http://localhost:8080/send \
  -H "X-API-Key: lfy_your_key" \
  -H "Content-Type: application/json" \
  -d '{
    "to":"hello@example.com",
    "subject":"Test",
    "body":"It works."
  }'

If the request succeeds, your LifyGo installation is ready.

Next Steps

Continue with the rest of the documentation:

​Quickstart

​Hosted Cloud (2 Minutes)

​1. Create an Account

​2. Generate an API Key

​3. Send Your First Email

​Self-Hosted (5 Minutes)

​Prerequisites

​1. Clone the Repository

​2. Start Infrastructure Services

​3. Configure the API

​4. Run Database Migrations

​5. Start the API

​6. Start the Dashboard

​7. Configure SMTP

​8. Send Your First Email

​Next Steps