Commit Graph

170 Commits

Author SHA1 Message Date
a11d66ea07 Added back OAuth and Accounts API docs pages
Removed a now unused endpoint from the accounts API.
Updated some of the accounts links to point to www.docker.io
as the account signup and resend-email-confirmation links should
no longer point to the index.

Docker-DCO-1.1-Signed-off-by: Josh Hawn <josh.hawn@docker.com> (github: jlhawn)
Upstream-commit: c6060a3b25b94ae4738ac27bbf62cbb914af7ced
Component: engine
2014-04-27 11:17:48 -07:00
72e7e8f048 small api doc formatting fixup
Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@fosiki.com> (github: SvenDowideit)
Upstream-commit: c7bd1f4e648c6615eafebbfcaeb1c30020fc0aba
Component: engine
2014-04-25 20:36:31 +10:00
75bef1c9a4 Merge pull request #5372 from SvenDowideit/docs-tweaks-to-socket-options
Docs tweaks to socket options
Upstream-commit: 1083b6d2ecc3dd5b71d285954aa6d101a5847db3
Component: engine
2014-04-25 09:08:22 +10:00
b6080f6f5b Looking into some broken links, I noticed that we don't need to use
relative paths, and also fixed some broken images.

There are still more todo - next PR I think :)

Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@fosiki.com> (github: SvenDowideit)
Upstream-commit: ada86fc5b736d8b3209429c584384fd9974a148a
Component: engine
2014-04-24 22:20:04 +10:00
772ac62a9b Docs auto-conversion fixes and MD marking and structure improvements.
- Remove redundant chars and all errors caused by RST->MD conversion.
   e.g. [/#, /\, \<, />, etc.]
 - Fix broken inter-document links
 - Fix outbound links no-longer active or changed
 - Fix lists
 - Fix code blocks
 - Correct apostrophes
 - Replace redundant inline note marks for code with code marks
 - Fix broken image links
 - Remove non-functional title links
 - Correct broken cross-docs links
 - Improve readability

Note: This PR does not try to fix/amend:

 - Grammatical errors
 - Lexical errors
 - Linguistic-logic errors etc.

It just aims to fix main structural or conversion errors to serve as
a base for further amendments that will cover others including but
not limited to those mentioned above.

Docker-DCO-1.1-Signed-off-by: O.S. Tezer <ostezer@gmail.com> (github: ostezer)

Update:

 - Fix backtick issues

Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au> (github: SvenDowideit)
Upstream-commit: c932667cd26f00bb64ddf0c1a7c7de3ac95aa4be
Component: engine
2014-04-24 22:19:32 +10:00
84cddc3f87 add a reference to multiple -H options, and update the other example of -H option
and copy changes to the cli.md file

Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@fosiki.com> (github: SvenDowideit)
Upstream-commit: b2c87fe08b71523eb20fed63e5da3bef30b756ec
Component: engine
2014-04-24 11:24:58 +10:00
5742188cb8 - unix://path/to/socket should read unix:///path/to/socket like the rest of the documentation (a slash was missing)
- Mention that [] options may be specified multiple times on the Usage page

Docker-DCO-1.1-Signed-off-by: Mike MacCana <mike.maccana@gmail.com> (github: mikemaccana)

Docker-DCO-1.1-Signed-off-by: Mike MacCana <mike.maccana@gmail.com> (github: SvenDowideit)
Upstream-commit: e62efb266fd878453b8562e60b06a3e579fe571a
Component: engine
2014-04-24 11:11:51 +10:00
4690619ea9 Add missing blank lines in between list items
Lists with paragraphs as items need blank lines in between
items to generate correct layout.

Docker-DCO-1.1-Signed-off-by: Lance Chen <cyen0312@gmail.com> (github: Lance0312)
Upstream-commit: b87cb76976da57a6765acd9a85494c68a4e6b948
Component: engine
2014-04-21 01:32:00 +08:00
e0138ab848 Introducing spīritus lēnis to fix code highlighting issues due to apostrophe.
Docker-DCO-1.1-Signed-off-by: O.S. Tezer <ostezer@gmail.com> (github: ostezer)
Upstream-commit: 2d6324e06a1e2ea8bb2236472a99c3dc4b5f66d1
Component: engine
2014-04-19 03:35:45 +03:00
c565574306 Mark notes and warnings, fix broken link renderings within.
Docker-DCO-1.1-Signed-off-by: O.S. Tezer <ostezer@gmail.com> (github: ostezer)
Upstream-commit: 7935850005b775e0cd1a99f9bab1b8cd53784c3a
Component: engine
2014-04-18 23:31:38 +03:00
1bbbedd397 Fixed #5283 - literal leftover from cutover
Docker-DCO-1.1-Signed-off-by: James Turnbull <james@lovedthanlost.net> (github: jamtur01)
Upstream-commit: 2f3cb370dfaca1f1c41bbd7af5f064f70ad8267b
Component: engine
2014-04-17 18:58:02 -04:00
925af64a21 Merge pull request #5261 from ostezer/fix-inline-links
Fix for broken in-document links which got scrambled during conversion.
Upstream-commit: ad8db1aa22c2ee791ffc612e6b8dbd2b780f6070
Component: engine
2014-04-18 01:49:18 +03:00
4e25aa80e6 Fix for broken in-document links which got scrambled during conversion.
Docker-DCO-1.1-Signed-off-by: O.S. Tezer <ostezer@gmail.com> (github: ostezer)
Upstream-commit: 1ff66d27b5b35b9782d6d6cdd5fc5ec95bdda07d
Component: engine
2014-04-17 18:09:08 +03:00
86ffd6a16e Remove manually written TOCs from archived docs.
Docker-DCO-1.1-Signed-off-by: O.S. Tezer <ostezer@gmail.com> (github: ostezer)
Upstream-commit: 24a42b1370380179c48f88a3d2d81faddda9cbcc
Component: engine
2014-04-17 17:47:34 +03:00
c4684e29f0 now, with shiney markdown
Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@fosiki.com> (github: SvenDowideit)
Upstream-commit: ac999a9cb2b0976e021aeb8825bb051df6bd0976
Component: engine
2014-04-16 11:04:14 +10:00
5c2b3f3f64 move the documentation to markdown
Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au> (github: SvenDowideit)
Upstream-commit: a777ebcee6326bed2f7e99eedf6edbb922175e2d
Component: engine
2014-04-16 11:04:01 +10:00
ab0b17d0d0 Merge pull request #4828 from almoehi/patch-1
Added reactive-docker to list of remote API clients
Upstream-commit: b255d96694e561fd2ed5b1a5c45b7cdc01af7ffb
Component: engine
2014-04-14 19:06:59 +03:00
a6fc08c279 Merge pull request #4821 from jimenez/3903-add_event_end_timestamp-feature
Adding timestamp end to events endpoint. Modifying api docs.
Upstream-commit: a521388863502014bdea80585b7272a854191244
Component: engine
2014-04-10 20:54:53 +03:00
825d583586 Adding timestamp end to events endpoint. Modifying api docs.
Docker-DCO-1.1-Signed-off-by: Isabel Jimenez <contact@isabeljimenez.com> (github: jimenez)
Upstream-commit: 66dd4ea4e280e4acc133872401bf8a79c80510f3
Component: engine
2014-04-10 10:43:21 -07:00
ed316755af add some more text to the cli docs
Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@fosiki.com> (github: SvenDowideit)
Upstream-commit: e625cee28dc62d7fbc5172e0e9c01708e2bd7fc4
Component: engine
2014-04-10 12:52:46 +00:00
8b91dd2d6d Update dns and volumes-from docs
Docker-DCO-1.1-Signed-off-by: Michael Crosby <michael@crosbymichael.com> (github: crosbymichael)
Upstream-commit: a43a600a2cb516813a045e3b90e8a9ae81d8a783
Component: engine
2014-04-08 19:17:30 -07:00
904747ba78 Early deprecation warning for 'docker commit --run'
Warn users of the planned deprecation of 'docker commit --run', and hide
it from the docs and usage message. The option continues to work.

Note that an alternative to 'commit --run' is being implemented but is
not yet available. We are printing the warning anyway because on
the basis that it never hurts to give more advance warning.

The 'commit --run' flag is a leftover from the very early days of Docker,
and has several problems:

1) It is very user unfriendly. You have to pass a literal json dict
which is poorly documented and changes regularly (see PortSpecs vs
ExposedPorts). The merge behavior is not clear and also changes
regularly. it's not possible to unset a value.

