Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/AdmitHub/meteor-buildpack-horse

Heroku buildpack for Meteor v1.0+. The horse one.
https://github.com/AdmitHub/meteor-buildpack-horse

Last synced: 3 days ago
JSON representation

Heroku buildpack for Meteor v1.0+. The horse one.

Awesome Lists containing this project

README 

        
# Meteor Buildpack Horse



[![Horse](https://i.imgur.com/YhIL9zM.jpg)](https://commons.wikimedia.org/wiki/File:Draw-Costa_Rican-2smallest.jpg)



A heroku buildpack for Meteor v1+, designed to be as simple and readable as possible.



To use this with your meteor app and heroku:



1. Set up your app to [deploy to heroku with git](https://devcenter.heroku.com/articles/git).

2. Set your buildpack to the latest version from the [registry](https://devcenter.heroku.com/articles/buildpack-registry):



        heroku buildpacks:set admithub/meteor-horse



3. Add the MongoLab addon:



        heroku addons:create mongolab



4. Set the `ROOT_URL` environment variable. This is required for bundling and running the app.  Either define it explicitly, or enable the [Dyno Metadata](https://devcenter.heroku.com/articles/dyno-metadata) labs addon to default to `https://.herokuapp.com`.



        heroku config:set ROOT_URL="https://.herokuapp.com" # or other URL



Once that's done, you can deploy your app using this build pack any time by pushing to heroku:



    git push heroku master



## Environment



The following are some important environment variables for bundling and running your meteor app on heroku.  Depending on your settings, you may need to override these on heroku.  See [heroku's documentation](https://devcenter.heroku.com/articles/config-vars) for how to set these.



 - `ROOT_URL`: The root URL for your app, needed for bundling as well as running. If you enable the [Dyno Metadata](https://devcenter.heroku.com/articles/dyno-metadata) labs addon and `ROOT_URL` is undefined, it will default to `https://.herokuapp.com`).

 - `MONGO_URL`: The URL to mongodb. If not defined, it will default the value of `MONGODB_URI`, `MONGOLAB_URI`, or `MONGOHQ_URL` (in order).  If you don't use mongolab as a regular addon (and none of the fallbacks are defined), you'll need to set this.

 - `METEOR_APP_DIR`: The relative path to the root of your meteor app within your git repository (i.e. the path to the directory that contains `.meteor/`). The buildpack will look in the root of your repository and `app/` subdirectory; if you put your app anywhere else (like `src/`), define this variable to tell the buildpack where to look.

 - `BUILDPACK_PRELAUNCH_METEOR`: If your app uses packages that need to compile their assets on first run, you may need meteor to launch prior to bundling.  If this applies for you, define `BUILDPACK_PRELAUNCH_METEOR=1`. [Reference issue](https://github.com/meteor/meteor/issues/2606).

 - `BUILDPACK_VERBOSE`: Set `BUILDPACK_VERBOSE=1` to enable verbose bash debugging during slug compilation. Only takes effect after the environment variables have been loaded.

 - `BUILDPACK_CLEAR_CACHE`: This buildpack stores the meteor installation in the [CACHE_DIR](https://devcenter.heroku.com/articles/buildpack-api#caching) to speed up subsequent builds. Set `BUILDPACK_CLEAR_CACHE=1` to clear this cache on startup and after build is done.

 - `BUILD_OPTIONS`: Set to any additional options you'd like to add to the invocation of `meteor build`, for example `--debug` or `--allow-incompatible-update`.

 - `NODEJS_PARAMS`: additional parameters for running `node` binary. This can be used eg. for [adjusting garbage collector settings](https://devcenter.heroku.com/articles/node-best-practices#avoid-garbage) by putting `--optimize_for_size --max_old_space_size=460 --gc_interval=100` here



## Extras



The basic buildpack should function correctly for any normal-ish meteor app,

with or without npm-container.  For extra steps needed for your particular build,

just add shell scripts to the `extra` folder and they will get sourced into the

build.



Extras included in this branch:

 - `mongo_url.sh`: If `MONGO_URL` is empty, set it to the value of `MONGODB_URI`, `MONGOLAB_URI`, or `MONGOHQ_URL` (in order).

 - `root_url.sh`: If `ROOT_URL` is empty and `HEROKU_APP_NAME` is available, set `ROOT_URL` to `https://$HEROKU_APP_NAME.herokuapp.com`



## Where things go



This buildpack creates a directory `.meteor/heroku_build` (`$COMPILE_DIR`)

inside the app checkout, and puts all the binaries and the built app in there.

So it ends up having the usual unixy `bin/`, `lib/`, `share` etc

subdirectories.  Those directories are added to `$PATH` and

`$LD_LIBRARY_PATH` appropriately.



So `$COMPILE_DIR/bin` etc are great places to put any extra binaries or stuff

if you need to in custom extras.



## Using the latest buildpack code



The `admithub/meteor-horse` buildpack from the [Heroku Registry](https://devcenter.heroku.com/articles/buildpack-registry) contains the latest stable version of the buildpack. If you'd like to use the latest buildpack code from this Github repository, you can set your buildpack to the Github URL:



        heroku buildpacks:set https://github.com/AdmitHub/meteor-buildpack-horse



## Tips & Tricks



Please help us add tips and tricks to the [wiki](https://github.com/AdmitHub/meteor-buildpack-horse/wiki) for further help, like usage with Dokku or other environments.



## Why horse?



There are a gazillian forks and branches of various buildpacks remixing the

words "heroku", "buildpack", and "meteor", many of which are abandoned or

outdated or broken, and it's really hard to keep them straight.



So this one is the horse one.



README image credit: wikicommons contributor [Arsdelicata](https://commons.wikimedia.org/wiki/User:Arsdelicata)