diff options
| author | Bryan Newbold <bnewbold@robocracy.org> | 2018-11-04 17:22:44 -0800 |
|---|---|---|
| committer | Bryan Newbold <bnewbold@robocracy.org> | 2018-11-07 11:15:04 -0800 |
| commit | 669cb3fe63ee1d506a75cb9aea76bcbd14df31be (patch) | |
| tree | 3c6e8b93d37386bf506c464690e795c9df7b3bb1 /extra/docker/README.md | |
| parent | a257d1e85092ac1912acf942474e42555461f91b (diff) | |
| download | fatcat-669cb3fe63ee1d506a75cb9aea76bcbd14df31be.tar.gz fatcat-669cb3fe63ee1d506a75cb9aea76bcbd14df31be.zip | |
first draft docker-compose file and README
Diffstat (limited to 'extra/docker/README.md')
| -rw-r--r-- | extra/docker/README.md | 21 |
1 files changed, 21 insertions, 0 deletions
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 |