Docker Environment for Wikistream 📚🚰

This is a demo environment for Wikistream, a Python package to stream Wikimedia edits (timescale/wikistream).

It includes TimescaleDB, Grafana and Wikistream as three services in a docker-compose.yml file.

Usage

Clone the repository:

git clone https://github.com/timescale/wikistream-docker

Bring up the services with docker-compose:

docker-compose up

Once everything has started you can visit http://localhost:3000 to login to Grafana.

The username and password are both admin.

Connecting to TimescaleDB

If you'd like to connect directly to TimescaleDB use psql:

psql -U postgres -d wikistream

Note that this assumes you aren't running PostgreSQL locally, as the TimescaleDB container will attempt to use localhost with the default port of 5432.

If you have a local instance of PostgreSQL running you'll need to shut it down and try docker-compose up again.

Contributing

If you discover an interesting query in Grafana please consider sharing your dashboard/panel back to the community.

You can export the entire dashboard as a JSON file from Grafana by clicking "Share dashboard":

Then select the "Export" tab and click "Save to file":

Replace the entire contents of grafana/provisioning/dashboards/wikistream.json with your new and improved dashboard and send us a pull request!

Troubleshooting

LOG: could not bind IPv4 socket: Cannot assign requested address

If you see an error about failing to bind to a socket or something similar it's possible you have another instance of PostgreSQL already running. Make sure you've stopped your existing PostgreSQL database and then try docker-compose up again.

If you're having any other issues getting up and running submit an issue or stop by the Timescale Slack and ask around for @avthar or @jonan. We're always happy to help.

🐯 ❤️

License

MIT

Copyright (c) 2020 Jonan Scheffler (LICENSE)