Enterprise Registry Management
@@ -27,7 +27,7 @@
- setup
+
+
+
+
+
+ Basic Configuration
+
+
+
+
+
+ | Secret Key: | +
+
+
+ This should be a UUID or some other secret string
+
+ |
+ + + | +||||||||||
| Enterprise Logo URL: | +
+
+
+ This is optional. If not specified, the default logo will be used.
+
+ |
+
+ |
+ ||||||||||
| Contact Information: | +
+
+
+ Information to show in the Contact Page. If none specified, CoreOS contact information
+ is displayed.
+
+
+
+
+
|
+ |||||||||||
| User Creation: | +
+
+
+ If enabled, users can be created from the registry UI.
+
+ |
+ |||||||||||
| Build Support: | +
+
+
+ If enabled, users can submit Dockerfiles to be built and pushed by the Enterprise Registry.
+
+
+
+ Note: Build workers are required for this feature.
+ See Adding Build Workers for instructions on how to setup build workers.
+
+ |
+ |||||||||||
+
+
+
+
+
+ Server Configuration
+
+
+
+
+
+
+ | Server hostname: | +
+
+
+ The HTTP host (and optionally the port number) of the location
+ where the registry will be accessible on the network
+
+ |
+
| SSL: | +
+
+
+ A valid SSL certificate and private key files are required to use this option.
+
+ |
+
| SSL certificate: | +
+
+
+ The certificate must be in PEM format.
+
+ |
| SSL key: | ++ + | +
+
+
+
+
+ Database
+
+
+
+
+
+
+
+
+
+ A MySQL RDBMS or Postgres installation with an empty database is required. The schema will be created the first time the registry image is run with valid configuration.
+
+
+
+
+
+ | Database Type: | ++ + | +
| Database Server: | ++ + | +
| Database Name: | ++ + | +
| Username: | +
+
+ The user must have full access to the database
+ |
+
| Password: | ++ + | +
+
+
+
+
+ 
redis
+
+ redis
+
+
+
+
+
+
+
+
+ A redis key-value store is required for real-time events and build logs.
+| Redis hostname: | ++ + | +
| Redis port: | +
+
+
+ Access to this port and hostname must be allowed from all hosts running
+ the enterprise registry
+
+ |
+
| Redis password: | ++ + | +
+
+
+
+
+ Registry Storage
+
+
+
+
+
+
+
+
+
+
+ + Registry images can be stored either locally or in a remote storage system. + A remote storage system is required for high-avaliability systems. +
+ +| Storage Engine: | ++ + | +
| Storage Path: | ++ + | +
| Access Key: | ++ + | +
| Secret Key: | ++ + | +
| Bucket Name: | ++ + | +
| Access Key: | ++ + | +
| Secret Key: | ++ + | +
| Bucket Name: | ++ + | +
| Hostname: | ++ + | +
| Is Secure: | ++ + | +
| Access Key: | +
+
+
+ See
+ RADOS Documentation
+ for more information
+
+ |
+
| Secret Key: | ++ + | +
| Bucket Name: | ++ + | +
+
+
+
+
+ E-mail
+
+
+
+
+
+
+
+
+
+
+
+ Valid e-mail server configuration is required for notification e-mails and the ability of + users to reset their passwords.
+| SMTP Server: | ++ + | +||||
| SMTP Server Port: | ++ + | +||||
| TLS: | ++ + | +||||
| Mail Sender: | +
+
+
+ E-mail address from which all e-mails are sent. If not specified,
+
+ support@quay.io will be used.
+ |
+ ||||
| Authentication: | +
+
+
+
|
+
+
+
+
+
+ Authentication
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ + Authentication for the registry can be handled by either the registry itself or LDAP. + External authentication providers (such as Github) can be used on top of this choice. +
+| Authentication: | ++ + | +
| LDAP URI: | ++ |
| Administrator DN: | ++ |
| Base DN: | ++ |
| Administrator Password: | ++ |
| E-mail Attribute: | ++ |
| UID Attribute: | ++ |
| User RDN: | ++ |
+
+
+
+
+ Github (Enterprise) Authentication
+
+
+
+
+
+
+
+
+
+
+
+
+
+ + If enabled, users can use Github or Github Enterprise to authenticate to the registry. +
++ Note: A registered Github (Enterprise) OAuth application is required. + View instructions on how to + + Create an OAuth Application in GitHub + +
+| Github Endpoint: | +
+
+
+
+ https://github.com/ for github.com. For Github enterprise, the internal Github endpoint.
+
+ |
+
| API Endpoint: | +
+
+
+
+ https://api.github.com/ for github.com. For Github Enterprise, leave empty.
+
+ |
+
| OAuth Client ID: | ++ + + | +
| OAuth Client Secret: | ++ + + | +
+
+
+
+
+
+ Google Authentication
+
+
+
+
+
+
+
+
+
+
+
+
+
+ + If enabled, users can use Google to authenticate to the registry. +
++ Note: A registered Google OAuth application is required. + Visit the + + Google Developer Console + + to register an application. +
+| OAuth Client ID: | ++ + + | +
| OAuth Client Secret: | ++ + + | +
+
+
+
+ Github (Enterprise) Build Triggers
+
+
+
+
+
+
+
+
+
+
+
+
+
+ + If enabled, users can setup Github or Github Enterprise triggers to invoke Registry builds. +
++ Note: A registered Github (Enterprise) OAuth application (separate from Github Authentication) is required. + View instructions on how to + + Create an OAuth Application in GitHub + +
+| Github Endpoint: | +
+
+
+
+ https://github.com/ for github.com. For Github enterprise, the internal Github endpoint.
+
+ |
+
| API Endpoint: | +
+
+
+
+ https://api.github.com/ for github.com. For Github Enterprise, leave empty.
+
+ |
+
| OAuth Client ID: | ++ + + | +
| OAuth Client Secret: | ++ + + | +