Skip to content

Commit 91476ba

Browse files
committed
Create gh-pages branch via GitHub
0 parents  commit 91476ba

7 files changed

Lines changed: 644 additions & 0 deletions

File tree

images/arrow-down.png

423 Bytes
Loading

images/octocat-small.png

570 Bytes
Loading

index.html

Lines changed: 133 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,133 @@
1+
<!doctype html>
2+
<html>
3+
<head>
4+
<meta charset="utf-8">
5+
<meta http-equiv="X-UA-Compatible" content="chrome=1">
6+
<title>Boot2docker by boot2docker</title>
7+
8+
<link rel="stylesheet" href="stylesheets/styles.css">
9+
<link rel="stylesheet" href="stylesheets/pygment_trac.css">
10+
<script src="javascripts/scale.fix.js"></script>
11+
<meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no">
12+
<!--[if lt IE 9]>
13+
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
14+
<![endif]-->
15+
</head>
16+
<body>
17+
<div class="wrapper">
18+
<header>
19+
<h1 class="header">Boot2docker</h1>
20+
<p class="header">Lightweight Linux for Docker</p>
21+
22+
<ul>
23+
<li class="download"><a class="buttons" href="https://github.com/boot2docker/boot2docker/zipball/master">Download ZIP</a></li>
24+
<li class="download"><a class="buttons" href="https://github.com/boot2docker/boot2docker/tarball/master">Download TAR</a></li>
25+
<li><a class="buttons github" href="https://github.com/boot2docker/boot2docker">View On GitHub</a></li>
26+
</ul>
27+
28+
<p class="header">This project is maintained by <a class="header name" href="https://github.com/boot2docker">boot2docker</a></p>
29+
30+
31+
</header>
32+
<section>
33+
<h1>
34+
<a name="boot2docker" class="anchor" href="#boot2docker"><span class="octicon octicon-link"></span></a>boot2docker</h1>
35+
36+
<p>boot2docker is a lightweight Linux distribution based on <a href="http://tinycorelinux.net">Tiny Core Linux</a> made specifically to run <a href="https://www.docker.io/">Docker</a> containers. It runs completely from RAM, weighs ~27MB and boots in ~5s (YMMV). The <a href="https://github.com/steeve/boot2docker/releases">ISO can be download here</a>.</p>
37+
38+
<p><a href="http://www.youtube.com/watch?v=QzfddDvNVv0&amp;hd=1"><img src="http://i.imgur.com/hIwudK3.gif" alt="boot2docker Demo Video"></a></p>
39+
40+
<p>See <a href="doc/FAQ.md">Frequently asked questions</a> for more details.</p>
41+
42+
<h2>
43+
<a name="features" class="anchor" href="#features"><span class="octicon octicon-link"></span></a>Features</h2>
44+
45+
<ul>
46+
<li>Kernel 3.12.1 with AUFS, Docker 0.8.0, LXC 0.8.0</li>
47+
<li>Container persistence via disk automount on <code>/var/lib/docker</code>
48+
</li>
49+
<li>SSH keys persistence via disk automount</li>
50+
</ul><h2>
51+
<a name="installation" class="anchor" href="#installation"><span class="octicon octicon-link"></span></a>Installation</h2>
52+
53+
<h4>
54+
<a name="osx" class="anchor" href="#osx"><span class="octicon octicon-link"></span></a>OSX</h4>
55+
56+
<pre><code>$ brew update
57+
$ brew install boot2docker
58+
</code></pre>
59+
60+
<h4>
61+
<a name="linuxunix-works-also-on-osx" class="anchor" href="#linuxunix-works-also-on-osx"><span class="octicon octicon-link"></span></a>Linux/Unix (works also on OSX)</h4>
62+
63+
<pre><code>$ curl https://raw.github.com/steeve/boot2docker/master/boot2docker &gt; boot2docker
64+
$ chmod +x boot2docker
65+
</code></pre>
66+
67+
<h2>
68+
<a name="how-to-use" class="anchor" href="#how-to-use"><span class="octicon octicon-link"></span></a>How to use</h2>
69+
70+
<p>boot2docker comes with a simple init script that leverage's VirtualBox's <code>VBoxManage</code>. You can start, stop and delete the VM right from the command line.</p>
71+
72+
<h4>
73+
<a name="initialize" class="anchor" href="#initialize"><span class="octicon octicon-link"></span></a>Initialize</h4>
74+
75+
<pre><code>$ boot2docker init
76+
</code></pre>
77+
78+
<h4>
79+
<a name="start-vm" class="anchor" href="#start-vm"><span class="octicon octicon-link"></span></a>Start vm</h4>
80+
81+
<pre><code>$ boot2docker up
82+
</code></pre>
83+
84+
<h2>
85+
<a name="advanced-usage" class="anchor" href="#advanced-usage"><span class="octicon octicon-link"></span></a>Advanced usage</h2>
86+
87+
<h4>
88+
<a name="port-forwarding--folder-sharing" class="anchor" href="#port-forwarding--folder-sharing"><span class="octicon octicon-link"></span></a>Port forwarding / folder sharing</h4>
89+
90+
<p>In order to use this features refer to <a href="https://github.com/steeve/boot2docker/blob/master/doc/WORKAROUNDS.md">this workarounds</a></p>
91+
92+
<h4>
93+
<a name="customize" class="anchor" href="#customize"><span class="octicon octicon-link"></span></a>Customize</h4>
94+
95+
<p>You can customise the values of <code>VM_NAME</code>, <code>DOCKER_PORT</code>, <code>SSH_HOST_PORT</code>, <code>VM_DISK</code>, <code>VM_DISK_SIZE</code>, <code>VM_MEM</code> and <code>BOOT2DOCKER_ISO</code> by setting them in <code>$HOME/.boot2docker/profile</code></p>
96+
97+
<h4>
98+
<a name="persist-data" class="anchor" href="#persist-data"><span class="octicon octicon-link"></span></a>Persist data</h4>
99+
100+
<p>If you want your containers to persist across reboots, attach an ext4 formatted disk with the label <code>boot2docker-data</code> (<code>mkfs.ext4 -L boot2docker-data /dev/sdX5</code>) to your VM, and boot2docker will automount it on <code>/mnt/sdX</code> and then softlink <code>/mnt/sdX/var/lib/docker</code> to <code>/var/lib/docker</code>. It will also persist the SSH keys of the machine.</p>
101+
102+
<h4>
103+
<a name="ssh-into-vm" class="anchor" href="#ssh-into-vm"><span class="octicon octicon-link"></span></a>SSH into VM</h4>
104+
105+
<pre><code>$ boot2docker ssh
106+
</code></pre>
107+
108+
<p>boot2docker auto logs in, but if you want to SSH into the machine, the credentials are:</p>
109+
110+
<pre><code>user: docker
111+
pass: tcuser
112+
</code></pre>
113+
114+
<h4>
115+
<a name="install-on-any-device" class="anchor" href="#install-on-any-device"><span class="octicon octicon-link"></span></a>Install on any device</h4>
116+
117+
<p>To 'install' the ISO onto an SD card, USB-Stick or even empty hard disk, you can
118+
use <code>dd if=boot2docker.iso of=/dev/sdX</code>.
119+
This will create the small boot partition, and install an MBR.</p>
120+
121+
<h4>
122+
<a name="build-your-own-boot2dockeriso" class="anchor" href="#build-your-own-boot2dockeriso"><span class="octicon octicon-link"></span></a>Build your own boot2docker.iso</h4>
123+
124+
<p>Goto <a href="doc/BUILD.md">How to build</a> for Documentation on how to build your own boot2docker ISO's.</p>
125+
</section>
126+
<footer>
127+
<p><small>Hosted on <a href="http://pages.github.com">GitHub Pages</a> using the Dinky theme</small></p>
128+
</footer>
129+
</div>
130+
<!--[if !IE]><script>fixScale(document);</script><![endif]-->
131+
132+
</body>
133+
</html>

