Skip to main content

How to install in Docker

Docker is the easiest way to get started with self-hosted Sparrow. This guide assumes you are running the command from the machine you intend to host from.

Before you begin

info

You need the following installed in your system: Git, Docker and Docker Compose.

Installation​

  1. Clone the Sparrow App repository:

    git clone https://github.com/sparrowapp-dev/sparrow-app

    cd sparrow-app

  2. Configure .env.docker-setup

    You can move ahead with the default values or customize the environment variables in .env.docker-setup according to the Environment Variable Guide.

  3. Once the env file is setup, start all the services using Docker Compose by running the following command:

    yarn docker:up

    Upon successful execution of the above command, the following services will be started inside different docker containers:

    • Sparrow Web Server
    • Sparrow API Server
    • Sparrow Auth Server
    • Sparrow Proxy Server
    • MongoDB
    • Kafka

  4. Access the Sparrow App via the web browser at http://localhost:1422.

Stopping the Services​

In order to stop all the services, run the below command:

yarn docker:down