centersl/docker-docs
1
0
Fork 0
mirror of https://github.com/docker/docs.git synced 2026-03-27 14:28:47 +07:00
Code Issues Packages Projects Releases Wiki Activity

Separate out Install from User Guide

Browse Source 
Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>
This commit is contained in:
Sven Dowideit
2015-05-14 11:25:19 +00:00
parent 144b0c3c6f
commit c347d06193
11 changed files with 222 additions and 86 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
Makefile
View File

@@ -1,4 +1,9 @@
.PHONY: docs docs-shell docs-build
.PHONY: docs docs-shell docs-build run
# TODO: clearly need to note pre-req's - OSX and node installed? - see contributing docs
run:
npm install
npm run
# import the existing docs build cmds from docker/docker
DOCS_MOUNT := $(if $(DOCSDIR),-v $(CURDIR)/$(DOCSDIR):/$(DOCSDIR))

BIN
docs/assets/browse-images.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 162 KiB

5
docs/faq.md
View File

@@ -58,3 +58,8 @@ You can opt-out of this anytime via the in-app preferences.
We'd love to answer any more questions about this. Feel free to reach us at
kitematic@docker.com or to open an issue on GitHub.
## Next Steps
For information about known issues in the current release of Kitematic, take a
look at the [Known issues](./known-issues.md).

35
docs/index.md
View File

