jmettraux / ruote-rest

restful workflow engine based on Rack and ruote (Warning : ruote-rest will be replaced by ruote-kit soon)

This URL has Read+Write access

ruote-rest / README.txt
raw normal view history
877ab69e » jmettraux 2008-04-12 first commit 1 = ruote-rest
2
3 A RESTful instance of OpenWFEru (ruote) powered by Rack (http://rack.rubyforge.org/)
6ffd528b » jmettraux 2008-08-29 based Rack 4
398f334b » jmettraux 2008-04-14 /processes almost done, sta... 5
6 == getting it
7
8 Get it from GitHub or download a prepackaged release at http://rubyforge.org/frs/?group_id=2609 (and jump to '== preparing it')
9a6d3941 » jmettraux 2008-09-08 enhanced README.txt 9
10 To get Ruote and Ruote-Rest :
398f334b » jmettraux 2008-04-14 /processes almost done, sta... 11
12 git clone git://github.com/jmettraux/ruote-rest.git
2036145c » jmettraux 2009-03-27 small readme cleanup 13
398f334b » jmettraux 2008-04-14 /processes almost done, sta... 14 Then
898ab6c6 » jmettraux 2008-04-30 preparing easy install/deploy 15
16 cd ruote-rest
2036145c » jmettraux 2009-03-27 small readme cleanup 17 rake ruote:install
18
155f402d » jmettraux 2008-08-06 simpler task names 19 to install the Ruote (OpenWFEru) workflow engine and its dependencies (in a vendor/ subdirectory). Alternatively, you could do
9a6d3941 » jmettraux 2008-09-08 enhanced README.txt 20
21 rake ruote:gem_install
2036145c » jmettraux 2009-03-27 small readme cleanup 22
9a6d3941 » jmettraux 2008-09-08 enhanced README.txt 23 to get the dependencies as gems.
24
25 If you want to grab the gem and freeze them under vendorf/ do :
275cf11d » jmettraux 2009-03-30 tests now relying on vendor... 26
27 rake ruote:install_freeze
28
29
898ab6c6 » jmettraux 2008-04-30 preparing easy install/deploy 30 == preparing it
9a6d3941 » jmettraux 2008-09-08 enhanced README.txt 31
ad84e924 » jmettraux 2008-05-06 added link to /workitems?wf... 32 To prepare the development database
898ab6c6 » jmettraux 2008-04-30 preparing easy install/deploy 33
34 rake mysql:setup
2036145c » jmettraux 2009-03-27 small readme cleanup 35
898ab6c6 » jmettraux 2008-04-30 preparing easy install/deploy 36 Expects a mysql db with a 'root' admin account with sufficient access rights.
83ff8d09 » jmettraux 2008-04-30 now returning 303 on delete... 37 It will create a database named "ruoterest_development".
38
898ab6c6 » jmettraux 2008-04-30 preparing easy install/deploy 39 (
40 To prepare the test database
41
42 rake mysql:setup stage=test
2036145c » jmettraux 2009-03-27 small readme cleanup 43
41921c0d » jmettraux 2008-04-30 aligned README and install ... 44 To prepare the dev database with the admin 'toto'
45
46 rake mysql:setup dbadmin=toto
2036145c » jmettraux 2009-03-27 small readme cleanup 47 )
898ab6c6 » jmettraux 2008-04-30 preparing easy install/deploy 48
49 The last step of the database preparation is loading the authentication settings :
c7ea3063 » jmettraux 2009-05-17 todo #25167 : rake password... 50
51 rake mysql:populate
52
53 These settings may be modified by editing tasks/fixtures/host.yml and/or tasks/fixtures/users.yml
54
55 To generate a password for a user :
56
57 rake password:generate smd5 my_very_secret_password
58
59 or
60
61 rake password:generate ssha my_very_secret_password
62
63 The resulting string (something like "{SMD5}HKBKsOPQ1PleLG3KOlmHTWtoNW9HVGxC") can be inserted in the fixture or in the 'password' column database for the given user.
64
65
398f334b » jmettraux 2008-04-14 /processes almost done, sta... 66 == starting it
76b73347 » jmettraux 2008-04-30 creating logs/ automaticall... 67
398f334b » jmettraux 2008-04-14 /processes almost done, sta... 68 ruby lib/start.rb
2036145c » jmettraux 2009-03-27 small readme cleanup 69
c80c4c62 » jmettraux 2008-04-26 added detailed HTML view fo... 70
76b73347 » jmettraux 2008-04-30 creating logs/ automaticall... 71 Then head to
72
73 http://localhost:4567/
2036145c » jmettraux 2009-03-27 small readme cleanup 74
398f334b » jmettraux 2008-04-14 /processes almost done, sta... 75 (
8c110689 » jmettraux 2008-08-04 adapted to latest fluo-can.js 76 to start it on port 3333 :
77
78 ruby lib/start.rb -p 3333
2036145c » jmettraux 2009-03-27 small readme cleanup 79 )
8c110689 » jmettraux 2008-08-04 adapted to latest fluo-can.js 80
81 it will lead you to the "service document" with links to all the resources/
ac97ece5 » jmettraux 2008-08-22 added http basic auth and w... 82 collection that make ruote-rest.
83
84
398f334b » jmettraux 2008-04-14 /processes almost done, sta... 85 == interface
86
87 Just navigate the interface with your browser, everything is there.
155f402d » jmettraux 2008-08-06 simpler task names 88
877ab69e » jmettraux 2008-04-12 first commit 89
41921c0d » jmettraux 2008-04-30 aligned README and install ... 90 == configuration
bed5801b » jmettraux 2008-05-05 reworked /participants 91
92 conf/db.rb
93
94 database configuration
2036145c » jmettraux 2009-03-27 small readme cleanup 95
bed5801b » jmettraux 2008-05-05 reworked /participants 96 conf/engine.rb
97
98 engine configuration
2036145c » jmettraux 2009-03-27 small readme cleanup 99
bed5801b » jmettraux 2008-05-05 reworked /participants 100 conf/participants.rb
101 conf/participants_development.yaml
102
103 participants configuration, the yaml file holds the list of
2036145c » jmettraux 2009-03-27 small readme cleanup 104 'active participants' (the worklist in fact).
105
bed5801b » jmettraux 2008-05-05 reworked /participants 106 conf/auth.rb
ac97ece5 » jmettraux 2008-08-22 added http basic auth and w... 107
108 authentication filters, contains an HTTP basic authentication example
2036145c » jmettraux 2009-03-27 small readme cleanup 109 and a "whitelist" authentication example.
110
ac97ece5 » jmettraux 2008-08-22 added http basic auth and w... 111
bed5801b » jmettraux 2008-05-05 reworked /participants 112 == license
41921c0d » jmettraux 2008-04-30 aligned README and install ... 113
114 MIT
5e4d8aac » jmettraux 2009-05-10 BSD -> MIT 115
41921c0d » jmettraux 2008-04-30 aligned README and install ... 116
117 == feedback
118
119 user mailing list : http://groups.google.com/group/openwferu-users
12b768d1 » jmettraux 2008-06-11 irc and cleaning conf/parti... 120 developers mailing list : http://groups.google.com/group/openwferu-dev
121
122 issue tracker : http://github.com/jmettraux/ruote-rest/issues/
953396e3 » jmettraux 2009-06-19 Fixes issue with updating (... 123
12b768d1 » jmettraux 2008-06-11 irc and cleaning conf/parti... 124 irc : irc.freenode.net #ruote
125
41921c0d » jmettraux 2008-04-30 aligned README and install ... 126