From 669cb3fe63ee1d506a75cb9aea76bcbd14df31be Mon Sep 17 00:00:00 2001 From: Bryan Newbold Date: Sun, 4 Nov 2018 17:22:44 -0800 Subject: first draft docker-compose file and README --- extra/docker/README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 extra/docker/README.md (limited to 'extra/docker/README.md') diff --git a/extra/docker/README.md b/extra/docker/README.md new file mode 100644 index 00000000..06ff06e1 --- /dev/null +++ b/extra/docker/README.md @@ -0,0 +1,21 @@ + +This docker compose file can be used for local development without needing to +install some large dependencies. Currently it isn't *required* for core +development (the fatcat API server and most of the web interface), and also +doesn't bundle *all* dependencies. + +This requires + +To start docker compose (kafka, zookeeper, elasticsearch) with logging in the +current terminal: + + docker-compose up + +This mode is recommended for most development because the services consume a +lot of RAM and you don't want them sticking around by accident. You can run the +services in the background by adding the `-d` flag. + +TODO: +- postgres +- fatcatd (rust) +- kibana -- cgit v1.2.3