Installation

GlassFlow for ClickHouse Streaming ETL is designed to run locally using Docker and docker-compose. The github repository is shipped with a pre-configured docker-compose file that sets up all necessary components.

Prerequisites

Before you begin, ensure you have the following installed on your system:

• Docker 
• Docker Compose 
• Git 

Quick Installation

1. Clone the repository:

git clone https://github.com/glassflow/clickhouse-etl.git
cd clickhouse-etl

2. Start the services using Docker Compose:

docker-compose up

3. Access the web interface at http://localhost:8080 to configure the pipeline. For detailed instructions on setting up your first pipeline, see the Usage Guide.

For details about the Docker components that are running, see the System Components page.

Stopping the Services

To stop all services:

docker-compose down

To stop services and remove volumes:

docker-compose down -v

Troubleshooting

Common Issues

1. Port Conflicts

   • Ensure ports 8080 and 4222 are not in use by other applications
   • You can modify the ports in docker-compose.yaml if needed

2. Container Startup Issues

   • Check container logs: docker-compose logs [service-name]
   • Ensure all required ports are accessible
   • Verify Docker has enough resources allocated

3. UI Not Accessible

   • Verify all containers are running: docker-compose ps
   • Check Nginx logs: docker-compose logs nginx
   • Ensure you’re accessing the correct URL: http://localhost:8080

Getting Help

If you encounter any issues during installation:

• Join our Slack community 
• Email our support team at help@glassflow.dev
• Open an issue on GitHub 
• Start a discussion on Discussions