@@ -2,39 +2,18 @@ page_title: Kitematic User Guide: Intro & Overview
page_description: Documentation that provides an overview of Kitematic and installation instructions
page_keywords: docker, documentation, about, technology, kitematic, gui
# Welcome to Kitematic
## Overview
Kitematic is an open source project built to simplify and streamline using
Docker on a Mac or Windows (coming soon) PC. Kitematic automates the Docker
installation and setup process and provides an intuitive graphical user
interface (GUI) for running Docker containers. Kitematic integrates with
[Docker Machine](http://docs.docker.com/machine/) to provision a VirtualBox VM
and install the Docker Engine locally on your machine.
Once installed, the Kitematic GUI launches and from the home screen you will be
presented with curated images that you can run instantly. You can search for any
public images on Docker Hub from Kitematic just by typing in the search bar.
You can use the GUI to create, run and manage your containers just by clicking
on buttons. Kitematic allows you to switch back and forth between the Docker CLI
and the GUI. Kitematic also automates advanced features such as managing ports
and configuring volumes. You can use Kitematic to change environment variables,
stream logs, and single click terminal into your Docker container all from the
GUI.
## Installing Kitematic
# Installing Kitematic
You install Kitematic much the same way you install any application on a Mac or
Windows PC: download an image and run an installer.
### Download Kitematic
## Download Kitematic
[Download the Kitematic zip file](https://kitematic.com/download/), unzip the
file by double-clicking it, and then double-click the application to run it.
You'll probably also want to put the application in your Applications folder.
### Initial Setup
## Initial Setup
Opening Kitematic for the first time sets up everything you need to run Docker
containers. If you don't already have VirtualBox installed, Kitematic will
@@ -47,7 +26,7 @@ container!
![containers](./assets/containers.png)
### Technical Details
## Technical Details
Kitematic is a self-contained .app, with a two exceptions:
@@ -55,7 +34,7 @@ Kitematic is a self-contained .app, with a two exceptions:
- It copies the `docker` and `docker-machine` binaries to `/usr/local/bin` for
convenience.
#### Why does Kitematic need my root password?
### Why does Kitematic need my root password?
Kitematic needs your root password for two reasons:
@@ -63,3 +42,7 @@ Kitematic needs your root password for two reasons:
- Copying `docker` and `docker-machine` to `/usr/local/bin` may require root
permission if the default permissions for this directory have been changed
prior to installing Kitematic.
## Next Steps
For information about using Kitematic, take a look at the [User Guide](./userguide.md).

25
docs/managing-volumes.md
View File

@@ -1,25 +0,0 @@
page_title: Managing Volumes with Kitematic
page_description: Documentation explaining how Kitematic manages container volumes
page_keywords: docker, documentation, about, technology, kitematic, gui, volumes
# Managing Volumes
### Default Volume Directories
Every container created through Kitematic automatically has its volumes exposed
on your Mac, which means you can manage files in volumes via the Finder.
Kitematic exposes a container's volume data under `~/Kitematic/<container's name>/`.
Quick access to this folder (or directory) is available via the app:
![Accessing the volumes directory](../assets/volumes-dir.png)
### Changing Volume Directories
Let's say you have an Nginx webserver running via Kitematic (using the
`kitematic/hello-world-nginx` image on DockerHub). However, you don't want to
use the default directory created for the website_files volume. Instead, you
already have the HTML, Javascript, and CSS for your website under
`~/workspace/website`. Kitematic makes it easy to change the container's volume
to read from this directory instead of the default one created by Kitematic:
![screen shot 2015-02-28 at 2 48 01 pm](../assets/change-folder.png)

4
docs/minecraft-server.md
View File

@@ -61,3 +61,7 @@ Restart your container by clicking the "Restart" button.
Go back to your Minecraft client and join your server. The new map should load.
## Next Steps
For an example using Kitematic to run Nginx, take a look at the [Nginx web
server](./nginx-web-server.md) page.

6
docs/mkdocs.yml
View File

@@ -1,8 +1,8 @@
# Kitematic
- ['kitematic/index.md', 'User Guide', 'Kitematic']
- ['kitematic/managing-volumes.md', 'User Guide', '&nbsp;&nbsp;Managing Volumes']
- ['kitematic/using-docker-cli.md', 'User Guide', '&nbsp;&nbsp;Using the Docker commandline']
- ['kitematic/index.md', 'Installation', 'Kitematic on OS X']
- ['kitematic/userguide.md', 'User Guide', 'Kitematic']
- ['kitematic/minecraft-server.md', 'Examples', 'Kitematic: Minecraft server']
- ['kitematic/nginx-web-server.md', 'Examples', 'Kitematic: Ngnix web server']

7
docs/nginx-web-server.md
View File

@@ -18,7 +18,7 @@ Let's get to it!
#### Running the Nginx Web Server Container
First, if you haven't yet done so, [download and start
Kitematic](https://kitematic.com/download) . Once installed and running, the app
Kitematic](./index.md). Once installed and running, the app
should look like this:
![Nginx create](../assets/nginx-create.png)
@@ -73,3 +73,8 @@ button as shown below. Your Nginx container should now be serving 2048.
Kitematic automatically reveals Docker container volumes via directories on your
Mac. In this case you changed the container's volume data via the Finder to
serve a website we downloaded.
## Next Steps
For an example using Kitematic to run a Local RethinkDB database, take a look at
the [RethinkDB development Database](./rethinkdb-dev-database.md) example.

2
docs/rethinkdb-dev-database.md
View File

@@ -12,7 +12,7 @@ In this tutorial, you will:
### Setting up RethinkDB in Kitematic
First, if you haven't yet done so, [download and start
Kitematic](https://kitematic.com/download). Once open, the app should look like
Kitematic](./index.md). Once open, the app should look like
this:
![Rethink create button](../assets/rethink-create.png)

188
docs/userguide.md Executable file
View File

@@ -0,0 +1,188 @@
page_title: Kitematic User Guide: Intro & Overview
page_description: Documentation that provides an overview of Kitematic and installation instructions
page_keywords: docker, documentation, about, technology, kitematic, gui
# Kitematic user guide
## Overview
Kitematic is an open source project built to simplify and streamline using
Docker on a Mac or Windows (coming soon) PC. Kitematic automates the Docker
installation and setup process and provides an intuitive graphical user
interface (GUI) for running Docker containers. Kitematic integrates with
[Docker Machine](http://docs.docker.com/machine/) to provision a VirtualBox VM
and install the Docker Engine locally on your machine.
Once installed, the Kitematic GUI launches and from the home screen you will be
presented with curated images that you can run instantly. You can search for any
public images on Docker Hub from Kitematic just by typing in the search bar.
You can use the GUI to create, run and manage your containers just by clicking
on buttons. Kitematic allows you to switch back and forth between the Docker CLI
and the GUI. Kitematic also automates advanced features such as managing ports
and configuring volumes. You can use Kitematic to change environment variables,
stream logs, and single click terminal into your Docker container all from the
GUI.
First, if you haven't yet done so, [download and start
Kitematic](./index.md).
## Container list
Kitematic lists all running and stopped containers on the left side, underneath
the "New Container" link.
The container list includes all containers, even those not started by Kitematic,
giving you a quick over-view of the state of your Docker daemon.
You can click on any container to view its logs (the output of the PID-0 process),
restart, stop or exec `sh` in that container. See [Working with a
container](#working-with-a-container) for more details.
## Creating a new container
The "New Container" page lets you search for and select from images on the Docker Hub.
When you've found the image you want to run, you can click "Create" to pull, create,
and run the container.
![Nginx create](../assets/browse-images.png)
## Working with a container
If you select a non-running container, either stopped, or paused, you will be able to
"Restart" or "Stop" the container using the icons. You can also view the entire PID-0
output logs, and in the Settings section you can make changes which will be used if you
"Restart" this container.
By selecting a running container from the left list, you can see some state information
for your container - either a preview of the HTML output for a container that has a web
server, the PID-0 logs, and any container volumes that have been configured.
![Redis container in Kitematic](../assets/cli-redis-container.png)
The summary page will show different things depending on the image metadata. If
port 80 is `EXPOSED`, then Kitematic assumes its a web page, and will show a preview
of the site at `/`. If other ports are exposed, then it will show a list of those
ports, and the Docker daemon IP and port they are mapped to. If there are any `VOLUMES`,
then these will be shown. At minimum, the summary screen will show the PID-0 log output.
### Viewing container logs
You can view the entire PID-0 container log output either by cicking on the "Logs"
preview image, or by clicking on the "Logs" tab.
You can then scroll through the logs from the current running container. Note that
if you make changes to the container Settings, then the container will be restarted,
so will reset this log view.
### Starting a terminal in a container
The "Terminal" icon at the top of the container summary will `docker exec sh <your container>`.
This will allow you to make quick changes, or to debug a problem.
> **Note**: Your execed `sh` process will not have the same environment settings
> as the main PID-0 process and its children.
### Managing Volumes
You can choose to make all of a container's volumes mapped to directories on
on your Mac by clicking on the folders in the "Edit Files" section of the
container summary screen.
This allows you to manage files in volumes via the Finder.
Kitematic exposes a container's volume data under `~/Kitematic/<container's name>/`.
Quick access to this folder (or directory) is available via the app:
![Accessing the volumes directory](../assets/volumes-dir.png)
> **Note**: When you "Enable all volumes to edit files in Finder", the Docker
> container will be stopped, removed and re-created with the new `volumes`
> flag.
#### Changing Volume Directories
Let's say you have an Nginx webserver running via Kitematic (using the
`kitematic/hello-world-nginx` image on DockerHub). However, you don't want to
use the default directory created for the website_files volume. Instead, you
already have the HTML, Javascript, and CSS for your website under
`~/workspace/website`.
Navigate to the "Settings" tab of the container, and goto the "Volumes". This
screen allows you to set the mappings individually.
![screen shot 2015-02-28 at 2 48 01 pm](../assets/change-folder.png)
> **Note**: When you "Change Folders", the Docker
> container will be stopped, removed and re-created with the new `volumes`
> flag.
### Setting the container name
By default, Kitematic sets the container name to the same as the image name (or
with a `-<number>` if there are more than one.
To simplify administration, or when using container linking or volumes, you may
want to rename it.
> **Note**: When you rename the container it will be stopped, removed and
> re-created with the new name (due to the default volumes mapping).
### Adding Environment variables
Many images use environment variables to let you customise them. The "General"
"Settings" tab allows you to add and modify the environment variables used to
start a container.
The list of Environment variables will show any that have been set on the image
metadata - for example, using the `ENV` instruction in the Dockerfile.
<TODO: image of the jenkins container>
Wen you "Save" the changed environment variables, the container will be stopped
removed and re-created.
### Delete container
On the "General" "Settings" tab, you can delete the container. Clicking "Delete
Container" will also stop the container if necessary.
You can also delete a container clicking the `X` icon in the container list.
Kitematic will prompt you to confirm that you want to delete.
#### List the exposed Ports and how to access them
To see the complete list of exposed ports, go to "Settings" then "Ports". This
page lists all the container ports exposed, and the IP address and host only
network port that you can access use to access that container from your OS X
system.
## Docker Command-line Access
You can interact with existing containers in Kitematic or create new containers
via the Docker Command Line Interface (CLI). Any changes you make on the CLI are
directly reflected in Kitematic.
To open a terminal via Kitematic, just press whale button at the bottom left, as
shown below:
![CLI access button](../assets/cli-access-button.png)
### Example: Creating a new Redis container
Start by opening a Docker-CLI ready terminal by clicking the whale button as
described above. Once the terminal opens, enter `docker run -d -P redis`. This
will pull and run a new Redis container via the Docker CLI.
![Docker CLI terminal window](../assets/cli-terminal.png)
> **Note**: If you're creating containers from the commandline, use `docker run -d`
> so that Kitematic can re-create the container when settings are changed via the
> Kitematic user interface. containers started without `-d` will fail to re-start.
Now, go back to Kitematic. The Redis container should now be visible.
![Redis container in Kitematic](../assets/cli-redis-container.png)
## Next Steps
For an example using Kitematic to run a Minecraft server, take a look at
the [Mincraft server](./minecraft-server.md) page.

29
docs/using-docker-cli.md
View File

@@ -1,29 +0,0 @@
page_title: Accessing the Docker CLI in Kitematic
page_description: Documentation describing how to work on the Docker command line using Kitematic
page_keywords: docker, documentation, about, technology, kitematic, gui, cli,
# Docker Command-line Access
You can interact with existing containers in Kitematic or create new containers
via the Docker Command Line Interface (CLI). Any changes you make on the CLI are
directly reflected in Kitematic.
### Opening a Terminal for the Docker CLI
To open a terminal via Kitematic, just press whale button at the bottom left, as
shown below:
![CLI access button](../assets/cli-access-button.png)
### Example: Creating a new Redis container
Start by opening a Docker-CLI ready terminal by clicking the whale button as
described above. Once the terminal opens, enter `docker run -d -P redis`. This
will pull and run a new Redis container via the Docker CLI.
![Docker CLI terminal window](../assets/cli-terminal.png)
Now, go back to Kitematic. The Redis container should now be visible.
![Redis container in Kitematic](../assets/cli-redis-container.png)