2) It overlaps with the Dockerfile syntax. There are 2 ways to set
a default command, expose a port or change an env variable. Some
things can be done in a Dockerfile but not in --run. Some things
can be done in --run but not in a Dockerfile. It would be better
to push a single syntax, allow using it both in a file and via
the command line, and make improvements in a single place.

3) It exposes data structures which should not be publicly exposed.
There are several planned improvements to Docker which require moving
around the content and schema of the various Config, Image and Container
structures. The less of those we expose in public interfaces, the easier
it is to move things around without a reverse compatibility nightmare.

Docker-DCO-1.1-Signed-off-by: Solomon Hykes <solomon@docker.com> (github: shykes)
Upstream-commit: 168f8aba74d9c2996acec6fe1b93a2301523e305
Component: engine
2014-04-08 12:10:47 -07:00
8d9bcb61ba Added reactive-docker to list of remote API clients
Docker-DCO-1.1-Signed-off-by: H. Rapp <webmaster@3kolor.com> (github: almoehi)
Upstream-commit: a67f3504425a6c3f210aa8117025518d4a2109f1
Component: engine
2014-04-08 11:47:15 +02:00
f111f492ef use the docs sidebar to be the TOC means that level 2 headings are the most important
Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@fosiki.com> (github: SvenDowideit)
Upstream-commit: e6a64af966698d8b9dfe8721ca4404fc06331d69
Component: engine
2014-04-08 14:25:57 +10:00
dbddde5f2d intermediate image layers are used for more than the build
Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@fosiki.com> (github: SvenDowideit)
Upstream-commit: 87ea27e80b131ca11d74c89446d4992af0f6c5b9
Component: engine
2014-04-07 18:37:52 +10:00
bc3cbf9f38 Merge pull request #5005 from shykes/deprecate-insert
Deprecate 'docker insert'
Upstream-commit: 09aa28eca049320f53300f9d7ba9bc28c1033d3b
Component: engine
2014-04-03 17:16:25 -07:00
96808698c3 Deprecate 'docker insert'
'docker insert' is an old command which predates 'docker build'. We no
longer recommend using it, it is not actively maintained, and can be
replaced with the combination of 'docker build' and 'ADD'.

