Skip to content
This repository

Integrated Installer for ColdFusion Servers

branch: master
README.md

Integrated Installer for ColdFusion Servers

Ramen is inspired by many things. Homebrew, Ruby Gems, and of course the Railo Extension Manager. Hat tips all around!

It's an integrated installation system operated wholly by and for the ColdFusion Community. It aims to be compatible with ColdFusion 8 and above.

Demo!

click here to increase the size of your png
click image to increase the size of your png

Here's a video of how it works.

FAQ

Q: Do I need to know anything about Git or GitHub to use Ramen and install stuff?
A: Not at all. Ramen can apply updates to itself; so beyond the initial download of the code, you shouldn't need to come back here much if at all.

Q: But what about when new installers are added? Don't I need to get the latest updates?
A: Great question. Ramen uses this GitHub repository as its "server" (for lack of a better word) and checks for updates every time you use it. Even better than 1-button updates, this is 0-button updates. Just relax!

Q: My workplace has pretty strict policies and I don't think they'd like it talking to GitHub to get installers. Can we run it locally, vet the scripts, and only make available the ones that are approved?
A: Yes, and easily!

Developer Workflow

I've created a (14 minute) screencast covering typical developer workflow for adding your own installers to Ramen:

Adding Installers

We'll get the party started by adding installation scripts for some of our favorite frameworks and apps, but it's up to the community to add installer scripts for your favorites. Don't be intimidated, it can be as easy as this!

<cfset ramen.namespace("taffy") />
<cfset userLocation = ramen.getParams().location />

<cfoutput>
    <strong>Install location:</strong> #userLocation#<br/>
</cfoutput>

<cfset ramen.download("https://github.com/downloads/atuttle/Taffy/taffy-v1.1.zip", "taffy-1.1.zip") />
<cfset ramen.unzip("taffy-1.1.zip", userLocation) />
<cfset ramen.cleanup() />

<p>Taffy install complete.</p>

The above code sample is the install script for Taffy 1.1. See how easy it is? Oh, there's 1 more part. You've got to add some JSON to the index:

{
    "name": "Taffy",
    "desc": "Taffy is a framework for creating REST API's with extremely terse, object-oriented code.",
    "icon": "",
    "versions": [
        {
            "name": "1.1 Official Release",
            "desc": "This is the latest version of Taffy, now with Railo support and improved ColdSpring integration",
            "install": "https://raw.github.com/CFCommunity/ramen/master/index/taffy.1.1.cfm",
            "require": [
                {
                    "name": "location",
                    "label": "Install Location:",
                    "type": "folder",
                    "default": "{webroot}"
                }
            ]
        }
    ]
}

I think you can handle that.

Want your favorite Framework/App/Tool/whatever to be listed? You're just a pull request away!

Installation into your CF Administrator

  • Download Ramen and extract the ramen folder to be inside /CFIDE/administrator/.
  • Edit /CFIDE/administrator/custommenu.xml to add this line:
<menuitem href="ramen/cfadmin/index.cfm" target="content">Ramen</menuitem>
  • If you don't have a submenu block, then add that as well (The label is unimportant, call it whatever you want):
<submenu label="Admin Tools">
    <menuitem href="ramen/cfadmin/index.cfm" target="content">Ramen</menuitem>
</submenu>
  • Then log into your CF Administrator, and look for the Ramen link:

where to find the Ramen link

LICENSE

This project is free, open source software, available under the MIT License:

The MIT License (MIT)

Copyright (c) 2011 Adam Tuttle and Contributors

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, >FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER >LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER >DEALINGS IN THE SOFTWARE.

Something went wrong with that request. Please try again.