docker
/
docs
mirror of https://github.com/docker/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fix some typos and minor grammatical issues

This commit is contained in:
Razzi Abuissa 2015-07-14 11:06:05 -07:00
parent 19d53e58dc
commit 0c0bb49154
1 changed files with 15 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
docs/userguide.md
View File

@ -2,7 +2,7 @@
+++ +++
title = "Kitematic User Guide: Intro & Overview" title = "Kitematic User Guide: Intro & Overview"
description = "Documentation that provides an overview of Kitematic and installation instructions" description = "Documentation that provides an overview of Kitematic and installation instructions"
keywords = ["docker, documentation, about, technology, kitematic, gui"] keywords = ["docker, documentation, about, technology, kitematic, gui"]
[menu.main] [menu.main]
parent="smn_workw_kitematic" parent="smn_workw_kitematic"
+++ +++
@ -21,7 +21,7 @@ and install the Docker Engine locally on your machine.
Once installed, the Kitematic GUI launches and from the home screen you will be 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 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. 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 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 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 the GUI. Kitematic also automates advanced features such as managing ports
@ -78,17 +78,17 @@ The currently detected "web" ports are, `80`, `8000`, `8080`, `3000`, `5000`,
### Viewing container logs ### Viewing container logs
You can view the entire main container process' log output either by cicking on the "Logs" You can view the entire main container process' log output either by clicking on the "Logs"
preview image, or by clicking on the "Logs" tab. preview image, or by clicking on the "Logs" tab.
You can then scroll through the logs from the current running container. Note that 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, if you make changes to the container settings, then the container will be restarted,
so will reset this log view. so this will reset this log view.
### Starting a terminal in a container ### Starting a terminal in a container
The "Terminal" icon at the top of the container summary will `docker exec sh <your 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. This will allow you to make quick changes, or to debug a problem.
> **Note**: Your exec'ed `sh` process will not have the same environment settings > **Note**: Your exec'ed `sh` process will not have the same environment settings
> as the main container process and its children. > as the main container process and its children.
@ -117,7 +117,7 @@ use the default directory created for the website_files volume. Instead, you
already have the HTML, Javascript, and CSS for your website under already have the HTML, Javascript, and CSS for your website under
`~/workspace/website`. `~/workspace/website`.
Navigate to the "Settings" tab of the container, and goto the "Volumes". This Navigate to the "Settings" tab of the container, and go to the "Volumes". This
screen allows you to set the mappings individually. screen allows you to set the mappings individually.
![screen shot 2015-02-28 at 2 48 01 pm](../images/change-folder.png) ![screen shot 2015-02-28 at 2 48 01 pm](../images/change-folder.png)
@ -142,12 +142,12 @@ 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 "Settings" tab allows you to add and modify the environment variables used to
start a container. start a container.
The list of Environment variables will show any that have been set on the image 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. metadata - for example, using the `ENV` instruction in the Dockerfile.
<TODO: image of the jenkins container> <TODO: image of the jenkins container>
Wen you "Save" the changed environment variables, the container will be stopped When you "Save" the changed environment variables, the container will be stopped,
removed and re-created. removed and re-created.
### Delete container ### Delete container
@ -155,14 +155,14 @@ removed and re-created.
On the "General" "Settings" tab, you can delete the container. Clicking "Delete On the "General" "Settings" tab, you can delete the container. Clicking "Delete
Container" will also stop the container if necessary. Container" will also stop the container if necessary.
You can also delete a container clicking the `X` icon in the container list. You can also delete a container by clicking the `X` icon in the container list.
Kitematic will prompt you to confirm that you want to delete. Kitematic will prompt you to confirm that you want to delete.
#### List the exposed Ports and how to access them #### List the exposed Ports and how to access them
To see the complete list of exposed ports, go to "Settings" then "Ports". This 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 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 network port that you can access use to access that container from your OS X
system. system.
@ -172,7 +172,7 @@ 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 via the Docker Command Line Interface (CLI). Any changes you make on the CLI are
directly reflected in Kitematic. directly reflected in Kitematic.
To open a terminal via Kitematic, just press whale button at the bottom left, as To open a terminal via Kitematic, just press the whale button at the bottom left, as
shown below: shown below:
![CLI access button](../images/cli-access-button.png) ![CLI access button](../images/cli-access-button.png)
@ -185,9 +185,9 @@ will pull and run a new Redis container via the Docker CLI.
![Docker CLI terminal window](../images/cli-terminal.png) ![Docker CLI terminal window](../images/cli-terminal.png)
> **Note**: If you're creating containers from the commandline, use `docker run -d` > **Note**: If you're creating containers from the command line, use `docker run -d`
> so that Kitematic can re-create the container when settings are changed via the > 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. > Kitematic user interface. Containers started without `-d` will fail to re-start.
Now, go back to Kitematic. The Redis container should now be visible. Now, go back to Kitematic. The Redis container should now be visible.
@ -196,4 +196,4 @@ Now, go back to Kitematic. The Redis container should now be visible.
## Next Steps ## Next Steps
For an example using Kitematic to run a Minecraft server, take a look at For an example using Kitematic to run a Minecraft server, take a look at
the [Mincraft server](./minecraft-server.md) page. the [Minecraft server](./minecraft-server.md) page.