foreman 0.5.1 → 0.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,138 +1,4 @@
1
- foreman(1) -- manage Procfile-based applications
2
- ================================================
1
+ Foreman
2
+ =======
3
3
 
4
- ## SYNOPSIS
5
-
6
- `foreman start [process]`<br>
7
- `foreman export <var>format</var> [location]`
8
-
9
- ## DESCRIPTION
10
-
11
- **Foreman** is a manager for Procfile-based applications. Its aim is to
12
- abstract away the details of the Procfile format, and allow you to either run
13
- your application directly or export it to some other process management
14
- format.
15
-
16
- ## RUNNING
17
-
18
- `foreman start` is used to run your application directly from the command line.
19
-
20
- If no additional parameters are passed, foreman will run one instance of each
21
- type of process defined in your Procfile.
22
-
23
- If a parameter is passed, foreman will run one instance of the specified
24
- application type.
25
-
26
- The following options control how the application is run:
27
-
28
- * `-s`, `--screen`:
29
- Run the application as a series of screen windows rather than interleaved
30
- in stdout.
31
-
32
- ## EXPORTING
33
-
34
- `foreman export` is used to export your application to another process
35
- management format.
36
-
37
- An location to export can be passed as an argument. This argument may be
38
- either required or optional depending on the export format.
39
-
40
- The following options control how the application is run:
41
-
42
- * `-a`, `--app`:
43
- Use this name rather than the application's root directory name as the
44
- name of the application when exporting.
45
-
46
- * `-c`, `--concurrency`:
47
- Specify the number of each process type to run. The value passed in
48
- should be in the format `process=num,process=num`
49
-
50
- * `-l`, `--log`:
51
- Specify the directory to place process logs in.
52
-
53
- * `-p`, `--port`:
54
- Specify which port to use as the base for this application. Should be
55
- a multiple of 1000.
56
-
57
- * `-u`, `--user`:
58
- Specify the user the application should be run as. Defaults to the
59
- app name
60
-
61
- ## OPTIONS
62
-
63
- These options control all modes of foreman's operation.
64
-
65
- * `-f`, `--procfile`:
66
- Specify an alternate location for the application's Procfile. This file's
67
- containing directory will be assumed to be the root directory of the
68
- application.
69
-
70
- ## EXPORT FORMATS
71
-
72
- foreman currently supports the following output formats:
73
-
74
- * inittab
75
-
76
- * upstart
77
-
78
- ## INITTAB EXPORT
79
-
80
- Will export a chunk of inittab-compatible configuration:
81
-
82
- # ----- foreman example processes -----
83
- EX01:4:respawn:/bin/su - example -c 'PORT=5000 bundle exec thin start >> /var/log/web-1.log 2>&1'
84
- EX02:4:respawn:/bin/su - example -c 'PORT=5100 bundle exec rake jobs:work >> /var/log/job-1.log 2>&1'
85
- # ----- end foreman example processes -----
86
-
87
- ## UPSTART EXPORT
88
-
89
- Will create a series of upstart scripts in the location you specify. Scripts
90
- will be structured to make the following commands valid:
91
-
92
- `start appname`
93
-
94
- `stop appname-processname`
95
-
96
- `restart appname-processname-3`
97
-
98
- ## PROCFILE
99
-
100
- A Procfile should contain both a name for the process and the command used
101
- to run it.
102
-
103
- web bundle exec thin start
104
- job bundle exec rake jobs:work
105
-
106
- ## EXAMPLES
107
-
108
- Start one instance of each process type, interleave the output on stdout:
109
-
110
- $ foreman start
111
-
112
- Export the application in upstart format:
113
-
114
- $ foreman export upstart /etc/init
115
-
116
- Run one process type from the application defined in a specific Procfile:
117
-
118
- $ foreman start alpha -p ~/app/Procfile
119
-
120
- ## COPYRIGHT
121
-
122
- Foreman is Copyright (C) 2010 David Dollar <http://daviddollar.org>
123
-
124
-
125
- [SYNOPSIS]: #SYNOPSIS "SYNOPSIS"
126
- [DESCRIPTION]: #DESCRIPTION "DESCRIPTION"
127
- [RUNNING]: #RUNNING "RUNNING"
128
- [EXPORTING]: #EXPORTING "EXPORTING"
129
- [OPTIONS]: #OPTIONS "OPTIONS"
130
- [EXPORT FORMATS]: #EXPORT-FORMATS "EXPORT FORMATS"
131
- [INITTAB EXPORT]: #INITTAB-EXPORT "INITTAB EXPORT"
132
- [UPSTART EXPORT]: #UPSTART-EXPORT "UPSTART EXPORT"
133
- [PROCFILE]: #PROCFILE "PROCFILE"
134
- [EXAMPLES]: #EXAMPLES "EXAMPLES"
135
- [COPYRIGHT]: #COPYRIGHT "COPYRIGHT"
136
-
137
-
138
- [foreman(1)]: foreman.1.html
4
+ See the [man page](http://ddollar.github.com/foreman) for usage.
data/Rakefile CHANGED
@@ -29,7 +29,6 @@ task :man do
29
29
  ENV['RONN_MANUAL'] = "Foreman Manual"
30
30
  ENV['RONN_ORGANIZATION'] = "Foreman #{Foreman::VERSION}"
31
31
  sh "ronn -w -s toc -r5 --markdown man/*.ronn"
32
- sh "cp man/foreman.1.markdown README.markdown"
33
32
  sh "git add README.markdown"
34
33
  sh "git commit -m 'update readme' || echo 'nothing to commit'"
35
34
  end
@@ -1,6 +1,6 @@
1
1
  module Foreman
2
2
 
3
- VERSION = "0.5.1"
3
+ VERSION = "0.6.0"
4
4
 
5
5
  class AppDoesNotExist < Exception; end
6
6
 
@@ -5,7 +5,7 @@ class Foreman::Export::Inittab < Foreman::Export::Base
5
5
  def export(fname=nil, options={})
6
6
  app = options[:app] || File.basename(engine.directory)
7
7
  user = options[:user] || app
8
- log_root = options[:log] || "/var/log"
8
+ log_root = options[:log] || "/var/log/#{app}"
9
9
 
10
10
  concurrency = parse_concurrency(options[:concurrency])
11
11
 
metadata CHANGED
@@ -1,13 +1,13 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: foreman
3
3
  version: !ruby/object:Gem::Version
4
- hash: 9
4
+ hash: 7
5
5
  prerelease: false
6
6
  segments:
7
7
  - 0
8
- - 5
9
- - 1
10
- version: 0.5.1
8
+ - 6
9
+ - 0
10
+ version: 0.6.0
11
11
  platform: ruby
12
12
  authors:
13
13
  - David Dollar
@@ -15,7 +15,7 @@ autorequire:
15
15
  bindir: bin
16
16
  cert_chain: []
17
17
 
18
- date: 2010-06-30 00:00:00 -04:00
18
+ date: 2010-07-06 00:00:00 -04:00
19
19
  default_executable: foreman
20
20
  dependencies:
21
21
  - !ruby/object:Gem::Dependency