Public images
- Any image that can be pulled anonymously over HTTPS can be deployed: Docker Hub, GitHub Container Registry, and other registries that implement the standard registry API.
- Write the full reference with registry host, repository, and tag or digest, for example ghcr.io/example/chat:1.4.2 or docker.io/library/nginx:1.27. Without a host, Docker Hub is assumed; without a tag, latest.
- No credentials are needed for public images. Leave deploy_registry_id empty.
Private images on Docker Hub and GitHub
Save an access token once, then reference it from every service that uses a private image of that registry.
python3 acdn-agent.py call /api/user/deploy/registries -- \
--json '{"provider":"github","username":"example","token":"ghp_..."}'
# use the returned id as "deploy_registry_id" of the service
- Docker Hub (provider docker_hub): your Docker Hub username and an access token with read permission, for images on docker.io.
- GitHub Container Registry (provider github): your GitHub username and a personal access token with the read:packages scope, for images on ghcr.io.
- The credentials must match the registry host of the image.
- Private images on other registries are not supported. Push them to your ACDN registry instead.
- Tokens are stored encrypted and are never returned.
Your own ACDN registry
Each account can create one private registry with its own hostname. It accepts docker push and docker pull over HTTPS, so you can deploy an image that exists only on your machine.
python3 acdn-agent.py call /api/user/deploy/registries/personal -- --request POST
# repeat until "status":"ready", then read the login
python3 acdn-agent.py call /api/user/deploy/registries/personal
python3 acdn-agent.py call /api/user/deploy/registries/personal/credentials
printf '%s' 'REGISTRY_PASSWORD' | docker login REGISTRY_HOSTNAME --username owner --password-stdin
docker build --platform linux/amd64 --tag REGISTRY_HOSTNAME/chat:1.4.2 .
docker push REGISTRY_HOSTNAME/chat:1.4.2
- Use REGISTRY_HOSTNAME/chat:1.4.2 as the image of a service and leave deploy_registry_id empty: services of the same account pull from this registry without saved credentials.
- Repository names are lower case and may contain digits, dots, underscores, hyphens, and slashes.
- Pushing large layers is not affected by the 15-second response limit of endpoints, because that limit starts only after an upload has been received.
- The registry login can push, pull, and delete every image. Read it from the credentials operation when you need it instead of storing it.
- Creating the registry adds a Deploy application that runs it and a Storage Zone that holds the images. Both are billed at the normal Deploy and Storage rates.
- Registry status: provisioning (wait), ready, failed (send the create request again), deleting (wait until the registry returns 404), delete_failed (send the delete request again). Credentials and deployments of its images are available only while the status is ready.
- Deleting the registry keeps the Storage Zone and the images in it. A registry created afterwards gets a new hostname and serves the images kept in that Storage Zone, so update the image of every service that used the old hostname.
Exact request and response fields, limits, and error responses are in the Management API reference.