In this quick start guide, we’ll use docker-compose to create our demo infrastructure.

To get started quickly, you should clone the deploy repository and leverage the configuration under the docker directory. You can pick any storage solution you’d like, but this guide follows the configuration in sqlite.

1 - Launch

To launch the demo infrastructure, simply run the following:

$ docker-compose up -d
Creating docker_extractor_1 ... done
Creating docker_tracker_1 ... done
Creating docker_indexer_1     ... done
Creating docker_gateway_1 ... done

That’s it!

The demo infrastructure is up and running. You can test it out by opening any of the following endpoints (browser or curl).

2 - Configure Your Provider

Once the demo infrastructure is up and running, you can easily modify the rds.yaml file to include more accounts to index. For more information on how to configure each integration, see the integrations section. For now, let’s simply add your GitHub ID to the existing block.

- github:
    strategy: HTTP
    - { .GitHubLogin }
    - depscloud

The configuration will not be automatically reloaded. Any process consuming the configuration will need to be restarted.

3 - Rerun Indexer

The indexer process is typically run as a cronjob. Because of this, it will typically pick up the configuration on it’s next run. When running locally, we can restart the process to pick up the new configuration. You may need to re-create the container.

$ docker-compose restart indexer
Restarting docker_indexer_1 ... done

Last modified October 26, 2020: darken up lines (141fe72)