javascripts/scale.fix.js

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
fixScale = function(doc) {
2+
3+
var addEvent = 'addEventListener',
4+
type = 'gesturestart',
5+
qsa = 'querySelectorAll',
6+
scales = [1, 1],
7+
meta = qsa in doc ? doc[qsa]('meta[name=viewport]') : [];
8+
9+
function fix() {
10+
meta.content = 'width=device-width,minimum-scale=' + scales[0] + ',maximum-scale=' + scales[1];
11+
doc.removeEventListener(type, fix, true);
12+
}
13+
14+
if ((meta = meta[meta.length - 1]) && addEvent in doc) {
15+
fix();
16+
scales = [.25, 1.6];
17+
doc[addEvent](type, fix, true);
18+
}
19+
20+
};

params.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{"name":"Boot2docker","tagline":"Lightweight Linux for Docker","body":"boot2docker\r\n===========\r\n\r\nboot2docker is a lightweight Linux distribution based on [Tiny Core Linux](http://tinycorelinux.net) made specifically to run [Docker](https://www.docker.io/) containers. It runs completely from RAM, weighs ~27MB and boots in ~5s (YMMV). The [ISO can be download here](https://github.com/steeve/boot2docker/releases).\r\n\r\n[![boot2docker Demo Video](http://i.imgur.com/hIwudK3.gif)](http://www.youtube.com/watch?v=QzfddDvNVv0&hd=1)\r\n\r\nSee [Frequently asked questions](doc/FAQ.md) for more details.\r\n\r\n## Features\r\n* Kernel 3.12.1 with AUFS, Docker 0.8.0, LXC 0.8.0\r\n* Container persistence via disk automount on `/var/lib/docker`\r\n* SSH keys persistence via disk automount\r\n\r\n\r\n## Installation\r\n\r\n#### OSX\r\n```\r\n$ brew update\r\n$ brew install boot2docker\r\n```\r\n\r\n#### Linux/Unix (works also on OSX)\r\n```\r\n$ curl https://raw.github.com/steeve/boot2docker/master/boot2docker > boot2docker\r\n$ chmod +x boot2docker\r\n```\r\n\r\n## How to use\r\nboot2docker comes with a simple init script that leverage's VirtualBox's `VBoxManage`. You can start, stop and delete the VM right from the command line.\r\n\r\n#### Initialize\r\n```\r\n$ boot2docker init\r\n```\r\n\r\n#### Start vm\r\n```\r\n$ boot2docker up\r\n```\r\n\r\n\r\n## Advanced usage\r\n\r\n#### Port forwarding / folder sharing\r\nIn order to use this features refer to [this workarounds](https://github.com/steeve/boot2docker/blob/master/doc/WORKAROUNDS.md)\r\n\r\n#### Customize\r\nYou can customise the values of `VM_NAME`, `DOCKER_PORT`, `SSH_HOST_PORT`, `VM_DISK`, `VM_DISK_SIZE`, `VM_MEM` and `BOOT2DOCKER_ISO` by setting them in ``$HOME/.boot2docker/profile``\r\n\r\n#### Persist data\r\nIf you want your containers to persist across reboots, attach an ext4 formatted disk with the label ``boot2docker-data`` (``mkfs.ext4 -L boot2docker-data /dev/sdX5``) to your VM, and boot2docker will automount it on `/mnt/sdX` and then softlink `/mnt/sdX/var/lib/docker` to `/var/lib/docker`. It will also persist the SSH keys of the machine.\r\n\r\n#### SSH into VM\r\n```\r\n$ boot2docker ssh\r\n```\r\nboot2docker auto logs in, but if you want to SSH into the machine, the credentials are:\r\n```\r\nuser: docker\r\npass: tcuser\r\n```\r\n\r\n\r\n#### Install on any device\r\nTo 'install' the ISO onto an SD card, USB-Stick or even empty hard disk, you can\r\nuse ``dd if=boot2docker.iso of=/dev/sdX``.\r\nThis will create the small boot partition, and install an MBR.\r\n\r\n\r\n#### Build your own boot2docker.iso\r\nGoto [How to build](doc/BUILD.md) for Documentation on how to build your own boot2docker ISO's.\r\n","google":"","note":"Don't delete this file! It's used internally to help with page regeneration."}

