Source repo for Docker's Documentation
Go to file
Sean Li 72271a3d20 Refactored app code. 2014-09-01 00:59:32 -07:00
meteor Refactored app code. 2014-09-01 00:59:32 -07:00
resources Fixing critical install bug 2014-08-30 11:09:27 -07:00
script Fixing setup for boot2docker CLI 2014-08-30 06:15:42 -07:00
.gitignore Adding Node.js 0.10.29 into the bundle so the server portion runs 2014-08-27 18:12:55 -07:00
CONTRIBUTING.md Initial commit 2014-08-27 13:45:22 -07:00
LICENSE Initial commit 2014-08-27 13:45:22 -07:00
README.md Updated contact information. 2014-08-30 17:05:47 -07:00
index.html Initial commit 2014-08-27 13:45:22 -07:00
index.js Fixing installer & mongodb startup bug. 2014-08-29 10:49:26 -07:00
package.json Moving Sync to client side 2014-08-28 21:56:08 -07:00

README.md

Kitematic

Note: If the installer gets stuck at any step for more than 1 minute, there is probably an error. Please help us troubleshoot by running it from the command line, and submit the logs to contact@kitematic.com.

  1. cd <dir with Kitematic.app>
  2. Run ./Kitematic.app/Contents/MacOS/node-webkit

Kitematic is still in Beta. Any effort in helping us find issues and improving the experience is greatly appreciated!

Fixes for Known Issues

Kitematic Screenshot

Table of Contents

Development

  • Install any version of Node.js
  • Install meteor.js curl https://install.meteor.com/ | sh.
  • Install meteorite npm install meteorite -g
  • Install demeteorizer npm install demeteorizer -g
  • Run ./script/setup.sh to download the binary requirements (things like virtualbox).

Running the development Server

  • ./script/run.sh

Building the Mac OS X Package

  • ./script/bundle.sh # Generates the app bundle under ./bundle
  • ./script/dist.sh # Generates the app under ./dist./osx/Kitematic.app

Uninstalling

(This will improve over time.)

  • Remove VirtualBox
  • rm /usr/local/bin/boot2docker
  • sudo route delete 172.17.0.0/16 192.168.59.103 (disable routing to containers through VM)
  • rm -rf ~/Library/Application\ Support/Kitematic (remove app data)
  • rm /Library/LaunchAgents/com.kitematic.route.plist (remove launch job that sets up routing to the containers)

Bugs and Feature Requests

Have a bug or a feature request? Please first read the Issue Guidelines and search for existing and closed issues. If your problem or idea is not addressed yet, please open a new issue.

Documentation

Kitematic's documentation and other information can be found at http://kitematic.com/docs.

Contributing

Please read through our Contributing Guidelines. Included are directions for opening issues, coding standards, and notes on development.

Development Roadmap can be found on our Trello board.

Community

Keep track of development and community news.

Versioning

For transparency into our release cycle and in striving to maintain backward compatibility, Kitematic is maintained under the Semantic Versioning Guidelines. We'll try very hard adhere to those rules whenever possible.

Creators

Team E-mail: contact@kitematic.com

Sean Li

Jeffrey Morgan

Michael Chiang

Code released under the AGPL license.