|
# GlitchTip Docker Compose Setup
|
|
|
|
This repository contains a Docker Compose configuration for deploying GlitchTip, an open-source error tracking tool similar to Sentry. The setup includes services for PostgreSQL, Redis, the web application, a worker, and a migration step.
|
|
|
|
## What is this?
|
|
|
|
This `compose.yml` file defines a multi-container Docker environment to run GlitchTip locally or on your server. It simplifies deployment by orchestrating the necessary services and their configurations.
|
|
|
|
## How to use
|
|
|
|
### Prerequisites
|
|
|
|
- Docker and Docker Compose installed on your machine.
|
|
- Basic knowledge of Docker and command-line operations.
|
|
|
|
### Setup steps
|
|
|
|
1. **Clone this repository or save the `compose.yml` file locally.**
|
|
|
|
2. **Create necessary directories:**
|
|
|
|
```bash
|
|
mkdir -p ./postgres-data
|
|
mkdir -p ./uploads
|
|
```
|
|
|
|
Since this setup does not use Docker volumes for persistence, you need to manually create the directories for data storage:
|
|
|
|
3. **Configure environment variables (optional):**
|
|
|
|
Update the `compose.yml` if you want to change default settings such as domain, email, or secret keys.
|
|
|
|
4. **Start the services:**
|
|
|
|
```bash
|
|
docker-compose -f compose.yml up -d
|
|
```
|
|
|
|
This command will pull the necessary images and start all services in detached mode.
|
|
|
|
5. **Access GlitchTip:**
|
|
|
|
Open your browser and navigate to:
|
|
|
|
```
|
|
http://localhost:8000
|
|
```
|
|
|
|
or replace `localhost` with your server's IP or domain if deploying remotely.
|
|
|
|
### Notes
|
|
|
|
- **Directories:** You are responsible for creating and managing the directories used for data persistence (`./postgres-data` and `./uploads`). This approach is intentional to keep things simple and "too cool for Docker volumes."
|
|
- **Configuration:** Adjust environment variables in the compose file as needed for your environment.
|
|
- **Stopping the services:**
|
|
|
|
```bash
|
|
docker-compose -f compose.yml down
|
|
```
|
|
|
|
## Additional Information
|
|
|
|
- The `web` service runs the GlitchTip web application.
|
|
- The `worker` service handles background tasks using Celery.
|
|
- The `migrate` service runs database migrations once during startup.
|
|
- The `postgres` and `redis` services are dependencies for the application. |