README.txt

   1 fuzed
   2     by Dave Fayram, Tom Preston-Werner
   3     fuzed.rubyforge.org
   4
   5
   6 == Summary
   7 Leverage the YAWS webserver (and additional erlang-based infrastructure) to
   8 run Rails.
   9
  10
  11 == Dependencies
  12 * Erlang: http://www.erlang.org
  13 * Yaws: http://yaws.hyber.org
  14 * Ruby: http://www.ruby-lang.org
  15 * Ruby Gems:
  16   * rake: http://rake.rubyforge.org
  17   * erlectricty: http://code.google.com/p/erlectricity
  18   * rack: http://rack.rubyforge.org
  19
  20
  21 == Installation (from gem)
  22
  23   sudo gem install fuzed
  24
  25
  26 == Installation (from git)
  27
  28 Get it from the git repo:
  29
  30   git clone git://repo.or.cz/fuzed.git
  31
  32 Change to the fuzed working copy:
  33
  34   cd fuzed
  35
  36 Build Fuzed:
  37
  38   rake build
  39
  40
  41 == Configuration
  42
  43 Create a shared Erlang cookie on each machine. In order for Erlang processes in
  44 different interpreters to communicate with each other, they each need to be
  45 able to find a file called .erlang.cookie in the home directory of the user
  46 under which they are running. The cookie should contain 20 uppercase alpha
  47 characters on a single line (no newline).
  48
  49 Generate a starter Yaws config file with:
  50
  51   fuzed-conf RAILS_ROOT 8080 > fuzed.conf
  52
  53 where RAILS_ROOT is the absolute path to the root directory of your Rails
  54 project. You may optionally specify a port as the second argument. This will
  55 generate a file called 'fuzed.conf' which contains a sample Yaws config file
  56 that should be suitable for initial testing.
  57
  58
  59 == Starting fuzed
  60
  61 Start the fuzed master server (yaws) locally:
  62
  63   fuzed start -n server@127.0.0.1 -c fuzed.conf
  64
  65 In another terminal, start a fuzed client locally:
  66
  67   fuzed join -n client@127.0.0.1 -m server@127.0.0.1 -r RAILS_ROOT
  68
  69 where RAILS_ROOT is the same as before.
  70
  71 Point your browser at:
  72
  73   http://localhost:8080
  74
  75 If everything worked out, you'll see your Rails app!
  76
  77
  78 == What is a Valid Hostname?
  79   Erlang has a funny notion about what a valid hostname is. Localhost won't
  80   cut it. I recommend using rendezvous to point to your local host. Short of
  81   that, 127.0.0.1 works.
  82
  83
  84 == Contribution Notes
  85 * Please note that empty directories should contain a .placeholder file
  86   (which should be empty), to facilitate the use of other version
  87   control systems which bridge to subversion but don't support empty
  88   directories.