Crawlab Documentation

# Quick Start

The quickest way to install Crawlab is Docker. If you are not familiar with Docker, you can refer to Docker Official Site (opens new window) and install it on your local machine.

# Pull Images

Make sure you have installed Docker, and then pull the image of Crawlab and MongoDB.

docker pull crawlabteam/crawlab
docker pull mongo
1
2

If you have not installed Docker Compose (opens new window), you can install it by executing the command below.

pip install docker-compose
1

# Configure docker-compose.yml

Create a config file named docker-compose.yml and enter the content below.

version: '3.3'
services:
  master:
    image: crawlabteam/crawlab
    container_name: crawlab_master
    environment:
      CRAWLAB_NODE_MASTER: Y
      CRAWLAB_MONGO_HOST: mongo
    ports:
      - "8080:8080"
    depends_on:
      - mongo
  mongo:
    image: mongo:4.2
1
2
3
4
5
6
7
8
9
10
11
12
13
14

# Start Crawlab

Start Crawlab along with MongoDB by executing the command below.

docker-compose up -d
1

Now you can open the browser and navigate to http://localhost:8080 to start using Crawlab.

# What Next

WARNING

This is a minimal setup of Crawlab and you can experience most of the features in this demo environment. You should ** NOT** use this demo setup in production environment!

If you would like to deploy Crawlab in production environment, you should refer to Installation for more information.

We also recommend that you follow Basic Tutorial for how to use Crawlab.

← Docker →