vbatts/quay
Archived
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Add docker-compose configuration

Browse source
This commit is contained in:
Brad Ison 2018-01-30 13:44:04 -05:00
parent 5e82538fd5
commit 620cf76c58
4 changed files with 152 additions and 16 deletions
Download patch file Download diff file Expand all files Collapse all files

55
README.md
View file

@ -134,28 +134,51 @@ yarn link typescript
* [pyenv](https://github.com/yyuu/pyenv)
* [pyenv-virtualenv](https://github.com/yyuu/pyenv-virtualenv)
### Docker Compose
You'll need Docker and [Docker Compose](https://docs.docker.com/compose) installed.
If you're on macOS, [Docker for Mac](https://www.docker.com/docker-mac) should include
both tools. Otherwise, follow the docs for your platform.
You'll also need Node.js and NPM if you want to interact with the
frontend code outside a container.
Finally, you'll need a recent [Go](https://golang.org) version for the
builder.
To start Quay locally:
```sh
# Clone the various repos you'll need:
git clone https://github.com/coreos-inc/quay.git
git clone https://github.com/coreos-inc/quay-config-local.git
git clone https://github.com/coreos-inc/quay-builder.git
# Build the builder:
cd quay-builder
make build GOOS=linux
# Install NPM modules:
cd ../quay
npm install
# Build or pull images and start all Quay components:
docker-compose up
```
#### Third Party Docs
* [Docker Compose](https://docs.docker.com/compose)
* [Docker for Mac](https://www.docker.com/docker-mac)
### Linux
Do you use Linux? Send us a PR!
Do you use Linux? Send us a PR! Or use docker-compose!
## Development
### PivotalTracker Integration
### JIRA
Tag a commit with the Tracker Story ID and GitHub automatically comments on your
story with the commit message.
Add the following at the end of your commit message:
```
[(Finishes|Fixes|Delivers) #TRACKER_STORY_ID]
```
When you push to GitHub, the post-receive hook will then call back to Tracker
and put a comment on the story with a link to the commit on GitHub. When tagged
with "Finishes", the trigger will also click Finish on the story.
Reference: PivotalTracker blog - [A Guide to GitHub’s Service Hook for Tracker](https://www.pivotaltracker.com/blog/guide-githubs-service-hook-tracker/)
The Quay backlog can be found in JIRA: https://jira.coreos.com/projects/QUAY
## Running and Testing