docs/content/reference.md

96 lines
3.0 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

---
title: Reference documentation
description: This section includes the reference documentation for the Docker platforms
various APIs, CLIs, and file formats.
notoc: true
skip_read_time: true
grid_files:
- title: Dockerfile
description: Defines the contents and startup behavior of a single container.
icon: edit_document
link: /engine/reference/builder/
- title: Compose file
description: Defines a multi-container application.
icon: polyline
link: /compose/compose-file/
grid_clis:
- title: Docker CLI
description: The main Docker CLI, includes all `docker` commands.
icon: terminal
link: /engine/reference/commandline/cli/
- title: Compose CLI
description: The CLI for Docker Compose, for building and running multi-container
applications.
icon: subtitles
link: /compose/reference/
- title: Daemon CLI (dockerd)
description: Persistent process that manages containers.
icon: developer_board
link: /engine/reference/commandline/dockerd/
grid_apis:
- title: Engine API
description: The main API for Docker, provides programmatic access to a daemon.
icon: api
link: /engine/api/
- title: Registry API
description: Facilitates distribution of images to the engine.
icon: storage
link: /registry/spec/api/
- title: Docker Hub API
description: API to interact with Docker Hub.
icon: communities
link: /docker-hub/api/latest/
- title: DVP Data API
description: API for Docker Verified Publishers to fetch analytics data.
icon: auto_graph
link: /docker-hub/api/dvp/
grid_specs:
- title: Image specification
description: Describes the various components of a Docker image.
icon: contract
link: /registry/spec/manifest-v2-2/
- title: Registry token authentication
description: Outlines the Docker Registry authentication schemes.
icon: key
link: /registry/spec/auth/
aliases:
- /app/working-with-app/
- /engine/reference/commandline/app/
- /engine/reference/commandline/app_bundle/
- /engine/reference/commandline/app_completion/
- /engine/reference/commandline/app_init/
- /engine/reference/commandline/app_inspect/
- /engine/reference/commandline/app_install/
- /engine/reference/commandline/app_list/
- /engine/reference/commandline/app_merge/
- /engine/reference/commandline/app_pull/
- /engine/reference/commandline/app_push/
- /engine/reference/commandline/app_render/
- /engine/reference/commandline/app_split/
- /engine/reference/commandline/app_status/
- /engine/reference/commandline/app_uninstall/
- /engine/reference/commandline/app_upgrade/
- /engine/reference/commandline/app_validate/
- /engine/reference/commandline/app_validate/
- /engine/reference/commandline/app_version/
---
This section includes the reference documentation for the Docker platform's
various APIs, CLIs, drivers and specifications, and file formats.
## File formats
{{< grid items="grid_files" >}}
## Command-line interfaces (CLIs)
{{< grid items="grid_clis" >}}
## Application programming interfaces (APIs)
{{< grid items="grid_apis" >}}
## Drivers and specifications
{{< grid items="grid_specs" >}}