diff --git a/docs/Makefile b/docs/Makefile index 77f14ee92f..9298123f7f 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -46,23 +46,24 @@ clean: docs: -rm -rf $(BUILDDIR)/* $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/html - cp sources/index.html $(BUILDDIR)/html/ - cp -r sources/gettingstarted $(BUILDDIR)/html/ - cp sources/dotcloud.yml $(BUILDDIR)/html/ - cp sources/CNAME $(BUILDDIR)/html/ - cp sources/.nojekyll $(BUILDDIR)/html/ - cp sources/nginx.conf $(BUILDDIR)/html/ @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." + @echo "Build finished. The documentation pages are now in $(BUILDDIR)/html." + + +site: + cp -r website $(BUILDDIR)/ + cp -r theme/docker/static/ $(BUILDDIR)/website/ + @echo + @echo "The Website pages are in $(BUILDDIR)/site." connect: - @echo pushing changes to staging site - @cd _build/html/ ; \ - @dotcloud list ; \ + @echo connecting dotcloud to www.docker.io website, make sure to use user 1 + @cd _build/website/ ; \ + dotcloud list ; \ dotcloud connect dockerwebsite push: - @cd _build/html/ ; \ + @cd _build/website/ ; \ dotcloud push github-deploy: docs diff --git a/docs/sources/commandline/cli.rst b/docs/sources/commandline/cli.rst new file mode 100644 index 0000000000..47ecb79e67 --- /dev/null +++ b/docs/sources/commandline/cli.rst @@ -0,0 +1,55 @@ +:title: Command Line Interface +:description: Docker's CLI command description and usage +:keywords: Docker, Docker documentation, CLI, command line + +.. _cli: + +Command Line Interface +====================== + +Docker Usage +~~~~~~~~~~~~ + +To list available commands, either run ``docker`` with no parameters or execute +``docker help``:: + + $ docker + Usage: docker COMMAND [arg...] + + A self-sufficient runtime for linux containers. + + ... + +Available Commands +~~~~~~~~~~~~~~~~~~ + +.. toctree:: + :maxdepth: 1 + + command/attach + command/build + command/commit + command/diff + command/export + command/history + command/images + command/import + command/info + command/inspect + command/kill + command/login + command/logs + command/port + command/ps + command/pull + command/push + command/restart + command/rm + command/rmi + command/run + command/search + command/start + command/stop + command/tag + command/version + command/wait diff --git a/docs/sources/commandline/command/attach.rst b/docs/sources/commandline/command/attach.rst new file mode 100644 index 0000000000..ac9a84c0cf --- /dev/null +++ b/docs/sources/commandline/command/attach.rst @@ -0,0 +1,9 @@ +=========================================== +``attach`` -- Attach to a running container +=========================================== + +:: + + Usage: docker attach CONTAINER + + Attach to a running container diff --git a/docs/sources/commandline/command/build.rst b/docs/sources/commandline/command/build.rst new file mode 100644 index 0000000000..8d07c725c2 --- /dev/null +++ b/docs/sources/commandline/command/build.rst @@ -0,0 +1,9 @@ +======================================================== +``build`` -- Build a container from Dockerfile via stdin +======================================================== + +:: + + Usage: docker build - + Example: cat Dockerfile | docker build - + Build a new image from the Dockerfile passed via stdin diff --git a/docs/sources/commandline/command/commit.rst b/docs/sources/commandline/command/commit.rst new file mode 100644 index 0000000000..c73f8d1898 --- /dev/null +++ b/docs/sources/commandline/command/commit.rst @@ -0,0 +1,27 @@ +=========================================================== +``commit`` -- Create a new image from a container's changes +=========================================================== + +:: + + Usage: docker commit [OPTIONS] CONTAINER [REPOSITORY [TAG]] + + Create a new image from a container's changes + + -m="": Commit message + -author="": Author (eg. "John Hannibal Smith " + -run="": Config automatically applied when the image is run. "+`(ex: {"Cmd": ["cat", "/world"], "PortSpecs": ["22"]}') + +Full -run example:: + + {"Hostname": "", + "User": "", + "Memory": 0, + "MemorySwap": 0, + "PortSpecs": ["22", "80", "443"], + "Tty": true, + "OpenStdin": true, + "StdinOnce": true, + "Env": ["FOO=BAR", "FOO2=BAR2"], + "Cmd": ["cat", "-e", "/etc/resolv.conf"], + "Dns": ["8.8.8.8", "8.8.4.4"]} diff --git a/docs/sources/commandline/command/diff.rst b/docs/sources/commandline/command/diff.rst new file mode 100644 index 0000000000..301da6c499 --- /dev/null +++ b/docs/sources/commandline/command/diff.rst @@ -0,0 +1,9 @@ +======================================================= +``diff`` -- Inspect changes on a container's filesystem +======================================================= + +:: + + Usage: docker diff CONTAINER [OPTIONS] + + Inspect changes on a container's filesystem diff --git a/docs/sources/commandline/command/export.rst b/docs/sources/commandline/command/export.rst new file mode 100644 index 0000000000..88ecd2fd53 --- /dev/null +++ b/docs/sources/commandline/command/export.rst @@ -0,0 +1,9 @@ +================================================================= +``export`` -- Stream the contents of a container as a tar archive +================================================================= + +:: + + Usage: docker export CONTAINER + + Export the contents of a filesystem as a tar archive diff --git a/docs/sources/commandline/command/history.rst b/docs/sources/commandline/command/history.rst new file mode 100644 index 0000000000..92fad3b487 --- /dev/null +++ b/docs/sources/commandline/command/history.rst @@ -0,0 +1,9 @@ +=========================================== +``history`` -- Show the history of an image +=========================================== + +:: + + Usage: docker history [OPTIONS] IMAGE + + Show the history of an image diff --git a/docs/sources/commandline/command/images.rst b/docs/sources/commandline/command/images.rst new file mode 100644 index 0000000000..5bcfe817f4 --- /dev/null +++ b/docs/sources/commandline/command/images.rst @@ -0,0 +1,22 @@ +========================= +``images`` -- List images +========================= + +:: + + Usage: docker images [OPTIONS] [NAME] + + List images + + -a=false: show all images + -q=false: only show numeric IDs + -viz=false: output in graphviz format + +Displaying images visually +-------------------------- + +:: + + docker images -viz | dot -Tpng -o docker.png + +.. image:: images/docker_images.gif diff --git a/docs/sources/commandline/command/images/docker_images.gif b/docs/sources/commandline/command/images/docker_images.gif new file mode 100644 index 0000000000..5894ca270e Binary files /dev/null and b/docs/sources/commandline/command/images/docker_images.gif differ diff --git a/docs/sources/commandline/command/import.rst b/docs/sources/commandline/command/import.rst new file mode 100644 index 0000000000..5fe90764b9 --- /dev/null +++ b/docs/sources/commandline/command/import.rst @@ -0,0 +1,9 @@ +========================================================================== +``import`` -- Create a new filesystem image from the contents of a tarball +========================================================================== + +:: + + Usage: docker import [OPTIONS] URL|- [REPOSITORY [TAG]] + + Create a new filesystem image from the contents of a tarball diff --git a/docs/sources/commandline/command/info.rst b/docs/sources/commandline/command/info.rst new file mode 100644 index 0000000000..10697dba18 --- /dev/null +++ b/docs/sources/commandline/command/info.rst @@ -0,0 +1,9 @@ +=========================================== +``info`` -- Display system-wide information +=========================================== + +:: + + Usage: docker info + + Display system-wide information. diff --git a/docs/sources/commandline/command/inspect.rst b/docs/sources/commandline/command/inspect.rst new file mode 100644 index 0000000000..34365d1f26 --- /dev/null +++ b/docs/sources/commandline/command/inspect.rst @@ -0,0 +1,9 @@ +========================================================== +``inspect`` -- Return low-level information on a container +========================================================== + +:: + + Usage: docker inspect [OPTIONS] CONTAINER + + Return low-level information on a container diff --git a/docs/sources/commandline/command/kill.rst b/docs/sources/commandline/command/kill.rst new file mode 100644 index 0000000000..cbd019e1a9 --- /dev/null +++ b/docs/sources/commandline/command/kill.rst @@ -0,0 +1,9 @@ +==================================== +``kill`` -- Kill a running container +==================================== + +:: + + Usage: docker kill [OPTIONS] CONTAINER [CONTAINER...] + + Kill a running container diff --git a/docs/sources/commandline/command/login.rst b/docs/sources/commandline/command/login.rst new file mode 100644 index 0000000000..b064b40145 --- /dev/null +++ b/docs/sources/commandline/command/login.rst @@ -0,0 +1,9 @@ +============================================================ +``login`` -- Register or Login to the docker registry server +============================================================ + +:: + + Usage: docker login + + Register or Login to the docker registry server diff --git a/docs/sources/commandline/command/logs.rst b/docs/sources/commandline/command/logs.rst new file mode 100644 index 0000000000..87f3f95b65 --- /dev/null +++ b/docs/sources/commandline/command/logs.rst @@ -0,0 +1,9 @@ +========================================= +``logs`` -- Fetch the logs of a container +========================================= + +:: + + Usage: docker logs [OPTIONS] CONTAINER + + Fetch the logs of a container diff --git a/docs/sources/commandline/command/port.rst b/docs/sources/commandline/command/port.rst new file mode 100644 index 0000000000..4fb6d7f812 --- /dev/null +++ b/docs/sources/commandline/command/port.rst @@ -0,0 +1,9 @@ +========================================================================= +``port`` -- Lookup the public-facing port which is NAT-ed to PRIVATE_PORT +========================================================================= + +:: + + Usage: docker port [OPTIONS] CONTAINER PRIVATE_PORT + + Lookup the public-facing port which is NAT-ed to PRIVATE_PORT diff --git a/docs/sources/commandline/command/ps.rst b/docs/sources/commandline/command/ps.rst new file mode 100644 index 0000000000..f73177918b --- /dev/null +++ b/docs/sources/commandline/command/ps.rst @@ -0,0 +1,13 @@ +========================= +``ps`` -- List containers +========================= + +:: + + Usage: docker ps [OPTIONS] + + List containers + + -a=false: Show all containers. Only running containers are shown by default. + -notrunc=false: Don't truncate output + -q=false: Only display numeric IDs diff --git a/docs/sources/commandline/command/pull.rst b/docs/sources/commandline/command/pull.rst new file mode 100644 index 0000000000..1c417ddcde --- /dev/null +++ b/docs/sources/commandline/command/pull.rst @@ -0,0 +1,9 @@ +========================================================================= +``pull`` -- Pull an image or a repository from the docker registry server +========================================================================= + +:: + + Usage: docker pull NAME + + Pull an image or a repository from the registry diff --git a/docs/sources/commandline/command/push.rst b/docs/sources/commandline/command/push.rst new file mode 100644 index 0000000000..a42296c715 --- /dev/null +++ b/docs/sources/commandline/command/push.rst @@ -0,0 +1,9 @@ +======================================================================= +``push`` -- Push an image or a repository to the docker registry server +======================================================================= + +:: + + Usage: docker push NAME + + Push an image or a repository to the registry diff --git a/docs/sources/commandline/command/restart.rst b/docs/sources/commandline/command/restart.rst new file mode 100644 index 0000000000..24bba5a5a9 --- /dev/null +++ b/docs/sources/commandline/command/restart.rst @@ -0,0 +1,9 @@ +========================================== +``restart`` -- Restart a running container +========================================== + +:: + + Usage: docker restart [OPTIONS] NAME + + Restart a running container diff --git a/docs/sources/commandline/command/rm.rst b/docs/sources/commandline/command/rm.rst new file mode 100644 index 0000000000..f6d6893bfb --- /dev/null +++ b/docs/sources/commandline/command/rm.rst @@ -0,0 +1,9 @@ +============================ +``rm`` -- Remove a container +============================ + +:: + + Usage: docker rm [OPTIONS] CONTAINER + + Remove a container diff --git a/docs/sources/commandline/command/rmi.rst b/docs/sources/commandline/command/rmi.rst new file mode 100644 index 0000000000..3761196f23 --- /dev/null +++ b/docs/sources/commandline/command/rmi.rst @@ -0,0 +1,9 @@ +========================== +``rmi`` -- Remove an image +========================== + +:: + + Usage: docker rmimage [OPTIONS] IMAGE + + Remove an image diff --git a/docs/sources/commandline/command/run.rst b/docs/sources/commandline/command/run.rst new file mode 100644 index 0000000000..d5e571b41b --- /dev/null +++ b/docs/sources/commandline/command/run.rst @@ -0,0 +1,22 @@ +=========================================== +``run`` -- Run a command in a new container +=========================================== + +:: + + Usage: docker run [OPTIONS] IMAGE COMMAND [ARG...] + + Run a command in a new container + + -a=map[]: Attach to stdin, stdout or stderr. + -d=false: Detached mode: leave the container running in the background + -e=[]: Set environment variables + -h="": Container host name + -i=false: Keep stdin open even if not attached + -m=0: Memory limit (in bytes) + -p=[]: Map a network port to the container + -t=false: Allocate a pseudo-tty + -u="": Username or UID + -d=[]: Set custom dns servers for the container + -v=[]: Creates a new volumes and mount it at the specified path. + -volumes-from="": Mount all volumes from the given container. diff --git a/docs/sources/commandline/command/search.rst b/docs/sources/commandline/command/search.rst new file mode 100644 index 0000000000..0af24dfaf5 --- /dev/null +++ b/docs/sources/commandline/command/search.rst @@ -0,0 +1,10 @@ +=================================================================== +``search`` -- Search for an image in the docker index +=================================================================== + +:: + + Usage: docker search TERM + + Searches for the TERM parameter on the Docker index and prints out a list of repositories + that match. diff --git a/docs/sources/commandline/command/start.rst b/docs/sources/commandline/command/start.rst new file mode 100644 index 0000000000..df415ca3d3 --- /dev/null +++ b/docs/sources/commandline/command/start.rst @@ -0,0 +1,9 @@ +====================================== +``start`` -- Start a stopped container +====================================== + +:: + + Usage: docker start [OPTIONS] NAME + + Start a stopped container diff --git a/docs/sources/commandline/command/stop.rst b/docs/sources/commandline/command/stop.rst new file mode 100644 index 0000000000..df6d66ccf9 --- /dev/null +++ b/docs/sources/commandline/command/stop.rst @@ -0,0 +1,9 @@ +==================================== +``stop`` -- Stop a running container +==================================== + +:: + + Usage: docker stop [OPTIONS] NAME + + Stop a running container diff --git a/docs/sources/commandline/command/tag.rst b/docs/sources/commandline/command/tag.rst new file mode 100644 index 0000000000..59647355e9 --- /dev/null +++ b/docs/sources/commandline/command/tag.rst @@ -0,0 +1,11 @@ +========================================= +``tag`` -- Tag an image into a repository +========================================= + +:: + + Usage: docker tag [OPTIONS] IMAGE REPOSITORY [TAG] + + Tag an image into a repository + + -f=false: Force diff --git a/docs/sources/commandline/command/version.rst b/docs/sources/commandline/command/version.rst new file mode 100644 index 0000000000..eedf02f2d0 --- /dev/null +++ b/docs/sources/commandline/command/version.rst @@ -0,0 +1,3 @@ +================================================== +``version`` -- Show the docker version information +================================================== diff --git a/docs/sources/commandline/command/wait.rst b/docs/sources/commandline/command/wait.rst new file mode 100644 index 0000000000..2959bf880b --- /dev/null +++ b/docs/sources/commandline/command/wait.rst @@ -0,0 +1,9 @@ +=================================================================== +``wait`` -- Block until a container stops, then print its exit code +=================================================================== + +:: + + Usage: docker wait [OPTIONS] NAME + + Block until a container stops, then print its exit code. diff --git a/docs/sources/concepts/containers.rst b/docs/sources/concepts/containers.rst index f432c4363d..8378a7e29f 100644 --- a/docs/sources/concepts/containers.rst +++ b/docs/sources/concepts/containers.rst @@ -5,124 +5,4 @@ :note: This version of the introduction is temporary, just to make sure we don't break the links from the website when the documentation is updated - -Introduction -============ - -Docker - The Linux container runtime ------------------------------------- - -Docker complements LXC with a high-level API which operates at the process level. It runs unix processes with strong guarantees of isolation and repeatability across servers. - -Docker is a great building block for automating distributed systems: large-scale web deployments, database clusters, continuous deployment systems, private PaaS, service-oriented architectures, etc. - - -- **Heterogeneous payloads** Any combination of binaries, libraries, configuration files, scripts, virtualenvs, jars, gems, tarballs, you name it. No more juggling between domain-specific tools. Docker can deploy and run them all. -- **Any server** Docker can run on any x64 machine with a modern linux kernel - whether it's a laptop, a bare metal server or a VM. This makes it perfect for multi-cloud deployments. -- **Isolation** docker isolates processes from each other and from the underlying host, using lightweight containers. -- **Repeatability** Because containers are isolated in their own filesystem, they behave the same regardless of where, when, and alongside what they run. - - - -What is a Standard Container? ------------------------------ - -Docker defines a unit of software delivery called a Standard Container. The goal of a Standard Container is to encapsulate a software component and all its dependencies in -a format that is self-describing and portable, so that any compliant runtime can run it without extra dependency, regardless of the underlying machine and the contents of the container. - -The spec for Standard Containers is currently work in progress, but it is very straightforward. It mostly defines 1) an image format, 2) a set of standard operations, and 3) an execution environment. - -A great analogy for this is the shipping container. Just like Standard Containers are a fundamental unit of software delivery, shipping containers (http://bricks.argz.com/ins/7823-1/12) are a fundamental unit of physical delivery. - -Standard operations -~~~~~~~~~~~~~~~~~~~ - -Just like shipping containers, Standard Containers define a set of STANDARD OPERATIONS. Shipping containers can be lifted, stacked, locked, loaded, unloaded and labelled. Similarly, standard containers can be started, stopped, copied, snapshotted, downloaded, uploaded and tagged. - - -Content-agnostic -~~~~~~~~~~~~~~~~~~~ - -Just like shipping containers, Standard Containers are CONTENT-AGNOSTIC: all standard operations have the same effect regardless of the contents. A shipping container will be stacked in exactly the same way whether it contains Vietnamese powder coffee or spare Maserati parts. Similarly, Standard Containers are started or uploaded in the same way whether they contain a postgres database, a php application with its dependencies and application server, or Java build artifacts. - - -Infrastructure-agnostic -~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Both types of containers are INFRASTRUCTURE-AGNOSTIC: they can be transported to thousands of facilities around the world, and manipulated by a wide variety of equipment. A shipping container can be packed in a factory in Ukraine, transported by truck to the nearest routing center, stacked onto a train, loaded into a German boat by an Australian-built crane, stored in a warehouse at a US facility, etc. Similarly, a standard container can be bundled on my laptop, uploaded to S3, downloaded, run and snapshotted by a build server at Equinix in Virginia, uploaded to 10 staging servers in a home-made Openstack cluster, then sent to 30 production instances across 3 EC2 regions. - - -Designed for automation -~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Because they offer the same standard operations regardless of content and infrastructure, Standard Containers, just like their physical counterpart, are extremely well-suited for automation. In fact, you could say automation is their secret weapon. - -Many things that once required time-consuming and error-prone human effort can now be programmed. Before shipping containers, a bag of powder coffee was hauled, dragged, dropped, rolled and stacked by 10 different people in 10 different locations by the time it reached its destination. 1 out of 50 disappeared. 1 out of 20 was damaged. The process was slow, inefficient and cost a fortune - and was entirely different depending on the facility and the type of goods. - -Similarly, before Standard Containers, by the time a software component ran in production, it had been individually built, configured, bundled, documented, patched, vendored, templated, tweaked and instrumented by 10 different people on 10 different computers. Builds failed, libraries conflicted, mirrors crashed, post-it notes were lost, logs were misplaced, cluster updates were half-broken. The process was slow, inefficient and cost a fortune - and was entirely different depending on the language and infrastructure provider. - - -Industrial-grade delivery -~~~~~~~~~~~~~~~~~~~~~~~~~~ - -There are 17 million shipping containers in existence, packed with every physical good imaginable. Every single one of them can be loaded on the same boats, by the same cranes, in the same facilities, and sent anywhere in the World with incredible efficiency. It is embarrassing to think that a 30 ton shipment of coffee can safely travel half-way across the World in *less time* than it takes a software team to deliver its code from one datacenter to another sitting 10 miles away. - -With Standard Containers we can put an end to that embarrassment, by making INDUSTRIAL-GRADE DELIVERY of software a reality. - - -Standard Container Specification -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -(TODO) - -Image format -~~~~~~~~~~~~ - -Standard operations -~~~~~~~~~~~~~~~~~~~ - -- Copy -- Run -- Stop -- Wait -- Commit -- Attach standard streams -- List filesystem changes -- ... - -Execution environment -~~~~~~~~~~~~~~~~~~~~~ - -Root filesystem -^^^^^^^^^^^^^^^ - -Environment variables -^^^^^^^^^^^^^^^^^^^^^ - -Process arguments -^^^^^^^^^^^^^^^^^ - -Networking -^^^^^^^^^^ - -Process namespacing -^^^^^^^^^^^^^^^^^^^ - -Resource limits -^^^^^^^^^^^^^^^ - -Process monitoring -^^^^^^^^^^^^^^^^^^ - -Logging -^^^^^^^ - -Signals -^^^^^^^ - -Pseudo-terminal allocation -^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Security -^^^^^^^^ - +This document has been moved to :ref:`introduction`, please update your bookmarks. \ No newline at end of file diff --git a/docs/sources/concepts/introduction.rst b/docs/sources/concepts/introduction.rst index 46698b4015..b7e1b04f05 100644 --- a/docs/sources/concepts/introduction.rst +++ b/docs/sources/concepts/introduction.rst @@ -2,7 +2,7 @@ :description: An introduction to docker and standard containers? :keywords: containers, lxc, concepts, explanation - +.. _introduction: Introduction ============ diff --git a/docs/website/dotcloud.yml b/docs/website/dotcloud.yml new file mode 100644 index 0000000000..5a8f50f9e9 --- /dev/null +++ b/docs/website/dotcloud.yml @@ -0,0 +1,2 @@ +www: + type: static \ No newline at end of file diff --git a/docs/website/gettingstarted/index.html b/docs/website/gettingstarted/index.html new file mode 100644 index 0000000000..c005cfc9f9 --- /dev/null +++ b/docs/website/gettingstarted/index.html @@ -0,0 +1,210 @@ + + + + + + + + + + Docker - the Linux container runtime + + + + + + + + + + + + + + + + + + + + +
+
+
+ +
+ + + +
+ +
+ +
+
+
+
+ + +
+
+

GETTING STARTED

+
+
+ +
+ +
+
+ Docker is still under heavy development. It should not yet be used in production. Check the repo for recent progress. +
+
+
+
+

+ + Installing on Ubuntu

+ +

Requirements

+
    +
  • Ubuntu 12.04 (LTS) (64-bit)
    • +
  • or Ubuntu 12.10 (quantal) (64-bit)
    • +
+
    +
  1. +

    Install dependencies

    + The linux-image-extra package is only needed on standard Ubuntu EC2 AMIs in order to install the aufs kernel module. + 
    sudo apt-get install linux-image-extra-`uname -r`
    + + +
    2. +
  2. +

    Install Docker

    +

    Add the Ubuntu PPA (Personal Package Archive) sources to your apt sources list, update and install.

    +

    You may see some warnings that the GPG keys cannot be verified.

    +
    + 
    sudo sh -c "echo 'deb http://ppa.launchpad.net/dotcloud/lxc-docker/ubuntu precise main' >> /etc/apt/sources.list"
    + 
    sudo apt-get update
    + 
    sudo apt-get install lxc-docker
    +
    + + +
    3. + +
  3. +

    Run!

    + +
    + 
    docker run -i -t ubuntu /bin/bash
    +
    +
    4. + Continue with the Hello world example. +
+
+ +
+

Contributing to Docker

+ +

Want to hack on Docker? Awesome! We have some instructions to get you started. They are probably not perfect, please let us know if anything feels wrong or incomplete.

+
+ +
+
+
+

Quick install on other operating systems

+

For other operating systems we recommend and provide a streamlined install with virtualbox, + vagrant and an Ubuntu virtual machine.

+ + + +
+ +
+

More resources

+ +
+ + +
+
+ Fill out my online form. +
+ +
+ +
+
+
+ + +
+
+
+ +
+ +
+
+ +
+
+ +
+
+ + + + + + + + + + + diff --git a/docs/website/index.html b/docs/website/index.html new file mode 100644 index 0000000000..90de706881 --- /dev/null +++ b/docs/website/index.html @@ -0,0 +1,314 @@ + + + + + + + + + + + Docker - the Linux container engine + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ +
+ + + +
+
+
+
+ + +
+
+ +
+
+ +
+
+ + +

The Linux container engine

+
+ +
+ +
+ Docker is an open-source engine which automates the deployment of applications as highly portable, self-sufficient containers which are independent of hardware, language, framework, packaging system and hosting provider. +
+ +
+ + + + +
+ +
+
+ +
+
+ +
+
+
+
+
+ +
+
+ +
+
+

Heterogeneous payloads

+

Any combination of binaries, libraries, configuration files, scripts, virtualenvs, jars, gems, tarballs, you name it. No more juggling between domain-specific tools. Docker can deploy and run them all.

+

Any server

+

Docker can run on any x64 machine with a modern linux kernel - whether it's a laptop, a bare metal server or a VM. This makes it perfect for multi-cloud deployments.

+

Isolation

+

Docker isolates processes from each other and from the underlying host, using lightweight containers.

+

Repeatability

+

Because each container is isolated in its own filesystem, they behave the same regardless of where, when, and alongside what they run.

+
+
+
+
+

New! Docker Index

+ On the Docker Index you can find and explore pre-made container images. It allows you to share your images and download them. + +

+ +
+ DOCKER index +
+ +   + + +
+
+
+ Fill out my online form. +
+ +
+
+
+ +
+ + + + +
+
+
+
+ + John Willis @botchagalupe: IMHO docker is to paas what chef was to Iaas 4 years ago +
+
+
+
+ + John Feminella ‏@superninjarobot: So, @getdocker is pure excellence. If you've ever wished for arbitrary, PaaS-agnostic, lxc/aufs Linux containers, this is your jam! +
+
+
+
+
+
+ + David Romulan ‏@destructuring: I haven't had this much fun since AWS +
+
+
+
+ + Ricardo Gladwell ‏@rgladwell: wow @getdocker is either amazing or totally stupid +
+
+ +
+
+ +
+
+
+ +
+ +

Notable features

+ +
    +
  • Filesystem isolation: each process container runs in a completely separate root filesystem.
    • +
  • Resource isolation: system resources like cpu and memory can be allocated differently to each process container, using cgroups.
    • +
  • Network isolation: each process container runs in its own network namespace, with a virtual interface and IP address of its own.
    • +
  • Copy-on-write: root filesystems are created using copy-on-write, which makes deployment extremeley fast, memory-cheap and disk-cheap.
    • +
  • Logging: the standard streams (stdout/stderr/stdin) of each process container is collected and logged for real-time or batch retrieval.
    • +
  • Change management: changes to a container's filesystem can be committed into a new image and re-used to create more containers. No templating or manual configuration required.
    • +
  • Interactive shell: docker can allocate a pseudo-tty and attach to the standard input of any container, for example to run a throwaway interactive shell.
    • +
+ +

Under the hood

+ +

Under the hood, Docker is built on the following components:

+ +
    +
  • The cgroup and namespacing capabilities of the Linux kernel;
    • +
  • AUFS, a powerful union filesystem with copy-on-write capabilities;
    • +
  • The Go programming language;
    • +
  • lxc, a set of convenience scripts to simplify the creation of linux containers.
    • +
+ +

Who started it

+

+ Docker is an open-source implementation of the deployment engine which powers dotCloud, a popular Platform-as-a-Service.

+ +

It benefits directly from the experience accumulated over several years of large-scale operation and support of hundreds of thousands + of applications and databases. +

+ +
+
+ +
+ + +
+

Twitter

+ + +
+ +
+
+ +
+ + +
+
+
+
+ + Docker is a project by dotCloud + +
+
+ +
+
+ +
+
+ +
+
+ + + + + + + + + + + + diff --git a/docs/website/nginx.conf b/docs/website/nginx.conf new file mode 100644 index 0000000000..97ffd2c0e5 --- /dev/null +++ b/docs/website/nginx.conf @@ -0,0 +1,6 @@ + +# rule to redirect original links created when hosted on github pages +rewrite ^/documentation/(.*).html http://docs.docker.io/en/latest/$1/ permanent; + +# rewrite the stuff which was on the current page +rewrite ^/gettingstarted.html$ /gettingstarted/ permanent; diff --git a/docs/website/static b/docs/website/static new file mode 120000 index 0000000000..95bc97aa10 --- /dev/null +++ b/docs/website/static @@ -0,0 +1 @@ +../theme/docker/static \ No newline at end of file