mirror of https://github.com/docker/docs.git
Merge branch 'docker:master' into add-container-page
This commit is contained in:
Bruno Sousa
GitHub
commit
c8d2ffde23
|
|
@ -23,13 +23,13 @@ jobs:
|
|||
JEKYLL_ENV=development
|
||||
DOCS_AWS_REGION=us-east-1
|
||||
if [ "${{ github.ref }}" = "refs/heads/master" ]; then
|
||||
DOCS_URL="https://docs-stage2.docker.com" # TODO: change this to https://docs-stage.docker.com when new env switched and ready
|
||||
DOCS_URL="https://docs-stage.docker.com"
|
||||
DOCS_AWS_IAM_ROLE="arn:aws:iam::710015040892:role/stage-docs-docs.docker.com-20220818202135984800000001"
|
||||
DOCS_S3_BUCKET="stage-docs-docs.docker.com"
|
||||
DOCS_S3_CONFIG="s3-config.json"
|
||||
DOCS_CLOUDFRONT_ID="E1R7CSW3F0X4H8"
|
||||
DOCS_LAMBDA_FUNCTION_REDIRECTS="DockerDocsRedirectFunction-stage"
|
||||
DOCS_SLACK_MSG="Successfully deployed docs-stage2 from master branch. $DOCS_URL" # TODO: change to "deployed docs-stage" when new env switched and ready
|
||||
DOCS_SLACK_MSG="Successfully deployed docs-stage from master branch. $DOCS_URL"
|
||||
elif [ "${{ github.ref }}" = "refs/heads/published" ]; then
|
||||
#JEKYLL_ENV=production # TODO: uncomment when new env switched and ready
|
||||
DOCS_URL="https://docs2.docker.com" # TODO: change this to https://docs.docker.com when new env switched and ready
|
||||
|
|
|
|||
|
|
@ -4,7 +4,6 @@ on:
|
|||
workflow_dispatch:
|
||||
push:
|
||||
branches:
|
||||
- master
|
||||
- published
|
||||
|
||||
jobs:
|
||||
|
|
@ -16,13 +15,7 @@ jobs:
|
|||
run: |
|
||||
JEKYLL_ENV=development
|
||||
DOCS_AWS_REGION=us-east-1
|
||||
if [ "${{ github.ref }}" = "refs/heads/master" ]; then
|
||||
DOCS_URL="https://docs-stage.docker.com"
|
||||
DOCS_S3_BUCKET="docs.docker.com-stage-us-east-1"
|
||||
DOCS_S3_CONFIG="_website-config-docs-stage.json"
|
||||
DOCS_LAMBDA_FUNCTION_CACHE="arn:aws:lambda:us-east-1:710015040892:function:docs-stage-cache-invalidator"
|
||||
DOCS_SLACK_MSG="Successfully promoted docs-stage from master. https://docs-stage.docker.com/"
|
||||
elif [ "${{ github.ref }}" = "refs/heads/published" ]; then
|
||||
if [ "${{ github.ref }}" = "refs/heads/published" ]; then
|
||||
JEKYLL_ENV=production
|
||||
DOCS_URL="https://docs.docker.com"
|
||||
DOCS_S3_BUCKET="docs.docker.com-us-east-1"
|
||||
|
|
|
|||
|
|
@ -10,7 +10,7 @@
|
|||
</h5>
|
||||
</div>
|
||||
<div class="col-xs-12 col-md-6 col-lg-4 text-center">
|
||||
<a class="btn" href="/desktop/dashboard/#explore-volumes" target="_blank" rel="noopener">
|
||||
<a class="btn" href="/desktop/use-desktop/volumes/" target="_blank" rel="noopener">
|
||||
Learn more
|
||||
</a>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
>
|
||||
> This page contains information about hosting your own registry using the
|
||||
> open source Docker Registry. For information about Docker Hub, which offers a
|
||||
> [open source Docker Registry](https://github.com/distribution/distribution){: target="_blank" rel="noopener" class="_"}. For information about Docker Hub, which offers a
|
||||
> hosted registry with additional features such as teams, organizations, web
|
||||
> hooks, automated builds, etc, see [Docker Hub](/docker-hub/).
|
||||
{: .important }
|
||||
|
|
|
|||
|
|
@ -16,7 +16,7 @@
|
|||
<link rel="canonical" href="{{ site.docs_url }}/docker-hub/api/latest/" />
|
||||
</head>
|
||||
<body>
|
||||
<redoc spec-url="/docker-hub/api/{{ page.name | replace: '.md'}}.yaml" hide-hostname="false" suppress-warnings="false" class="hub-api"></redoc>
|
||||
<redoc spec-url="/docker-hub/api/{{ page.name | replace: '.md'}}.yaml" class="hub-api"></redoc>
|
||||
<script src="/js/redoc.standalone.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
|
|
|
|||
|
|
@ -233,7 +233,7 @@
|
|||
<h6>Popular articles</h6>
|
||||
<p class="only-win"><a href="/desktop/windows/wsl/">Docker Desktop WSL 2 backend</a></p>
|
||||
<p class="only-mac"><a href="/desktop/install/mac-install/">Install Docker Desktop on Mac</a></p>
|
||||
<p><a href="/desktop/dashboard/">Docker Desktop Dashboard</a></p>
|
||||
<p><a href="/desktop/#overview-of-docker-dashboard">Docker Desktop Dashboard</a></p>
|
||||
<p class="only-win"><a href="/desktop/kubernetes/">Deploy on Kubernetes</a></p>
|
||||
<p class="only-win"><a href="/desktop/windows/release-notes/">Release notes</a></p>
|
||||
<p class="only-win"><a href="/desktop/windows/troubleshoot/">Logs and troubleshooting</a></p>
|
||||
|
|
|
|||
|
|
@ -33,14 +33,10 @@ You can set default values for any environment variables referenced in the
|
|||
Compose file, or used to configure Compose, in an [environment file](env-file.md)
|
||||
named `.env`. The `.env` file path is as follows:
|
||||
|
||||
- Starting with `+v1.28`, `.env` file is placed at the base of the project directory
|
||||
- Starting from `v1.28`, the `.env` file is placed at the base of the project directory.
|
||||
- Project directory can be explicitly defined with the `--file` option or `COMPOSE_FILE`
|
||||
environment variable. Otherwise, it is the current working directory where the
|
||||
`docker compose` command is executed (`+1.28`).
|
||||
- For previous versions, it might have trouble resolving `.env` file with
|
||||
`--file` or `COMPOSE_FILE`. To work around it, it is recommended to use `--project-directory`,
|
||||
which overrides the path for the `.env` file. This inconsistency is addressed
|
||||
in `+v1.28` by limiting the filepath to the project directory.
|
||||
environment variable. Otherwise, it is the current working directory where the `docker compose` command is executed (`+1.28`).
|
||||
- For versions older than `v1.28`, it might have trouble resolving `.env` file with `--file` or `COMPOSE_FILE`. To work around it, it is recommended to use `--project-directory`, which overrides the path for the `.env` file. This inconsistency is addressed in `v1.28` by limiting the file path to the project directory.
|
||||
|
||||
|
||||
```console
|
||||
|
|
@ -233,7 +229,7 @@ $ docker compose exec api node
|
|||
```
|
||||
|
||||
Having any `ARG` or `ENV` setting in a `Dockerfile` evaluates only if there is
|
||||
no Docker Compose entry for `environment` or `env_file`.
|
||||
no Docker Compose entry for `environment`, `env_file` or `run --env`.
|
||||
|
||||
> Specifics for NodeJS containers
|
||||
>
|
||||
|
|
|
|||
|
|
@ -5,15 +5,15 @@ keywords: compose, environment, env file
|
|||
---
|
||||
|
||||
## Order of precedence
|
||||
1. Passed from the command-line [`docker compose run --env <KEY[=VAL]>`](../../engine/reference/commandline/compose_run/#options).
|
||||
2. Passed from/set in `compose.yaml` service's configuration, [from the environment key](../../compose/compose-file/#environment).
|
||||
3. Passed from/set in `compose.yaml` service's configuration, [from the env_file key](../../compose/compose-file/#env_file).
|
||||
4. Passed from/set in Container Image [in ENV directive](../../engine/reference/builder/#env).
|
||||
1. Passed from the command-line [`docker compose run --env <KEY[=[VAL]]>`](../../engine/reference/commandline/compose_run/#options).
|
||||
2. Passed from/set in `compose.yaml` service's configuration, from the [environment key](../../compose/compose-file/#environment).
|
||||
3. Passed from/set in `compose.yaml` service's configuration, from the [env_file key](../../compose/compose-file/#env_file).
|
||||
4. Passed from/set in Container Image in the [ENV directive](../../engine/reference/builder/#env).
|
||||
|
||||
### Precedence quick overview table
|
||||
The table below provides a quick overview of how interpolation works when using all environment variables on Compose, using `TAG`, an environmental variable defining the version for an image, as an example.
|
||||
|
||||
Each row represents a scenario and each columns represents a context where you can be setting or passing an environment variable.
|
||||
Each row represents a scenario and each column represents a context where you can be setting or passing an environment variable.
|
||||
|
||||
| # | `.env` file | `compose.yaml`:`env_file` key | `compose.yaml`:`environment` key | CMD | Image | OS | Resolved as |
|
||||
|:-:|:--------------------------:|:-----------------------------:|:---------------------------------:|:------------:|:-------------:|:------------:|:-----------------:|
|
||||
|
|
@ -35,8 +35,12 @@ Each row represents a scenario and each columns represents a context where you c
|
|||
| 16| Unset | Unset | `TAG=1.7` | Unset | `TAG=1.6` | `TAG=1.4` | `TAG=1.4` |
|
||||
|
||||
Description for each column:
|
||||
* `.env` file - `.env` file on the project root (or, with higher precedence, the file passed via `docker compose -–env-file <FILE>`).
|
||||
* `OS` environment - OS Environment variable
|
||||
* Image - `ENV` directive in the Dockerfile
|
||||
* .env file - `.env` file on the project root (or, with higher precedence, the file passed via `docker compose -–env-file <FILE>`).
|
||||
* Command line - environmental variable passed via `docker compose run -e <KEY[=VAL]>`.
|
||||
* Compose file - in `environment` key from the service section in the `compose.yaml`.
|
||||
* Compose file - in `env_file key` from the service section in the `compose.yaml`.
|
||||
* Compose file - In `env_file` key from the service section in the `compose.yaml`.
|
||||
* Compose file - In `environment` key from the service section in the `compose.yaml`.
|
||||
* Command line - Environmental variable passed via `docker compose run -e <KEY[=[VAL]]>`.
|
||||
* Resolved as - This column expresses the result available in the container.
|
||||
|
||||
**Note that the "`OS`" has precedence over "`.env` file" column for variable resolution in the other columns.**
|
||||
|
|
@ -25,7 +25,7 @@ Although you can start from an empty directory, it is highly recommended that yo
|
|||
└── client # (3)
|
||||
│ └── src
|
||||
│ ├── App.tsx
|
||||
│ └── ... React aplication
|
||||
│ └── ... React application
|
||||
```
|
||||
|
||||
1. Contains everything required to build the extension and run it in Docker Desktop.
|
||||
|
|
|
|||
|
|
@ -3,10 +3,12 @@ description: Docker Desktop overview
|
|||
keywords: Desktop, Docker, GUI, run, docker, local, machine, dashboard
|
||||
title: Docker Desktop
|
||||
redirect_from:
|
||||
- /desktop/opensource/
|
||||
- /docker-for-mac/opensource/
|
||||
- /docker-for-windows/opensource/
|
||||
- /desktop/dashboard/
|
||||
- /desktop/opensource/
|
||||
- /docker-for-mac/dashboard/
|
||||
- /docker-for-mac/opensource/
|
||||
- /docker-for-windows/dashboard/
|
||||
- /docker-for-windows/opensource/
|
||||
---
|
||||
|
||||
> **Update to the Docker Desktop terms**
|
||||
|
|
|
|||
|
|
@ -21,9 +21,9 @@ If you want to continue using the Docker Hub API in your current applications, u
|
|||
|
||||
| **OLD** | **NEW** |
|
||||
| -------------- | ------------ |
|
||||
| [/v1/repositories/{name}/images](https://github.com/moby/moby/blob/v1.3.0/docs/sources/reference/api/docker-io_api.md#list-user-repository-images)| [/v2/namespaces/{namespace}/repositories/{repository}/images](https://docs.docker.com/docker-hub/api/latest/#tag/images/operation/GetNamespacesRepositoriesImages)|
|
||||
| [/v1/repositories/{namespace}/{name}/images](https://github.com/moby/moby/blob/v1.3.0/docs/sources/reference/api/docker-io_api.md#list-user-repository-images)| [/v2/namespaces/{namespace}/repositories/{repository}/images](https://docs.docker.com/docker-hub/api/latest/#tag/images/operation/GetNamespacesRepositoriesImages)|
|
||||
| [/v1/repositories/{name}/tags](https://github.com/moby/moby/blob/v1.8.3/docs/reference/api/registry_api.md#list-repository-tags)| [/v2/namespace/{namespace}/repositories/{repository}/tags](/docker-hub/api/latest/#tag/repositories/paths/~1v2~1namespace~1%7Bnamespace%7D~1repositories~1%7Brepository%7D~1tags/get) |
|
||||
| [/v1/repositories/{namespace}/{name}/tags](https://github.com/moby/moby/blob/v1.8.3/docs/reference/api/registry_api.md#list-repository-tags)| [/v2/namespace/{namespace}/repositories/{repository}/tags](/docker-hub/api/latest/#tag/repositories/paths/~1v2~1namespace~1%7Bnamespace%7D~1repositories~1%7Brepository%7D~1tags/get)|
|
||||
| [/v1/repositories/{name}/images](https://github.com/moby/moby/blob/v1.3.0/docs/sources/reference/api/docker-io_api.md#list-user-repository-images)| [/v2/namespaces/{namespace}/repositories/{repository}/images](https://docs.docker.com/docker-hub/api/latest/#tag/images/operation/GetNamespacesRepositoriesImages)|
|
||||
| [/v1/repositories/{namespace}/{name}/images](https://github.com/moby/moby/blob/v1.3.0/docs/sources/reference/api/docker-io_api.md#list-user-repository-images)| [/v2/namespaces/{namespace}/repositories/{repository}/images](https://docs.docker.com/docker-hub/api/latest/#tag/images/operation/GetNamespacesRepositoriesImages)|
|
||||
| [/v1/repositories/{name}/tags](https://github.com/moby/moby/blob/v1.8.3/docs/reference/api/registry_api.md#list-repository-tags)| [/v2/namespaces/{namespace}/repositories/{repository}/tags](/docker-hub/api/latest/#tag/repositories/paths/~1v2~1namespace~1%7Bnamespace%7D~1repositories~1%7Brepository%7D~1tags/get)|
|
||||
| [/v1/repositories/{namespace}/{name}/tags](https://github.com/moby/moby/blob/v1.8.3/docs/reference/api/registry_api.md#list-repository-tags)| [/v2/namespaces/{namespace}/repositories/{repository}/tags](/docker-hub/api/latest/#tag/repositories/paths/~1v2~1namespace~1%7Bnamespace%7D~1repositories~1%7Brepository%7D~1tags/get)|
|
||||
| [/v1/repositories/{namespace}/{name}/tags](https://github.com/moby/moby/blob/v1.8.3/docs/reference/api/registry_api.md#get-image-id-for-a-particular-tag)| [/v2/namespaces/{namespace}/repositories/{repository}/tags/{tag}](/docker-hub/api/latest/#tag/repositories/paths/~1v2~1namespaces~1%7Bnamespace%7D~1repositories~1%7Brepository%7D~1tags~1%7Btag%7D/get)|
|
||||
| [/v1/repositories/{namespace}/{name}/tags/{tag_name}](https://github.com/moby/moby/blob/v1.8.3/docs/reference/api/registry_api.md#get-image-id-for-a-particular-tag)| [/v2/namespaces/{namespace}/repositories/{repository}/tags/{tag}](/docker-hub/api/latest/#tag/repositories/paths/~1v2~1namespaces~1%7Bnamespace%7D~1repositories~1%7Brepository%7D~1tags~1%7Btag%7D/get)|
|
||||
|
|
|
|||
|
|
@ -16,6 +16,7 @@ info:
|
|||
Docker provides an API that allows you to interact with Docker Hub.
|
||||
|
||||
Browse through the Docker Hub API documentation to explore the supported endpoints.
|
||||
|
||||
tags:
|
||||
- name: resources
|
||||
x-displayName: Resources
|
||||
|
|
@ -1275,7 +1276,7 @@ components:
|
|||
type: array
|
||||
items:
|
||||
type: string
|
||||
example: [ urn:ietf:params:scim:api:messages:2.0:ListResponse ]
|
||||
example: [ "urn:ietf:params:scim:api:messages:2.0:ListResponse" ]
|
||||
totalResults:
|
||||
type: integer
|
||||
example: 1
|
||||
|
|
@ -1302,7 +1303,7 @@ components:
|
|||
type: array
|
||||
items:
|
||||
type: string
|
||||
example: [ urn:ietf:params:scim:api:messages:2.0:ListResponse ]
|
||||
example: [ "urn:ietf:params:scim:api:messages:2.0:ListResponse" ]
|
||||
totalResults:
|
||||
type: integer
|
||||
example: 1
|
||||
|
|
@ -2300,7 +2301,7 @@ components:
|
|||
type: array
|
||||
items:
|
||||
type: string
|
||||
example: [ urn:ietf:params:scim:schemas:core:2.0:Schema ]
|
||||
example: [ "urn:ietf:params:scim:schemas:core:2.0:Schema" ]
|
||||
id:
|
||||
type: string
|
||||
example: urn:ietf:params:scim:schemas:core:2.0:User
|
||||
|
|
|
|||
|
|
@ -13,6 +13,8 @@ title: Docker Registry
|
|||
The Registry is a stateless, highly scalable server side application that stores
|
||||
and lets you distribute Docker images. The Registry is open-source, under the
|
||||
permissive [Apache license](https://en.wikipedia.org/wiki/Apache_License).
|
||||
You can find the source code on
|
||||
[GitHub](https://github.com/distribution/distribution){: target="blank" rel="noopener" class=""}.
|
||||
|
||||
## Why use it
|
||||
|
||||
|
|
|
|||
|
|
@ -23,7 +23,7 @@ Docker has two options for containers to store files on the host machine, so
|
|||
that the files are persisted even after the container stops: _volumes_, and
|
||||
_bind mounts_.
|
||||
|
||||
Docker also supports containers storing files in-memory on the the host machine. Such files are not persisted.
|
||||
Docker also supports containers storing files in-memory on the host machine. Such files are not persisted.
|
||||
If you're running Docker on Linux, _tmpfs mount_ is used to store files in the host's system memory.
|
||||
If you're running Docker on Windows, _named pipe_ is used to store files in the host's system memory.
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue