Skip to content
This repository was archived by the owner on Feb 26, 2024. It is now read-only.

Commit 800abe2

Browse files
committed
docs(project-definition): container registry settings
1 parent bd7f400 commit 800abe2

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

Documentation/introduction/project-definition.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,14 @@ domains:
4141
username: user
4242
password: pass
4343
container:
44+
registries:
45+
# Authenticate with Docker Hub for private images
46+
- username: mydockerhubuser
47+
password: mydockerhubpassword
48+
# Authenticate with custom Docker registry
49+
- username: myuser
50+
password: mypassword
51+
url: https://myregistry.com
4452
services:
4553
- name: app # service name
4654
image: nginxdemos/hello:latest # Docker image name
@@ -137,6 +145,22 @@ domains:
137145
Right now, removing a single entry from the list and redeploying the project will NOT remove the user settings from the authentication file.
138146
{% endhint %}
139147

148+
### container.registries
149+
150+
The following configuration options are available inside a registry definition:
151+
152+
#### username
153+
154+
Username for authentication with the container registry. Required.
155+
156+
#### password
157+
158+
Password for authentication with the container registry. Required.
159+
160+
#### url
161+
162+
URL of container registry. If none given, it will try to authenticate with Docker Hub.
163+
140164
### container.services
141165

142166
The following configuration options are available inside a service definition:

0 commit comments

Comments
 (0)