This removes the command from usage and documentation, and prints a
warning when it is called.

The command still works but it will be removed in a future version.

Docker-DCO-1.1-Signed-off-by: Solomon Hykes <solomon@docker.com> (github: shykes)
Upstream-commit: 615ac8feb27b2b3db0c06b37ecd87b710eabffef
Component: engine
2014-04-03 23:52:09 +00:00
14694d6df5 Deprecate 'docker images --tree' and 'docker images --viz'
* The commands are no longer listed or documented.
* The commands still work but print a deprecation warning.
* The commands should be removed in a future version.

Docker-DCO-1.1-Signed-off-by: Solomon Hykes <solomon@docker.com> (github: shykes)
Upstream-commit: 7c3b955b907c33238c1c155ae8860b2cec929c8b
Component: engine
2014-04-03 22:03:23 +00:00
6d320e0c92 explained what authConfig actually is.
Docker-DCO-1.1-Signed-off-by: Michael Neale <michael.neale@gmail.com> (github: michaelneale)
Upstream-commit: 75633a0451a98bf0c803e742625c4de27dbcc2e8
Component: engine
2014-04-03 19:43:21 +11:00
e3d229211f docs: explain what docker run -a does
This adds a bit of documentation for the `-a` flag for docker run.

Docker-DCO-1.1-Signed-off-by: Cristian Staretu <cristian.staretu@gmail.com> (github: unclejack)
Upstream-commit: 63c7941172376e81c5e17206f39d7c78c0e95b69
Component: engine
2014-04-02 16:23:01 +03:00
63bbec4039 Merge pull request #4938 from jlhawn/master
No longer expose gravatar_email in docker.io api
Upstream-commit: 8cc8b1dd9989ede140c59ed40582c93552a5cd87
Component: engine
2014-04-02 09:13:33 +10:00
99eaa02040 Update docs. Make PULL up to date, remove deprecated falg and update PUSH
Docker-DCO-1.1-Signed-off-by: Guillaume J. Charmes <guillaume@charmes.net> (github: creack)
Upstream-commit: b8d660d946c5f0be3a4f01867b11f26a4f303293
Component: engine
2014-04-01 11:17:54 -07:00
72e62c1c7b No longer expose gravatar_email in docker.io api
Docker.io API has replaced the gravatar_email field with a
gravatar_url field instead.

Docker-DCO-1.1-Signed-off-by: Josh Hawn <josh.hawn@docker.com> (github: jlhawn)
Upstream-commit: 289377b409b321a5a624af3517032c396df6c22f
Component: engine
2014-03-31 15:34:43 -07:00
7fc896339a --env-file: simple line-delimited
match dock functionality, and not try to achieve shell-sourcing compatibility

Docker-DCO-1.1-Signed-off-by: Vincent Batts <vbatts@redhat.com> (github: vbatts)
Upstream-commit: ff4ac7441ba582c8c339b25b400c6756d9646ff1
Component: engine
2014-03-31 14:45:13 -04:00
745a00084d env-file: update functionality and docs
Multiple flags allowed. Order prescribed. Examples provided. Multiline
accounted for.