stylesheets/pygment_trac.css

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
.highlight { background: #ffffff; }
2+
.highlight .c { color: #999988; font-style: italic } /* Comment */
3+
.highlight .err { color: #a61717; background-color: #e3d2d2 } /* Error */
4+
.highlight .k { font-weight: bold } /* Keyword */
5+
.highlight .o { font-weight: bold } /* Operator */
6+
.highlight .cm { color: #999988; font-style: italic } /* Comment.Multiline */
7+
.highlight .cp { color: #999999; font-weight: bold } /* Comment.Preproc */
8+
.highlight .c1 { color: #999988; font-style: italic } /* Comment.Single */
9+
.highlight .cs { color: #999999; font-weight: bold; font-style: italic } /* Comment.Special */
10+
.highlight .gd { color: #000000; background-color: #ffdddd } /* Generic.Deleted */
11+
.highlight .gd .x { color: #000000; background-color: #ffaaaa } /* Generic.Deleted.Specific */
12+
.highlight .ge { font-style: italic } /* Generic.Emph */
13+
.highlight .gr { color: #aa0000 } /* Generic.Error */
14+
.highlight .gh { color: #999999 } /* Generic.Heading */
15+
.highlight .gi { color: #000000; background-color: #ddffdd } /* Generic.Inserted */
16+
.highlight .gi .x { color: #000000; background-color: #aaffaa } /* Generic.Inserted.Specific */
17+
.highlight .go { color: #888888 } /* Generic.Output */
18+
.highlight .gp { color: #555555 } /* Generic.Prompt */
19+
.highlight .gs { font-weight: bold } /* Generic.Strong */
20+
.highlight .gu { color: #800080; font-weight: bold; } /* Generic.Subheading */
21+
.highlight .gt { color: #aa0000 } /* Generic.Traceback */
22+
.highlight .kc { font-weight: bold } /* Keyword.Constant */
23+
.highlight .kd { font-weight: bold } /* Keyword.Declaration */
24+
.highlight .kn { font-weight: bold } /* Keyword.Namespace */
25+
.highlight .kp { font-weight: bold } /* Keyword.Pseudo */
26+
.highlight .kr { font-weight: bold } /* Keyword.Reserved */
27+
.highlight .kt { color: #445588; font-weight: bold } /* Keyword.Type */
28+
.highlight .m { color: #009999 } /* Literal.Number */
29+
.highlight .s { color: #d14 } /* Literal.String */
30+
.highlight .na { color: #008080 } /* Name.Attribute */
31+
.highlight .nb { color: #0086B3 } /* Name.Builtin */
32+
.highlight .nc { color: #445588; font-weight: bold } /* Name.Class */
33+
.highlight .no { color: #008080 } /* Name.Constant */
34+
.highlight .ni { color: #800080 } /* Name.Entity */
35+
.highlight .ne { color: #990000; font-weight: bold } /* Name.Exception */
36+
.highlight .nf { color: #990000; font-weight: bold } /* Name.Function */
37+
.highlight .nn { color: #555555 } /* Name.Namespace */
38+
.highlight .nt { color: #000080 } /* Name.Tag */
39+
.highlight .nv { color: #008080 } /* Name.Variable */
40+
.highlight .ow { font-weight: bold } /* Operator.Word */
41+
.highlight .w { color: #bbbbbb } /* Text.Whitespace */
42+
.highlight .mf { color: #009999 } /* Literal.Number.Float */
43+
.highlight .mh { color: #009999 } /* Literal.Number.Hex */
44+
.highlight .mi { color: #009999 } /* Literal.Number.Integer */
45+
.highlight .mo { color: #009999 } /* Literal.Number.Oct */
46+
.highlight .sb { color: #d14 } /* Literal.String.Backtick */
47+
.highlight .sc { color: #d14 } /* Literal.String.Char */
48+
.highlight .sd { color: #d14 } /* Literal.String.Doc */
49+
.highlight .s2 { color: #d14 } /* Literal.String.Double */
50+
.highlight .se { color: #d14 } /* Literal.String.Escape */
51+
.highlight .sh { color: #d14 } /* Literal.String.Heredoc */
52+
.highlight .si { color: #d14 } /* Literal.String.Interpol */
53+
.highlight .sx { color: #d14 } /* Literal.String.Other */
54+
.highlight .sr { color: #009926 } /* Literal.String.Regex */
55+
.highlight .s1 { color: #d14 } /* Literal.String.Single */
56+
.highlight .ss { color: #990073 } /* Literal.String.Symbol */
57+
.highlight .bp { color: #999999 } /* Name.Builtin.Pseudo */
58+
.highlight .vc { color: #008080 } /* Name.Variable.Class */
59+
.highlight .vg { color: #008080 } /* Name.Variable.Global */
60+
.highlight .vi { color: #008080 } /* Name.Variable.Instance */
61+
.highlight .il { color: #009999 } /* Literal.Number.Integer.Long */
62+
63+
.type-csharp .highlight .k { color: #0000FF }
64+
.type-csharp .highlight .kt { color: #0000FF }
65+
.type-csharp .highlight .nf { color: #000000; font-weight: normal }
66+
.type-csharp .highlight .nc { color: #2B91AF }
67+
.type-csharp .highlight .nn { color: #000000 }
68+
.type-csharp .highlight .s { color: #A31515 }
69+
.type-csharp .highlight .sc { color: #A31515 }

0 commit comments

Comments
 (0)