diff --git a/README.md b/README.md index 4744f37e2..4fcd8388d 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,8 @@ Docker powered mini-Heroku. The smallest PaaS implementation you've ever seen. ## Requirements -Assumes Ubuntu 13 right now. Ideally name the host so it gets/has a hostname of a domain you have pointing to it. +Assumes Ubuntu 13 right now. Ideally have a domain ready to point to your host. It's designed for and is probably +best to use a fresh VM. The bootstrapper will install everything it needs. ## Installing @@ -18,7 +19,7 @@ Set up a domain and a wildcard domain pointing to that host. Make sure `/home/gi By default it's set to whatever the hostname the host has. You'll have to add a public key associated with a username as it says at the end of the bootstrapper. You'll do something -like this: +like this from your local machine: $ cat ~/.ssh/id_rsa.pub | ssh root@progriumapp.com "gitreceive upload-key progrium" @@ -26,8 +27,8 @@ That's it! ## Deploy an App -Right now Buildstep supports the Node.js and Ruby buildpacks. It's not hard to add more, go add more! Let's deploy -the Heroku Node.js sample app. All you have to do is add a remote to name the app. It's created on the fly. +Right now Buildstep supports the Node.js and Ruby buildpacks. It's not hard to add more, [go add more](https://github.com/progrium/buildstep#adding-buildpacks)! Let's deploy +the Heroku Node.js sample app. All you have to do is add a remote to name the app. It's created on-the-fly. $ cd node-js-sample $ git remote add progrium git@progriumapp.com:node-js-app @@ -55,6 +56,22 @@ You're done! * [Buildstep](https://github.com/progrium/buildstep) - Buildpack builder * [gitreceive](https://github.com/progrium/gitreceive) - Git push interface +## Ideas for Improvements + + * Custom domain support for apps + * HTTPS support on default domain + * Support more buildpacks (see Buildstep) + * Use dokku as the system user instead of git + * Heroku-ish commands to be run via SSH (like [Dokuen](https://github.com/peterkeen/dokuen#available-app-sub-commands)) + +Looking to keep codebase as simple and hackable as possible, so try to keep your line count down. + +## Things this project won't do + + * **Multi-node.** Not a huge leap, but this isn't the project for it. Maybe as Super Dokku. + * **Multitenancy.** It's ready for it, but again, probably for Super Dokku. + * **Client app.** Given the constraints, running commands remotely via SSH is fine. + ## Contributors * Jeff Lindsay