Docker-DCO-1.1-Signed-off-by: Vincent Batts <vbatts@redhat.com> (github: vbatts)
Upstream-commit: 33dde1f7288781a3a36951309f963e6040a1a0f5
Component: engine
2014-03-31 14:45:13 -04:00
654ceecb5b Fixing doc references to --env-file
Docker-DCO-1.1-Signed-off-by: Vincent Batts <vbatts@redhat.com> (github: vbatts)
Upstream-commit: bcba5246f993a74eece36aa4b25df5b5e486e15b
Component: engine
2014-03-31 14:44:32 -04:00
d6e8571af8 --env-file instead of --envfile
Docker-DCO-1.1-Signed-off-by: Vincent Batts <vbatts@redhat.com> (github: vbatts)
Upstream-commit: 586e6c5eb9cd21a95d4bbba051249c4b05b2011e
Component: engine
2014-03-31 14:44:32 -04:00
2d9f166bda support for docker run environment variables file
Docker-DCO-1.1-Signed-off-by: Vincent Batts <vbatts@redhat.com> (github: vbatts)
Upstream-commit: cd51ac92bdf1ce0a1245f5b4565995631512ba64
Component: engine
2014-03-31 14:44:32 -04:00
0b1efc836d Fix daemon's documentation for -bip flag
Upstream-commit: 36dfa0c4ec90404f76a6ec73c89d199e279ee96c
Component: engine
2014-03-28 18:02:17 -04:00
544146df61 typo fix
Upstream-commit: 61f7d967ed635098abaf42fc411866bb198b97c5
Component: engine
2014-03-26 10:24:16 -04:00
365103a8e5 Merge pull request #4840 from vbatts/vbatts-load_from_input
docker load: add --input flag
Upstream-commit: 5506e4b62dfad9d79fbeed91b9696fb51c736631
Component: engine
2014-03-25 14:37:27 -07:00
70fdc926f2 docker load: added example of a multiple tag image
Docker-DCO-1.1-Signed-off-by: Vincent Batts <vbatts@redhat.com> (github: vbatts)
Upstream-commit: 2517370088ad11765f99d75c16b58e93fe18f85a
Component: engine
2014-03-25 08:30:59 -04:00
e26ac10f84 docker load: doc clarification
Docker-DCO-1.1-Signed-off-by: Vincent Batts <vbatts@redhat.com> (github: vbatts)
Upstream-commit: c6c7c03cddc852c42b9f047fbd5c2fb6cecf39eb
Component: engine
2014-03-24 23:36:07 -04:00
deed2b6616 docker load: add --input flag
for those that do not care to read from redirected stdin

Docker-DCO-1.1-Signed-off-by: Vincent Batts <vbatts@redhat.com> (github: vbatts)
Upstream-commit: 84e1fdf35d9d6493d389a8e8be3ab41190004b30
Component: engine
2014-03-24 21:43:26 -04:00
3c6aacdcbb Merge pull request #4786 from SvenDowideit/run--lxc-conf-is-lxc-driver-only-atm
add a note that --lxc-conf is lxc-driver only.
Upstream-commit: 0b2b5a594b6aadaffeab1d6ce823717390111f1e
Component: engine
2014-03-25 11:21:06 +10:00
186280f667 Merge pull request #4778 from vbatts/vbatts-save_to_output
`docker save --output` flags
Upstream-commit: a258d048a221d2598f7317ee8e64765cb20fd588
Component: engine
2014-03-24 16:52:08 -07:00
aa948163e7 Revert "Disable automatic killing of containers when docker stop fails"
This reverts commit 8b5cf51d600dc4f3611cf063c52cf3448e7b01e5.

Docker-DCO-1.1-Signed-off-by: Michael Crosby <michael@crosbymichael.com> (github: crosbymichael)
Upstream-commit: d503714285143013d9fa6932ee5775fd155d26d2
Component: engine
2014-03-24 12:03:56 +00:00
abc3562e62 Added Eixo::Docker to the list of libraries
Docker-DCO-1.1-Signed-off-by: Javier Gómez <alambike@gmail.com> (github: alambike)
Upstream-commit: 79c11b19ecd506bd76db391b896cec0d4263183d
Component: engine
2014-03-21 03:13:06 +01:00
17b4dbb455 I'm not looking forward to documenting cli arguments that may or may not show depending on what plugins / drviers you choose
Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@fosiki.com> (github: SvenDowideit)
Upstream-commit: a8cc6ebb181abf58b12ed6ee037711f0b2f1eff2
Component: engine
2014-03-20 09:59:54 +10:00
43102e0522 Merge branch 'master' into discordianfish-https_client
Docker-DCO-1.1-Signed-off-by: Victor Vieux <victor.vieux@docker.com> (github: vieux)
Upstream-commit: aa63ece2ec8bae9d13c258ad8e771e3a000cc941
Component: engine
2014-03-19 22:05:36 +00:00