mirror of https://github.com/docker/docs.git
Merge branch 'master' of github.com:kitematic/kitematic
Conflicts: Gruntfile.js
This commit is contained in:
commit
3294faa62e
63
Gruntfile.js
63
Gruntfile.js
|
|
@ -3,13 +3,8 @@ var execFile = require('child_process').execFile;
|
||||||
var packagejson = require('./package.json');
|
var packagejson = require('./package.json');
|
||||||
var electron = require('electron-prebuilt');
|
var electron = require('electron-prebuilt');
|
||||||
|
|
||||||
var dockerHostname = packagejson['docker-version'].indexOf('rc') !== -1 ? 'test.docker.com' : 'get.docker.com';
|
|
||||||
|
|
||||||
var WINDOWS_DOCKER_URL = 'https://' + dockerHostname + '/builds/Windows/x86_64/docker-' + packagejson['docker-version'] + '.exe';
|
|
||||||
var DARWIN_DOCKER_URL = 'https://' + dockerHostname + '/builds/Darwin/x86_64/docker-' + packagejson['docker-version'];
|
|
||||||
var WINDOWS_DOCKER_MACHINE_URL = 'https://github.com/docker/machine/releases/download/v' + packagejson['docker-machine-version'] + '/docker-machine_windows-amd64.exe';
|
var WINDOWS_DOCKER_MACHINE_URL = 'https://github.com/docker/machine/releases/download/v' + packagejson['docker-machine-version'] + '/docker-machine_windows-amd64.exe';
|
||||||
var DARWIN_DOCKER_MACHINE_URL = 'https://github.com/docker/machine/releases/download/v' + packagejson['docker-machine-version'] + '/docker-machine_darwin-amd64';
|
var DARWIN_DOCKER_MACHINE_URL = 'https://github.com/docker/machine/releases/download/v' + packagejson['docker-machine-version'] + '/docker-machine_darwin-amd64';
|
||||||
var DARWIN_COMPOSE_URL = 'https://github.com/docker/compose/releases/download/' + packagejson['docker-compose-version'] + '/docker-compose-Darwin-x86_64';
|
|
||||||
|
|
||||||
module.exports = function (grunt) {
|
module.exports = function (grunt) {
|
||||||
require('load-grunt-tasks')(grunt);
|
require('load-grunt-tasks')(grunt);
|
||||||
|
|
@ -143,20 +138,10 @@ module.exports = function (grunt) {
|
||||||
|
|
||||||
// docker binaries
|
// docker binaries
|
||||||
'download-binary': {
|
'download-binary': {
|
||||||
docker: {
|
|
||||||
version: packagejson['docker-version'],
|
|
||||||
binary: path.join('resources', 'docker'),
|
|
||||||
download: 'curl:docker'
|
|
||||||
},
|
|
||||||
'docker-machine': {
|
'docker-machine': {
|
||||||
version: packagejson['docker-machine-version'],
|
version: packagejson['docker-machine-version'],
|
||||||
binary: path.join('resources', 'docker-machine'),
|
binary: path.join('resources', 'docker-machine'),
|
||||||
download: 'curl:docker-machine'
|
download: 'curl:docker-machine'
|
||||||
},
|
|
||||||
'docker-compose': {
|
|
||||||
version: packagejson['docker-compose-version'],
|
|
||||||
binary: path.join('resources', 'docker-compose'),
|
|
||||||
download: 'curl:docker-compose'
|
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
|
||||||
|
|
@ -221,17 +206,9 @@ module.exports = function (grunt) {
|
||||||
|
|
||||||
// download binaries
|
// download binaries
|
||||||
curl: {
|
curl: {
|
||||||
docker: {
|
|
||||||
src: process.platform === 'win32' ? WINDOWS_DOCKER_URL : DARWIN_DOCKER_URL,
|
|
||||||
dest: process.platform === 'win32' ? path.join('resources', 'docker.exe') : path.join('resources', 'docker')
|
|
||||||
},
|
|
||||||
'docker-machine': {
|
'docker-machine': {
|
||||||
src: process.platform === 'win32' ? WINDOWS_DOCKER_MACHINE_URL : DARWIN_DOCKER_MACHINE_URL,
|
src: process.platform === 'win32' ? WINDOWS_DOCKER_MACHINE_URL : DARWIN_DOCKER_MACHINE_URL,
|
||||||
dest: process.platform === 'win32' ? path.join('resources', 'docker-machine.exe') : path.join('resources', 'docker-machine')
|
dest: process.platform === 'win32' ? path.join('resources', 'docker-machine.exe') : path.join('resources', 'docker-machine')
|
||||||
},
|
|
||||||
'docker-compose': {
|
|
||||||
src: DARWIN_COMPOSE_URL,
|
|
||||||
dest: 'resources/docker-compose'
|
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
|
||||||
|
|
@ -256,22 +233,6 @@ module.exports = function (grunt) {
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
|
||||||
// javascript
|
|
||||||
babel: {
|
|
||||||
options: {
|
|
||||||
sourceMap: 'inline',
|
|
||||||
blacklist: 'regenerator'
|
|
||||||
},
|
|
||||||
dist: {
|
|
||||||
files: [{
|
|
||||||
expand: true,
|
|
||||||
cwd: 'src/',
|
|
||||||
src: ['**/*.js'],
|
|
||||||
dest: 'build/',
|
|
||||||
}]
|
|
||||||
}
|
|
||||||
},
|
|
||||||
|
|
||||||
plistbuddy: {
|
plistbuddy: {
|
||||||
addBundleURLTypes: {
|
addBundleURLTypes: {
|
||||||
method: 'Add',
|
method: 'Add',
|
||||||
|
|
@ -307,6 +268,22 @@ module.exports = function (grunt) {
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
|
||||||
|
// javascript
|
||||||
|
babel: {
|
||||||
|
options: {
|
||||||
|
sourceMap: 'inline',
|
||||||
|
blacklist: 'regenerator'
|
||||||
|
},
|
||||||
|
dist: {
|
||||||
|
files: [{
|
||||||
|
expand: true,
|
||||||
|
cwd: 'src/',
|
||||||
|
src: ['**/*.js'],
|
||||||
|
dest: 'build/',
|
||||||
|
}]
|
||||||
|
}
|
||||||
|
},
|
||||||
|
|
||||||
shell: {
|
shell: {
|
||||||
electron: {
|
electron: {
|
||||||
command: electron + ' ' + 'build',
|
command: electron + ' ' + 'build',
|
||||||
|
|
@ -361,14 +338,10 @@ module.exports = function (grunt) {
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
if (process.platform === 'win32') {
|
grunt.registerTask('default', ['download-binary', 'newer:babel', 'less', 'newer:copy:dev', 'shell:electron', 'watchChokidar']);
|
||||||
grunt.registerTask('default', ['download-binary:docker', 'download-binary:docker-machine', 'newer:babel', 'less', 'newer:copy:dev', 'shell:electron', 'watchChokidar']);
|
|
||||||
} else {
|
|
||||||
grunt.registerTask('default', ['download-binary', 'newer:babel', 'less', 'newer:copy:dev', 'shell:electron', 'watchChokidar']);
|
|
||||||
}
|
|
||||||
|
|
||||||
if (process.platform === 'win32') {
|
if (process.platform === 'win32') {
|
||||||
grunt.registerTask('release', ['clean:release', 'download-binary:docker', 'download-binary:docker-machine', 'babel', 'less', 'copy:dev', 'electron:windows', 'copy:windows', 'rcedit:exes', 'prompt:create-windows-installer', 'create-windows-installer', 'rename:installer']);
|
grunt.registerTask('release', ['clean:release', 'download-binary', 'babel', 'less', 'copy:dev', 'electron:windows', 'copy:windows', 'rcedit:exes', 'prompt:create-windows-installer', 'create-windows-installer', 'rename:installer']);
|
||||||
} else {
|
} else {
|
||||||
grunt.registerTask('release', ['clean:release', 'download-binary', 'babel', 'less', 'copy:dev', 'electron:osx', 'copy:osx', 'plistbuddy', 'shell:sign', 'shell:zip']);
|
grunt.registerTask('release', ['clean:release', 'download-binary', 'babel', 'less', 'copy:dev', 'electron:osx', 'copy:osx', 'plistbuddy', 'shell:sign', 'shell:zip']);
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -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' {} \;
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -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?
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -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.
|
|
||||||
|
|
||||||

|
|
||||||
|
|
||||||
All Done! Within a minute you should be ready to start running your first
|
|
||||||
container!
|
|
||||||
|
|
||||||

|
|
||||||
|
|
||||||
## 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).
|
|
||||||
|
|
|
||||||
|
|
@ -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
|
||||||
|
|
||||||
|
|
@ -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
|
||||||
|
|
|
||||||
|
|
@ -22,9 +22,8 @@
|
||||||
"url": "http://www.apache.org/licenses/LICENSE-2.0.html"
|
"url": "http://www.apache.org/licenses/LICENSE-2.0.html"
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"docker-version": "1.8.0-rc1",
|
"docker-version": "1.8.0-rc2",
|
||||||
"docker-machine-version": "0.4.0-rc1",
|
"docker-machine-version": "0.4.0-rc2",
|
||||||
"docker-compose-version": "1.4.0rc2",
|
|
||||||
"electron-version": "0.27.2",
|
"electron-version": "0.27.2",
|
||||||
"virtualbox-version": "5.0.0",
|
"virtualbox-version": "5.0.0",
|
||||||
"virtualbox-filename": "VirtualBox-5.0.0.pkg",
|
"virtualbox-filename": "VirtualBox-5.0.0.pkg",
|
||||||
|
|
|
||||||
|
|
@ -1,8 +1,7 @@
|
||||||
#!/bin/bash
|
#!/bin/bash
|
||||||
|
|
||||||
DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
|
DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
|
||||||
PATH=$DIR:$PATH
|
CMD="clear && $*"
|
||||||
CMD="export PATH='$PATH' && clear && $*"
|
|
||||||
|
|
||||||
ITERM_EXISTS=`osascript <<EOF
|
ITERM_EXISTS=`osascript <<EOF
|
||||||
set doesExist to false
|
set doesExist to false
|
||||||
|
|
|
||||||
|
|
@ -73,7 +73,8 @@ var _steps = [{
|
||||||
|
|
||||||
var isoversion = machine.isoversion();
|
var isoversion = machine.isoversion();
|
||||||
var packagejson = util.packagejson();
|
var packagejson = util.packagejson();
|
||||||
if (!isoversion || util.compareVersions(isoversion, packagejson['docker-version']) < 0) {
|
var packagejsonVersion = packagejson['docker-version'].split('-')[0];
|
||||||
|
if (!isoversion || util.compareVersions(isoversion, packagejsonVersion) < 0) {
|
||||||
yield machine.start();
|
yield machine.start();
|
||||||
yield machine.upgrade();
|
yield machine.upgrade();
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -5,19 +5,17 @@ import fs from 'fs';
|
||||||
import util from './Util';
|
import util from './Util';
|
||||||
import resources from './ResourcesUtil';
|
import resources from './ResourcesUtil';
|
||||||
|
|
||||||
var NAME = 'docker-vm';
|
|
||||||
|
|
||||||
var DockerMachine = {
|
var DockerMachine = {
|
||||||
command: function () {
|
command: function () {
|
||||||
return resources.dockerMachine();
|
return resources.dockerMachine();
|
||||||
},
|
},
|
||||||
name: function () {
|
name: function () {
|
||||||
return NAME;
|
return 'docker-vm';
|
||||||
},
|
},
|
||||||
isoversion: function (machineName = this.name()) {
|
isoversion: function (machineName = this.name()) {
|
||||||
try {
|
try {
|
||||||
var data = fs.readFileSync(path.join(util.home(), '.docker', 'machine', 'machines', machineName, 'boot2docker-virtualbox.iso'), 'utf8');
|
var data = fs.readFileSync(path.join(util.home(), '.docker', 'machine', 'machines', machineName, 'boot2docker.iso'), 'utf8');
|
||||||
var match = data.match(/Docker v(\d+\.\d+\.\d+)/);
|
var match = data.match(/Boot2Docker-v(\d+\.\d+\.\d+)/);
|
||||||
if (match) {
|
if (match) {
|
||||||
return match[1];
|
return match[1];
|
||||||
} else {
|
} else {
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue