Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Quick install instructions are insufficient #688

Closed
jc-harrison opened this issue Apr 30, 2019 · 4 comments · Fixed by #693 or #694
Closed

Quick install instructions are insufficient #688

jc-harrison opened this issue Apr 30, 2019 · 4 comments · Fixed by #693 or #694
Labels
docs Documentation issues

Comments

@jc-harrison
Copy link
Member

As of #610, docker-compose.yml requires development_environment to be sourced (or the environment variables otherwise set) before running docker-compose up. The quick install instructions have not been updated to reflect this.

Rather than instructing a user to download and source development_environment before docker-composing, it would seem preferable to provide either a bash script which would set the env vars, download the compose file and spin everything up, or a demo docker-compose file in which the env vars are already set (this links in with #614).

While we're on the subject, we should also review the dev and production install instructions, to ensure they are correct and sufficient.

@jc-harrison jc-harrison added the docs Documentation issues label Apr 30, 2019
@greenape
Copy link
Member

If it weren't for the build sections in the compose file, one could simply do this:

#!/usr/bin/env bash

set -a
source /dev/stdin <<< "$(curl -s https://raw.githubusercontent.com/Flowminder/FlowKit/master/development_environment)"
export DOCKER_FLOWDB_HOST=flowdb_testdata
set +a
curl -s https://raw.githubusercontent.com/Flowminder/FlowKit/master/docker-compose.yml | docker-compose -f - up flowdb_testdata flowapi flowmachine flowauth query_locker

And get people to curl-exec that.

@maxalbert
Copy link
Contributor

Should also review the instructions about Setting up a development environment - possible that the changes in #610 have affected those too.

This was referenced May 1, 2019
@greenape
Copy link
Member

greenape commented May 8, 2019

Given #693 and #694, we happy to close this after #713 is merged?

@maxalbert
Copy link
Contributor

I'm happy to close this. There is further cleanup / rewriting to be done, but this should be tracked in separate issues.

@greenape greenape closed this as completed May 9, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation issues
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants