README.md in forj-0.0.39 vs README.md in forj-0.0.40

- old
+ new

@@ -14,43 +14,57 @@ ###Ubuntu/Debian deb like package system **For ruby 1.9** - $ sudo apt-get install ruby-dev build-essential libopenssl-ruby1.9.1 libssl-dev zlib1g-dev libxml2-dev libxslt-dev git -y + $ apt-get -y update + $ sudo apt-get install ruby1.9.1 ruby1.9.1-dev rubygems1.9.1 build-essential libopenssl-ruby1.9.1 libssl-dev zlib1g-dev libxml2-dev libxslt-dev git -y $ sudo gem install forj **For ruby 1.8** - $ sudo apt-get install ruby1.8-dev ruby1.8 ri1.8 rdoc1.8 irb1.8 -y + $ sudo apt-get install ruby1.8-dev ruby1.8 ri1.8 rdoc1.8 irb1.8 rubygems -y $ sudo apt-get install libreadline-ruby1.8 libruby1.8 libopenssl-ruby -y $ sudo apt-get install libxslt-dev libxml2-dev -y $ sudo gem install nokogiri $ sudo apt-get install ruby-bundler -y $ sudo gem install mime-types -v 1.25.1 $ sudo gem install hpcloud $ sudo gem install forj +**Installation from source** +Perform one of the ruby installation steps without `gem install forj`. + $ sudo apt-get -y install build-essential make libxslt-dev libxml2-dev + $ sudo mkdir -p /opt/config/production/git + $ cd /opt/config/production/git + $ git clone https://review.forj.io/forj-oss/cli + $ cd cli + $ gem install bundler --no-rdoc --no-ri + $ gem install rake --no-rdoc --no-ri + $ bundle install --gemfile Gemfile + $ rake install + Quick steps: How to create a forj? ---------------------------------- forj setup # follow the instructions 1. Setup your first forj account. - `$ forj setup [Provider]` + `$ forj setup [AccountName]` - Ex: `forj setup hpcloud`. In this example, your account will be named 'hpcloud'. + Ex: `forj setup MyAccount`. In this example, your account will be named 'MyAccount'. + The first time you setup your account, it will become the default one. **WARNING!!!** [Provider] is currently not supported. By default, it is using hpcloud as default provider. 2. Create your forge on your default account - `$ forj boot <blueprint> on hpcloud as <InstanceName>` + `$ forj boot <blueprint> <InstanceName>` - Ex: `forj boot redstone on hpcloud as MyForge` + Ex: `forj boot redstone myforge` - This command will start a Redstone forge named 'myforge' with the default FORJ account. Previous, we set it to be MyAccount. ###Forj options: To get forj cli help, just type: @@ -62,15 +76,15 @@ $ forj help boot Examples of possible actions: Commands: - forj boot <Blueprint> on <Provider> as <InstanceName> [options] # boot a Maestro box and instruct it to provision the blueprint - forj down # delete the Maestro box and all systems installed by the blueprint - forj help [action] # Describe available FORJ actions or one specific action - forj setup # set the credentials for forj cli - forj show defaults # Show list of predefined value you can update in your ~/.forj/config.yaml + forj boot <Blueprint> <InstanceName> [options] # boot a Maestro box and instruct it to provision the blueprint + forj down # delete the Maestro box and all systems installed by the blueprint + forj help [action] # Describe available FORJ actions or one specific action + forj setup # set the credentials for forj cli + forj show defaults # Show list of predefined value you can update in your ~/.forj/config.yaml forj ssh #### config.yaml description @@ -82,15 +96,15 @@ default: account_name: name # Default forj account used to connect to your cloud. This setting is automatically set to the first account created with forj setup <CloudProvider> maestro_url: url # Maestro GIT repository for clone. infra_repo: path # Path to the default Infra repository used to store your specific bootstrap/build environment. By default: ~/.forj/infra - image: imageName # NOT CURRENTLY USED. Still under development. - # Image used to create Maestro and all forge boxes. By default, it is 'Ubuntu Precise 12.04.4 LTS Server 64-bit 20140414 (Rescue Image)' + image: imageName # Image used to create Maestro and all forge boxes. By default, it is 'Ubuntu Precise 12.04.4 LTS Server 64-bit 20140414 (Rescue Image)' # If you have created the generic proto2b image, you can set it here. - flavor: flavorName # NOT CURRENTLY USED. Still under development. - # Maestro Flavor name. This flavor is for Maestro only. Your blueprint layout defines each node flavors on needs. - # By default: standard.xsmall + flavor: flavorName # Maestro Flavor name. This flavor is for Maestro only. Your blueprint layout defines each node flavors on needs. + # By default: standard.medium + bp_flavor: flavorName # Blueprint nodes default flavor. Usually, blueprint node are smaller than Maestro. + # By default: standard.small ports: [Port1,Port2,...] # list of additional ports to add in your cloud security group. # This list is added to the default one in defaults.yaml keypair_path: path # Define the file path to your OpenSSH private key. Useful to access your box with ssh command line. # By default. ~/.forj/keypairs/nova keypair_name: name # keypair name defined in your cloud to access your server. By default we named it 'nova'. If it doesn't exist, it will be created.