diff --git a/endpoints/api/suconfig.py b/endpoints/api/suconfig.py index 337d5b6aa..4bd6ca8b2 100644 --- a/endpoints/api/suconfig.py +++ b/endpoints/api/suconfig.py @@ -67,11 +67,15 @@ class SuperUserGetConfig(ApiResource): 'type': 'object', 'description': 'Updates the YAML config file', 'required': [ - 'config' + 'config', + 'hostname' ], 'properties': { 'config': { 'type': 'object' + }, + 'hostname': { + 'type': 'string' } }, }, @@ -102,9 +106,10 @@ class SuperUserGetConfig(ApiResource): # so we also allow it to be called if there is no valid registry configuration setup. if not os.path.exists(OVERRIDE_CONFIG_YAML_FILENAME) or SuperUserPermission().can(): config_object = request.get_json()['config'] + hostname = request.get_json()['hostname'] # Add any enterprise defaults missing from the config. - add_enterprise_config_defaults(config_object, app.config['SECRET_KEY']) + add_enterprise_config_defaults(config_object, app.config['SECRET_KEY'], hostname) # Write the configuration changes to the YAML file. export_yaml(config_object, OVERRIDE_CONFIG_YAML_FILENAME) diff --git a/static/directives/config/config-setup-tool.html b/static/directives/config/config-setup-tool.html index ffd51bf3d..874322ab9 100644 --- a/static/directives/config/config-setup-tool.html +++ b/static/directives/config/config-setup-tool.html @@ -1,654 +1,656 @@
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 hostname: | -
-
-
- The HTTP host (and optionally the port number if a non-standard HTTP/HTTPS port) 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.
-
-
-
|
-
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 images can be stored either locally or in a remote storage system. - A remote storage system is required for high-avaliability systems. -
- +Storage Engine: | +Enterprise Logo URL: |
-
+
+
+ This is optional. If not specified, the default logo will be used.
+
+ |
+
+ |
||||||||
Storage Path: | -- - | -Contact Information: | +
+
+
+ Information to show in the Contact Page. If none specified, CoreOS contact information
+ is displayed.
+
-
- | ||||||||
Access Key: | -
-
+
+
|
||||||||||
Secret Key: | -- - | -||||||||||
Bucket Name: | -- - | -||||||||||
Access Key: | -- - | -||||||||||
Secret Key: | -- - | -||||||||||
Bucket Name: | -- - | -||||||||||
Hostname: | -- - | -||||||||||
Is Secure: | +|||||||||||
User Creation: |
-
-
+
+
- |
- ||||||||||
Access Key: | -
-
- See
- RADOS Documentation
- for more information
+ If enabled, users can be created from the registry UI.
|
||||||||||
Secret Key: | -- + | ||||||||||
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.
+
|
||||||||||
Bucket Name: | +
Server hostname: |
-
+
+
+ The HTTP host (and optionally the port number if a non-standard HTTP/HTTPS port) 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.
+
+
+
|
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 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: | ++ + | +
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 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: | ++ |
+ 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: | ++ + + | +
+ 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: | ++ + + | +
+ 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: | ++ + + | +
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 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: | -- |
- 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: | -- - - | -
- 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: | -- - - | -
- 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: | -- - - | -