> ## Documentation Index
> Fetch the complete documentation index at: https://docs.boostify.breaddevv.cc/llms.txt
> Use this file to discover all available pages before exploring further.

# Quick Start

> Set up Boostify in minutes.

Get Boostify running using the official cloud instance or self-host it on your own infrastructure.

<CardGroup cols={2}>
  <Card title="Use Cloud Version" icon="cloud" href="#cloud-hosted">
    Start instantly using the official hosted instance.
  </Card>

  <Card title="Self Host" icon="server" href="#self-hosting">
    Deploy Boostify using Node.js or Docker.
  </Card>
</CardGroup>

***

## Cloud Hosted

The fastest way to start using Boostify.

### 1. Invite Boostify

To start using our bot, invite it through this [link](https://discord.com/oauth2/authorize?client_id=1453802179789066442).

### 2. Select Your Server

Choose the Discord server you want to configure.

Boostify requires:

* Add Reactions
* Embed Links
* Manage roles
* Send Messages
* View Server Subscription Insights

<Note>
  Make sure Boostify's role is placed above any reward roles you want it to manage.
</Note>

### 3. Configure Boostify

Once invited, start configuring:

* Booster reward roles
* Thank-you messages
* Logging
* Moderation settings

Continue to the <a href="/configuration">Configuration</a> section for detailed setup.

***

## Self Hosting

Boostify can be fully self-hosted for complete control and customization.

### Requirements

* Node.js 20+
* PostgreSQL database
* Git
* Discord Bot Token

Optional:

* Docker
* PM2

***

## Clone the Repository

```bash theme={null}
git clone https://github.com/teamboostify/boostify.git
cd boostify
```

## Install Dependencies

```bash theme={null}
npm install
```

## Configure Environment Variables

Create a `.env` file in the project root.

```env theme={null}

DEBUG=true

BOT_TOKEN=your_bot_token
CLIENT_ID=
GUILD_ID=
GREET_CHANNEL_ID=
LOG_CHANNEL_ID=
DATABASE_URL=postgresql://user:password@localhost:5432/boostify
```

<Warning>
  Never share your bot token or commit your `.env` file publicly.
</Warning>

***

## Database Setup

Generate the Prisma client:

```bash theme={null}
npx prisma generate
```

Run migrations:

```bash theme={null}
npx prisma migrate deploy
```

***

## Start Boostify

### Development

```bash theme={null}
npm run dev
```

### Production

```bash theme={null}
npm run build
npm start
```

***

## Docker

Boostify also supports Docker deployments.

### Build the Container

```bash theme={null}
docker build -t boostify .
```

### Run the Container

```bash theme={null}
docker run -d \
  --name boostify \
  --env-file .env \
  boostify
```

***

## Recommended Production Setup

For production environments, we recommend:

* Docker
* PM2
* Reverse proxy (Nginx or Caddy)
* Managed PostgreSQL provider
* Linux VPS

***

## Next Steps

<CardGroup cols={2}>
  <Card title="Configuration" icon="gear" href="/configuration">
    Configure roles, logging, and booster settings.
  </Card>

  <Card title="Commands" icon="terminal" href="/commands">
    Learn all available Boostify commands.
  </Card>
</CardGroup>