2019-11-12 16:09:47 +00:00
|
|
|
# Project Quay
|
|
|
|
|
|
2019-11-12 21:16:47 +00:00
|
|
|
[](https://travis-ci.com/quay/quay)
|
2019-11-12 16:09:47 +00:00
|
|
|
|
|
|
|
|
:warning: The `master` branch may be in an *unstable or even broken state* during development.
|
|
|
|
|
Please use [releases] instead of the `master` branch in order to get stable software.
|
|
|
|
|
|
2019-11-12 21:16:47 +00:00
|
|
|
[releases]: https://github.com/quay/quay/releases
|
2019-11-12 16:09:47 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Project Quay builds, stores, and distributes your container images.
|
|
|
|
|
|
|
|
|
|
High-level features include:
|
|
|
|
|
|
2019-11-13 02:59:00 +00:00
|
|
|
- Docker Registry Protocol [v2]
|
2019-11-12 16:09:47 +00:00
|
|
|
- Docker Manifest Schema [v2.1], [v2.2]
|
|
|
|
|
- [AppC Image Discovery] via on-demand transcoding
|
|
|
|
|
- Image Squashing via on-demand transcoding
|
2019-11-13 02:59:00 +00:00
|
|
|
- Authentication provided by [LDAP], [Keystone], [OIDC], [Google], and [GitHub]
|
2019-11-12 16:09:47 +00:00
|
|
|
- ACLs, team management, and auditability logs
|
2019-11-13 02:59:00 +00:00
|
|
|
- Geo-replicated storage provided by local filesystems, [S3], [GCS], [Swift], and [Ceph]
|
2019-11-12 16:09:47 +00:00
|
|
|
- Continuous Integration integrated with [GitHub], [Bitbucket], [GitLab], and [git]
|
|
|
|
|
- Security Vulnerability Analysis via [Clair]
|
|
|
|
|
- [Swagger]-compliant HTTP API
|
|
|
|
|
|
2019-11-13 02:59:00 +00:00
|
|
|
[v2]: https://docs.docker.com/registry/spec/api/
|
2019-11-12 16:09:47 +00:00
|
|
|
[v2.1]: https://github.com/docker/distribution/blob/master/docs/spec/manifest-v2-1.md
|
|
|
|
|
[v2.2]: https://github.com/docker/distribution/blob/master/docs/spec/manifest-v2-2.md
|
|
|
|
|
[AppC Image Discovery]: https://github.com/appc/spec/blob/master/spec/discovery.md
|
|
|
|
|
[LDAP]: https://en.wikipedia.org/wiki/Lightweight_Directory_Access_Protocol
|
|
|
|
|
[Keystone]: http://docs.openstack.org/developer/keystone
|
|
|
|
|
[OIDC]: https://en.wikipedia.org/wiki/OpenID_Connect
|
|
|
|
|
[Google]: https://developers.google.com/identity/sign-in/web/sign-in
|
|
|
|
|
[GitHub]: https://developer.github.com/v3/oauth
|
|
|
|
|
[S3]: https://aws.amazon.com/s3
|
|
|
|
|
[GCS]: https://cloud.google.com/storage
|
|
|
|
|
[Swift]: http://swift.openstack.org
|
|
|
|
|
[Ceph]: http://docs.ceph.com/docs/master/radosgw/config
|
|
|
|
|
[GitHub]: https://github.com
|
|
|
|
|
[Bitbucket]: https://bitbucket.com
|
|
|
|
|
[GitLab]: https://gitlab.com
|
|
|
|
|
[git]: https://git-scm.com
|
|
|
|
|
[Clair]: https://github.com/quay/clair
|
|
|
|
|
[Swagger]: http://swagger.io
|
|
|
|
|
|
|
|
|
|
## Getting Started
|
|
|
|
|
|
|
|
|
|
* Explore a live instance of Project Quay hosted at [Quay.io]
|
|
|
|
|
* Watch [talks] given about Project Quay
|
|
|
|
|
* Review the [documentation] for Red Hat Quay
|
|
|
|
|
* Get up and running with a containerized [development environment]
|
|
|
|
|
|
|
|
|
|
[Quay.io]: https://quay.io
|
|
|
|
|
[talks]: /docs/talks.md
|
|
|
|
|
[documentation]: https://access.redhat.com/documentation/en-us/red_hat_quay
|
|
|
|
|
[development environment]: /docs/development-container.md
|
|
|
|
|
|
|
|
|
|
## Community
|
|
|
|
|
|
|
|
|
|
* Mailing List: [quay-dev@googlegroups.com]
|
|
|
|
|
* IRC: #quay on [freenode.net]
|
2019-11-12 21:16:00 +00:00
|
|
|
* Bug tracking: [JBoss JIRA]
|
2019-11-12 16:09:47 +00:00
|
|
|
* Security Issues: [security@redhat.com]
|
|
|
|
|
|
|
|
|
|
[quay-dev@googlegroups.com]: https://groups.google.com/forum/#!forum/quay-dev
|
|
|
|
|
[freenode.net]: https://webchat.freenode.net
|
2019-11-12 21:16:00 +00:00
|
|
|
[JBoss JIRA]: https://issues.jboss.org/projects/PROJQUAY
|
2019-11-12 16:09:47 +00:00
|
|
|
[security@redhat.com]: mailto:security@redhat.com
|
|
|
|
|
|
|
|
|
|
## License
|
|
|
|
|
|
|
|
|
|
Project Quay is under the Apache 2.0 license.
|
|
|
|
|
See the LICENSE file for details.
|
