params.json

{"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."}