Skip to content

Commit

Permalink
Add readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
honza committed Apr 5, 2012
1 parent 7275dfa commit 04946db
Showing 1 changed file with 41 additions and 0 deletions.
41 changes: 41 additions & 0 deletions README.md
@@ -0,0 +1,41 @@
heroku sprunge
==============

*Roll your own sprunge on your domain*

This is inspired by and shares some code with http://sprunge.us.

This is a simple Flask app that uses Pygments to highlight the code. It uses
MongoDB to store the snippets. Heroku gives you 240MB of MongoDB storage for
free. All you need is a free Heroku account and a bit of time.


Setup
-----

$ git clone git://github.com/honza/heroku-sprunge.git
$ cd heroku-sprunge
$ heroku create --stack cedar
$ heroku addons:add mongolab:starter
$ # Add settings: heroku config:add
$ git push heroku master

Env settings
------------

* `SPRUNGE_HOST` - the url where this will be hosted (no trailing slash)
* `SPRUNGE_NAME` - the POST payload key
* `SPRUNGE_MONGO_URI` - the MongoLab URL from Heroku (`heroku config | grep
mongo`)
* `SPRUNGE_MONGO_DB_NAME` - the string after the last slash on
`SPRUNGE_MONGO_URI`


Set these with:

$ heroku config:add KEY=VALUE

License
-------

BSD, short and sweet.

0 comments on commit 04946db

Please sign in to comment.