Merge pull request #878 from moxiegirl/877-updates-install

Update installation for Toolbox
This commit is contained in:
moxiegirl 2015-07-31 12:03:08 -07:00
commit 2f792ce800
5 changed files with 82 additions and 63 deletions

View File

@ -1,30 +1,27 @@
FROM docs/base:hugo FROM docs/base:latest
MAINTAINER Mary Anthony <mary@docker.com> (@moxiegirl) MAINTAINER Mary Anthony <mary@docker.com> (@moxiegirl)
# to get the git info for this repo # To get the git info for this repo
COPY . /src COPY . /src
COPY . /docs/content/kitematic/ COPY . /docs/content/kitematic/
RUN svn checkout https://github.com/docker/compose/trunk/docs /docs/content/compose
RUN svn checkout https://github.com/docker/docker/trunk/docs /docs/content/docker
RUN svn checkout https://github.com/docker/swarm/trunk/docs /docs/content/swarm
RUN svn checkout https://github.com/docker/distribution/trunk/docs /docs/content/registry
RUN svn checkout https://github.com/docker/tutorials/trunk/docs /docs/content
RUN svn checkout https://github.com/docker/opensource/trunk/docs /docs/content/opensource
RUN svn checkout https://github.com/docker/machine/trunk/docs /docs/content/machine
# Sed to process GitHub Markdown # Sed to process GitHub Markdown
# 1-2 Remove comment code from metadata block # 1-2 Remove comment code from metadata block
# 3 Change ](/word to ](/project/ in links # 3 Change ](/word to ](/project/ in links
# 4 Change ](word.md) to ](/project/word) # 4 Change ](word.md) to ](/project/word)
# 5 Remove .md extension from link text # 5 Remove .md extension from link text
# 6 Change ](./ to ](/project/word) # 6 Change ](../ to ](/project/word)
# 7 Change ](../../ to ](/project/ # 7 Change ](../../ to ](/project/ --> not implemented
# 8 Change ](../ to ](/project/
# 9 Change ](# to ](/project/
# #
RUN find /docs/content/kitematic -type f -name "*.md" -exec sed -i.old \ #
-e '/^<!.*metadata]>/g' \ RUN /src/pre-process.sh /docs
-e '/^<!.*end-metadata.*>/g' \
-e 's/\(\]\)\([(]\)\(\/\)/\1\2\/kitematic\//g' \
-e 's/\(\][(]\)\([A-z].*\)\(\.md\)/\1\/kitematic\/\2/g' \
-e 's/\([(]\)\(.*\)\(\.md\)/\1\2/g' \
-e 's/\(\][(]\)\(\.\/\)/\1\/kitematic\//g' \
-e 's/\(\][(]\)\(\.\.\/\.\.\/\)/\1\/kitematic\//g' \
-e 's/\(\][(]\)\(\.\.\/\)/\1\/kitematic\//g' {} \;

View File

@ -31,10 +31,8 @@ the Docker Remote API.
### Which platforms does Kitematic support? ### Which platforms does Kitematic support?
Right now Kitematic only works on Mac OS X. That said, Windows is on the Right now Kitematic works on Mac OS X and Windows. Linux is planned in the future. Review our product
short-term [roadmap](https://github.com/kitematic/kitematic/blob/master/ROADMAP.md) for more information.
[roadmap](https://github.com/kitematic/kitematic/blob/master/ROADMAP.md) (coming
soon!) and a Linux version is in high demand.
### Why does Kitematic collect usage analytics and bug reports? ### Why does Kitematic collect usage analytics and bug reports?

View File

@ -9,45 +9,8 @@ weight=2
+++ +++
<![end-metadata]--> <![end-metadata]-->
# Kitematic: Install Kitematic # Kitematic
You install Kitematic much the same way you install any application on a Mac or Kitematic, the Docker GUI, runs on Mac OS X and Windows operating systems. Beginning with the 1.8 Docker release, you use the Docker Toolbox to install Kitematic. See the [Mac OS X installation guide]({{% thebaseurl %}}mac) or the [Windows installation guide]({{% thebaseurl %}}installation/windows) for details on installing with Docker Toolbox.
Windows PC: download an image and run an installer.
## Download Kitematic For information about using Kitematic, take a look at the [User Guide](userguide).
[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
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
download and install the latest version.
![Installing](../images/installing.png)
All Done! Within a minute you should be ready to start running your first
container!
![containers](../images/containers.png)
## Technical Details
Kitematic is a self-contained .app, with an exception:
- It will install VirtualBox if it's not already installed.
### Why does Kitematic need my root password?
Kitematic needs your root password for two reasons:
- Installing VirtualBox requires root access as it includes Mac OS X kernel extensions.
- 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).

61
docs/pre-process.sh Executable file
View File

@ -0,0 +1,61 @@
#!/bin/bash -e
# Populate an array with just docker dirs and one with content dirs
docker_dir=(`ls -d /docs/content/docker/*`)
content_dir=(`ls -d /docs/content/*`)
# Loop content not of docker/
#
# Sed to process GitHub Markdown
# 1-2 Remove comment code from metadata block
# 3 Remove .md extension from link text
# 4 Change ](/ to ](/project/ in links
# 5 Change ](word) to ](/project/word)
# 6 Change ](../../ to ](/project/
# 7 Change ](../ to ](/project/word)
#
for i in "${content_dir[@]}"
do
:
case $i in
"/docs/content/windows")
;;
"/docs/content/mac")
;;
"/docs/content/linux")
;;
"/docs/content/docker")
y=${i##*/}
find $i -type f -name "*.md" -exec sed -i.old \
-e '/^<!.*metadata]>/g' \
-e '/^<!.*end-metadata.*>/g' {} \;
;;
*)
y=${i##*/}
find $i -type f -name "*.md" -exec sed -i.old \
-e '/^<!.*metadata]>/g' \
-e '/^<!.*end-metadata.*>/g' \
-e 's/\(\]\)\([(]\)\(\/\)/\1\2\/'$y'\//g' \
-e 's/\(\][(]\)\([A-z].*\)\(\.md\)/\1\/'$y'\/\2/g' \
-e 's/\([(]\)\(.*\)\(\.md\)/\1\2/g' \
-e 's/\(\][(]\)\(\.\/\)/\1\/'$y'\//g' \
-e 's/\(\][(]\)\(\.\.\/\.\.\/\)/\1\/'$y'\//g' \
-e 's/\(\][(]\)\(\.\.\/\)/\1\/'$y'\//g' {} \;
;;
esac
done
#
# Move docker directories to content
#
for i in "${docker_dir[@]}"
do
:
if [ -d $i ]
then
mv $i /docs/content/
fi
done
rm -rf /docs/content/docker

View File

@ -16,7 +16,7 @@ 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 Docker on a Mac or Windows (coming soon) PC. Kitematic automates the Docker
installation and setup process and provides an intuitive graphical user installation and setup process and provides an intuitive graphical user
interface (GUI) for running Docker containers. Kitematic integrates with interface (GUI) for running Docker containers. Kitematic integrates with
[Docker Machine](http://docs.docker.com/machine/) to provision a VirtualBox VM [Docker Machine]({{% thebaseurl %}}machine/) to provision a VirtualBox VM
and install the Docker Engine locally on your machine. 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