# Installation

**Package:** Laravel Compose | **Version:** 1 | **URL:** https://mozex.dev/docs/laravel-compose/v1/installation

---

Install the package with Composer:

```bash
composer require mozex/laravel-compose
```

The service provider registers itself through package discovery. Publish the config file when you want to change a default:

```bash
php artisan vendor:publish --tag=laravel-compose-config
```

That writes `config/compose.php`. The [Configuration](https://mozex.dev/docs/laravel-compose/v1/configuration) page explains every key.

## What the server needs

- Docker Engine with the Compose plugin, version 2.17 or newer, so `docker compose version` works. Ploi's Docker server type and Forge's Docker install both provide it; on a plain Ubuntu box, follow Docker's own install guide and add `docker-compose-plugin`.
- The user that runs your deploy in the `docker` group. Without it, every command fails with `permission denied` on the daemon socket.

Run the doctor after installing to confirm both:

```bash
php artisan compose:doctor
```

## Hosts without Docker

Nothing here requires Docker to be present. A stack whose `enabled()` returns false is skipped, and `COMPOSE_ENABLED=false` skips every stack on a host. CI, local machines that use a natively installed service instead, and staging boxes without Docker all run the same deploy script unchanged.

## Next step

Scaffold your first stack with `php artisan compose:make {name}` and read [Defining a Stack](https://mozex.dev/docs/laravel-compose/v1/stacks/defining-a-stack).

---

## Table of Contents

- [Introduction](https://mozex.dev/docs/laravel-compose/v1)
- [AI Integration](https://mozex.dev/docs/laravel-compose/v1/ai-integration)
- [Support Us](https://mozex.dev/docs/laravel-compose/v1/support-us)
- [Requirements](https://mozex.dev/docs/laravel-compose/v1/requirements)
- [Changelog](https://mozex.dev/docs/laravel-compose/v1/changelog)
- [Contributing](https://mozex.dev/docs/laravel-compose/v1/contributing)
- [Questions & Issues](https://mozex.dev/docs/laravel-compose/v1/questions-and-issues)
- [About Mozex](https://mozex.dev/docs/laravel-compose/v1/about)
- [Installation](https://mozex.dev/docs/laravel-compose/v1/installation)
- [Configuration](https://mozex.dev/docs/laravel-compose/v1/configuration)

### Stacks

- [Defining a Stack](https://mozex.dev/docs/laravel-compose/v1/stacks/defining-a-stack)
- [Discovery](https://mozex.dev/docs/laravel-compose/v1/stacks/discovery)
- [Environment Files](https://mozex.dev/docs/laravel-compose/v1/stacks/environment-files)
- [Compose Files](https://mozex.dev/docs/laravel-compose/v1/stacks/compose-files)

### Deploying

- [Redeploy](https://mozex.dev/docs/laravel-compose/v1/deploying/redeploy)
- [Hosting Platforms](https://mozex.dev/docs/laravel-compose/v1/deploying/hosting-platforms)
- [Remote Daemons](https://mozex.dev/docs/laravel-compose/v1/deploying/remote-daemons)
- [Doctor](https://mozex.dev/docs/laravel-compose/v1/deploying/doctor)

### Operating

- [Status, Logs, and Down](https://mozex.dev/docs/laravel-compose/v1/operating/status-logs-down)
- [Health Check](https://mozex.dev/docs/laravel-compose/v1/operating/health-check)
- [Events](https://mozex.dev/docs/laravel-compose/v1/operating/events)
- [Testing](https://mozex.dev/docs/laravel-compose/v1/operating/testing)

### Recipes

- [Meilisearch](https://mozex.dev/docs/laravel-compose/v1/recipes/meilisearch)
- [Telegram Bot API](https://mozex.dev/docs/laravel-compose/v1/recipes/telegram-bot-api)