* Move example of symbolic link closer to related text
This is to co-locate the text explaining why a symbolic link might be required with the example of the symbolic link creation. This will make it more clear that the symbolic link example is related to the note immediately above.
* Insert line break prior to example
* Fix indentation of quote block
It now matches the indentation of the instructions code blocks and other quote blocks.
* Update ipv6 instructions for 3.x Compose files
IPv6 instructions on https://github.com/docker/compose/issues/4958, are compatible with Docker Compose 3.x
* Update code block to use yaml syntax
With @usha-mandya
Co-authored-by: Usha Mandya <47779042+usha-mandya@users.noreply.github.com>
* Update text about using IPv6
By @usha-mandya
Co-authored-by: Usha Mandya <47779042+usha-mandya@users.noreply.github.com>
Co-authored-by: Usha Mandya <47779042+usha-mandya@users.noreply.github.com>
This page has a large number of downvotes and I think it's because the confusion of docker-compose --build and docker-compose build --arg. It definitely confused me and made it appear that the instructions contained did not work.
* Make Compose-Switch version dynamic
Fixes https://github.com/docker/docker.github.io/issues/13914
* Update cli-command.md
Fix typo by remove unneeded parenthesis.
* Updating to the latest version
Co-authored-by: Usha Mandya <47779042+usha-mandya@users.noreply.github.com>
* Indicate extends can be used again
https://github.com/docker/compose/pull/7588
* Minor style update
Co-authored-by: Usha Mandya <47779042+usha-mandya@users.noreply.github.com>
* Modify With oh-my-zsh shell part
Tell user how to open the file and test whether it is successful.
* Update completion.md
Remove references to specific editors
Co-authored-by: Usha Mandya <47779042+usha-mandya@users.noreply.github.com>
Docs contained an invalid example:
```
ERROR: The Compose file './docker-compose.yml' is invalid because:
services.*.restart contains an invalid type, it should be a string
```
Use quotes to avoid YAML's implicit type conversion. Someone may also want to do an audit of [other type conversions that might cause problems](https://www.rpatterson.net/blog/docker-gotchas/#yaml-needs-some-zen).
- Add missing code-hints (console, yaml)
- Consistently add an empty line after code-blocks
- Combine some examples where the output and the command were
put in separate blocks. With the "console" code-hint, this
is no longer nescessary.
- fix indentation in cloud/ecs-integration.md, which caused the
numbered-list to be interrupted.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
* document compose.v2 linux installation as a CLI plugin
Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
* Minor style update
Co-authored-by: Usha Mandya <47779042+usha-mandya@users.noreply.github.com>
I looked forever to find this information. The expected section to find this information is this page, not where it ends up at the bottom of overview.
Based on the v3 overview of compose-files, it seems it can be included with this line- as thats how they did it there.
A link would also work, or a copy of the whole section. Using include has the added benefit however of making a single section with changes updated across the docs if needed.
* compose: make `project directory` explicit
See https://github.com/docker/compose/issues/8347 .
Some users assume that `project directory` is the directory which has `docker-compose.yaml`.
But this is not true (at least for now) when you execute `docker-compose` in sub directory.
This PR makes it clear.
* fix a typo and made style updates
Co-authored-by: Usha Mandya <47779042+usha-mandya@users.noreply.github.com>
* Add --service-ports note to ports section
## Description
Add note in `ports` section of file reference docs pointing to the `run` command's `--service-ports` flag
## Motivation
Spent quite a few hours spinning my wheels before I came across `run`'s `--service-ports` flag.
I'm struggling to find the issue where I found this, but the comment pointing to `--service-ports` had a lot of reacts, so this might be a relatively common
## Things I'd still like to do
- [ ] link to the [`--service-ports` docs](https://github.com/docker/docker.github.io/blob/master/compose/reference/run.md) -- not sure how to do this
- [ ] clean up location of this note -- not sure if I've put the note in a good place -- we can shunt it to the bottom
- [ ] Duplicate for older versions
Thanks
* Minor style update
Co-authored-by: Usha Mandya <47779042+usha-mandya@users.noreply.github.com>
BuildKit allows using alternative Dockerfile syntaxes to introduce new features
without having to update Docker itself. The general recommendation is to always
specify a "syntax" directive in a Dockerfile, so that (if needed) older versions
of Docker can download the correct syntax to build the Dockerfile.
This updates our examples to include a syntax directive, to make users more familiar
with these directives, and to illustrate best-pracitces in our documentation.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
First step: remove the old "index" page, as it was not linked from the TOC, and
was serving the same purpose as the "overview" page.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Unifying all "examples" in this directory; some of these should still be
reviewed and/or removed in favor of examples from "awesome compose"
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
The current wording of "name of the config as it exists in Docker" suggests that the real generated name is used, instead the "key" of `configs` object in the docker-compose file is used.
```yml
version: "3.5"
services:
app:
image: alpine
configs:
# documentation currently suggests this (the "name as in Docker")
# this causes an error- undefined config "name-as-in-docker"
- source: name-as-in-docker
target: /config-with-name-as-in-docker.json
# the correct source to use is the name (key) from this docker-compose file
- source: name-as-in-file
target: /config-with-name-as-in-file.json
configs:
name-as-in-file:
name: name-as-in-docker
file: ./cfg.json
```
* Reorganize sections for variable substitution and document .env file path change for `1.28`
Signed-off-by: Anca Iordache <anca.iordache@docker.com>
* Minor style edits
* Minor style edits
Co-authored-by: Usha Mandya <47779042+usha-mandya@users.noreply.github.com>
* Fixed the codeblock in cli_command.md
* Add a prompt to ensure the command is selectable
Co-authored-by: Usha Mandya <47779042+usha-mandya@users.noreply.github.com>
* Document GPU support in Docker Compose
Signed-off-by: aiordache <anca.iordache@docker.com>
* Update the note format
Added target=blank to enable external links to open in a new tab.
Co-authored-by: Usha Mandya <47779042+usha-mandya@users.noreply.github.com>
The documentation curently doesn't contain reference docs for the
unified (version-less) compose-file syntax, so for now replacing
all links to point to the v3 compose-file reference, which is still
present.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
An option's short form should not be used in descriptions since they are intentionally terse and as such does throw away the otherwise nice narrative provide by using the long form.
- The index pages were not in the redirect (they were not in the TOC,
but were published before, so could be indexed).
- Added "redirect_from" pages that were in the pages that were removed.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
The `hide_from_sitemap` metadata variable was a custom thing we implemented
to add a "noindex" meta-header to pages and to exclude a page from the
search auto-complete.
However, pages with that option set would still be included in sitemap.xml,
resulting in search engines to visit those pages (only to discover they
should not index them).
This patch replaces the custom `hide_from_sitemap` value for `sitemap: false`,
which is a metadata variable that's defined by the "jekyll-sitemap" plugin
we use to generate the sitemap.xml;
https://github.com/jekyll/jekyll-sitemap/blob/v1.4.0/README.md#exclusions
Setting this variable will now:
- add a "noindex" metadata header to the page
- exclude the page from the sitemap.xml.
- exclude the page from /js/metadata.json (used for search autocomplete)
Also fixed an issue in the metadata.json where the `notoc` metadata was
used to exclude pages, however that variable is meant to disable the
in-page TOC (right-hand side navigation with anchor links).
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
This topic was removed in 9bebb666d9
We may want to add back the part describing sharing sshagent somewhere,
which is not really a feature related to osxfs. Also, some generic
description about file sharing (permissions, syncing) should probably
be added back.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
See https://web.dev/external-anchors-use-rel-noopener/
Using noopener, as that addresses the security issue. "noreferer" blocks
the REFERER header, which may still be useful for some target URLs.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
* Correcting update_config.monitor documentation
The default monitor period is 5s and cannot be set to 0. The lowest possible value is 1ns.
* Correcting default values
The `ENV key value` form can be ambiguous, for example, the following defines
a single env-variable (`ONE`) with value `"TWO= THREE=world"`:
ENV ONE TWO= THREE=world
While we cannot deprecate/remove that syntax (as it would break existing
Dockerfiles), we should reduce exposure of the format in our examples.
Also updating some code-blocks that were missing language-hints
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
* Update docs on command help
This is change is based on the output of the script proposed by @smola
in: https://github.com/docker/docker.github.io/pull/11173
Signed-off-by: Ulysses Souza <ulyssessouza@gmail.com>
* Formatting updates
* Minor style update
Co-authored-by: Usha Mandya <47779042+usha-mandya@users.noreply.github.com>
* Add note about setup beeing not viable production
I think there should at least a small hint that this guide is just intended as a bare-bones development environment and should not at all be rolled into production like this.
Relates to #7622
* Minor style updates
Co-authored-by: Usha Mandya <47779042+usha-mandya@users.noreply.github.com>
* Update gettingstarted.md
1. Flask app was running in the wrong port.
2. 5000 port was not exposed in Dockerfile
* Update gettingstarted.md
mistook Redis port to flask port.
### Background
Newer upstream PostgreSQL Docker images, now require a password for use. If you were previously using passwordless access to a PostgreSQL DB, it will likely fail with an error.
This linked GitHub issue showcases the error:
https://github.com/docker-library/postgres/issues/681
### Solution
The postgres docker page gives instructions on how to use the new image : https://hub.docker.com/_/postgres
There seems to be two different options we can take here :
Option 1 - Implement a password using the environment variable
Option 2 - Revert back to old behavior of having no password requirement
### Thoughts
Based on the team members remark it looks like increased security was the major reason for this breaking changing happening in a minor update. Refer to this comment : https://github.com/docker-library/postgres/issues/681#issuecomment-586517154
As such I opted to use Option 1 here in this change as increased security of a DB is generally a win for every one in most cases.
Unfortunately, the only reliable way to create internal links
is to use relative links to other Markdown files. This does
match the way links on GitHub work, but makes it harder to
create these links.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
- Move getting started overview to /get-started/overview/
- Move engine installation files under /engine/
- Redirect the top-level /install/ to /get-docker/
- Updated titles in left-hand navigation
- Added back some pages to the navigation that were
currently not included.
- Reduce some steps in the installation pages
- Move devicemapper prerequisites to the devicemapper
storage driver page.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
* Fix incorrect links in compose section
there's a bug causing wrapped links to not work, and replacing
some links to point to the .md file, so that IDE's can check
if the anchors are valid. Also replaced some links to point
to their new location.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
* engine/swarm: update links
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
* Fix various broken links
There's a bug in the "jekyll-relative-links" plugin that causes wrapped links to not work.
Also replacing some links to point to the .md file, so that IDE's can check if the anchors
are valid. Finally, replaced some links to point to their new locations, so that users don't
get redirected..
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
hochan@hochan-node:~/Desktop/pfc/dockercompose$ sudo docker-compose up --build
ERROR: Version in "./docker-compose.yml" is unsupported. You might be seeing this error because you're using the wrong Compose file version. Either specify a version of "2" (or "2.0") and place your service definitions under the `services` key, or omit the `version` key and place your service definitions at the root of the file to use version 1.
Deploying stacks using the "Docker Application Bundle" (`.dab`) file
format was introduced as an experimental feature in Docker 1.13 /
17.03, but superseded by support for Docker Compose files in the CLI.
With no development being done on this feature, and no active use of the file
format, support for the DAB file format and the top-level `docker deploy` command
(hidden by default in 19.03), will be removed from the CLI, in favour of
`docker stack deploy` using compose files.
This patch removes documentation for the `docker-compose bundle` subcommand,
which was used to convert compose files into DAB files (and given the above,
will no longer be needed).
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
PeterBParker
Usha Mandya
Marco Marra
QuantumGhost
Usha Mandya
Ashley Oliver
Tobias Sette
jrudel
Stefan Scherer
Kayla Reopelle (she/her)
Jared Leach
Markus Meier
Ulysses Souza
KY-7
Daniel Fahlke
Jim Flattery
Tom Lankhorst
Andrew
Benson Muite
Max Juchheim
Sebastiaan van Stijn
ndrwrbgs
Ap0them
TheDarkTron
Dan Bamikiya
Mathieu Champlon
Jenny Wu
Keith Scheiwiller
Sebastiaan van Stijn
Rackme
Nicolas De Loof
Jeff Anderson
Ross Patterson
Andy Timmons
satotake
shokkunrf
Paul Townsend
Ralph Bisschops
Ulysses Souza
unknown
MessaoudiM
lightmare
Kaden Scott
Guillaume Tardif
Porter Darby
Zane Dufour
Anca Iordache
Edgars Baduns
Anca Iordache
Stig124
Piotr Sobieszczański
Catgirl
Joshua Schlichting
Simon
Chris Crone
Randy Fay
Roman Anasal
Simon
Brennan Kinney
Christian
Alexander Pushkov
Tim McNamara
Dr. Walter Kammergruber
Rob Cowsill
Adam Leskis
George
Hélène Martin
Liu Lantao
Liu Lantao
Jak Spalding
Muma David Bwalya
Sohrab Shahinfar
Mark Schmale
Geetha Rangaswamaiah
Melanie Kwon
Vemuluru Venkata Sri Harsha
Kaden Weber
Jason C
David Florness
Alan Bondarchuk
Aleksandr Prusov
Aravind
Daniel Martinez Sarta
ticalcster
Dale Seo
Beni Rupp
Sven Dowideit
Young Jin Ahn
Charles Chan
Hector S
hochan222
charliemenke
TribalNightOwl
Andrey Kuchuk
Daniel Naftalovich
lena-larionova
KoryKessel-Docker