|
| 1 | +.TH CHEF-SERVER-WEBUI "1" "March 2010" "chef-server-webui" "User Commands" |
| 2 | +.SH NAME |
| 3 | +chef-server-webui \- Start the Chef Server merb application slice providing Web User Interface. |
| 4 | +.SH SYNOPSIS |
| 5 | +.B chef-server-webui |
| 6 | +[\fIuGdcIpPhmailLerkKX\fR] [\fIargument\fR] |
| 7 | +.SH DESCRIPTION |
| 8 | +The Chef Server WebUI is a Merb application slice. The default listen port is 4040. |
| 9 | +.TP |
| 10 | +\fB\-u\fR, \fB\-\-user\fR USER |
| 11 | +This flag is for having chef-server-webui run as a user other than the one currently logged in. Note: if you set this you must also provide a \fB\-\-group\fR option for it to take effect. |
| 12 | +.TP |
| 13 | +\fB\-G\fR, \fB\-\-group\fR GROUP |
| 14 | +This flag is for having chef-server-webui run as a group other than the one currently logged in. Note: if you set this you must also provide a \fB\-\-user\fR option for it to take effect. |
| 15 | +.TP |
| 16 | +\fB\-d\fR, \fB\-\-daemonize\fR |
| 17 | +This will run a single chef-server-webui in the background. |
| 18 | +.TP |
| 19 | +\fB\-N\fR, \fB\-\-no\-daemonize\fR |
| 20 | +This will allow you to run a cluster in console mode |
| 21 | +.TP |
| 22 | +\fB\-c\fR, \fB\-\-cluster\-nodes\fR NUM_MERBS |
| 23 | +Number of merb daemons to run for chef-server-webui. |
| 24 | +.TP |
| 25 | +\fB\-I\fR, \fB\-\-init\-file\fR FILE |
| 26 | +File to use for initialization on load, defaults to config/init.rb |
| 27 | +.TP |
| 28 | +\fB\-p\fR, \fB\-\-port\fR PORTNUM |
| 29 | +Port to run chef-server-webui on, defaults to 4040. Additional nodes (\-c) listen on incrementing port numbers. |
| 30 | +.TP |
| 31 | +\fB\-o\fR, \fB\-\-socket\-file\fR FILE |
| 32 | +Socket file to run chef-server-webui on, defaults to [Merb.root]/log/merb.sock. This is for web servers, like thin, that use sockets.Specify this *only* if you *must*. |
| 33 | +.TP |
| 34 | +\fB\-s\fR, \fB\-\-socket\fR SOCKNUM |
| 35 | +Socket number to run chef-server-webui on, defaults to 0. |
| 36 | +.TP |
| 37 | +\fB\-n\fR, \fB\-\-name\fR NAME |
| 38 | +Set the name of the application. This is used in the process title and log file names. |
| 39 | +.TP |
| 40 | +\fB\-P\fR, \fB\-\-pid\fR PIDFILE |
| 41 | +PID file, defaults to [Merb.root]/log/merb.main.pid for the master process and[Merb.root]/log/merb.[port number].pid for worker processes. For clusters, use %s to specify where in the file chef-server-webui should place the port number. For instance: \fB\-P\fR myapp.%s.pid |
| 42 | +.TP |
| 43 | +\fB\-h\fR, \fB\-\-host\fR HOSTNAME |
| 44 | +Host to bind to (default is 0.0.0.0). |
| 45 | +.HP |
| 46 | +\fB\-m\fR, \fB\-\-merb\-root\fR /path/to/approot The path to the Merb.root for the app you want to run (default is current working directory). |
| 47 | +.TP |
| 48 | +\fB\-a\fR, \fB\-\-adapter\fR ADAPTER |
| 49 | +The rack adapter to use to run chef-server-webui (default is mongrel)[mongrel, emongrel, thin, ebb, fastcgi, webrick] |
| 50 | +.TP |
| 51 | +\fB\-R\fR, \fB\-\-rackup\fR FILE |
| 52 | +Load an alternate Rack config file (default is config/rack.rb) |
| 53 | +.TP |
| 54 | +\fB\-i\fR, \fB\-\-irb\-console\fR |
| 55 | +This flag will start chef-server-webui in irb console mode. All your models and other classes will be available for you in an irb session. |
| 56 | +.TP |
| 57 | +\fB\-S\fR, \fB\-\-sandbox\fR |
| 58 | +This flag will enable a sandboxed irb console. If your ORM supports transactions, all edits will be rolled back on exit. |
| 59 | +.TP |
| 60 | +\fB\-l\fR, \fB\-\-log\-level\fR LEVEL |
| 61 | +Log levels can be set to any of these options: debug < info < warn < error < fatal (default is info) |
| 62 | +.TP |
| 63 | +\fB\-L\fR, \fB\-\-log\fR LOGFILE |
| 64 | +A string representing the logfile to use. Defaults to [Merb.root]/log/merb.[main].log for the master process and [Merb.root]/log/merb[port number].logfor worker processes |
| 65 | +.TP |
| 66 | +\fB\-e\fR, \fB\-\-environment\fR STRING |
| 67 | +Environment to run Merb under [development, production, testing] (default is development) |
| 68 | +.HP |
| 69 | +\fB\-r\fR ['RUBY CODE'| FULL_SCRIPT_PATH] |
| 70 | +.TP |
| 71 | +\fB\-\-script\-runner\fR |
| 72 | +Command\-line option to run scripts and/or code in the chef-server-webui app. |
| 73 | +.TP |
| 74 | +\fB\-K\fR, \fB\-\-graceful\fR PORT or all |
| 75 | +Gracefully kill chef-server-webui proceses by port number. Use chef-server \fB\-K\fR all to gracefully kill all merbs. |
| 76 | +.TP |
| 77 | +\fB\-k\fR, \fB\-\-kill\fR PORT |
| 78 | +Force kill one merb worker by port number. This will cause the worker tobe respawned. |
| 79 | +.TP |
| 80 | +\fB\-\-fast\-deploy\fR |
| 81 | +Reload the code, but not yourinit.rb or gems |
| 82 | +.TP |
| 83 | +\fB\-X\fR, \fB\-\-mutex\fR on/off |
| 84 | +This flag is for turning the mutex lock on and off. |
| 85 | +.TP |
| 86 | +\fB\-D\fR, \fB\-\-debugger\fR |
| 87 | +Run chef-server-webui using rDebug. |
| 88 | +.TP |
| 89 | +\fB\-V\fR, \fB\-\-verbose\fR |
| 90 | +Print extra information |
| 91 | +.TP |
| 92 | +\fB\-C\fR, \fB\-\-console\-trap\fR |
| 93 | +Enter an irb console on ^C |
| 94 | +.TP |
| 95 | +\-?, \fB\-H\fR, \fB\-\-help\fR |
| 96 | +Show this help message |
| 97 | +.SH "SEE ALSO" |
| 98 | +Full documentation for Chef and chef-server-webui is located on the Chef wiki, http://wiki.opscode.com/display/chef/Home. |
| 99 | +.SH AUTHOR |
| 100 | +Chef was written by Adam Jacob <adam@ospcode.com> of Opscode (http://www.opscode.com), with contributions from the community. |
| 101 | +This manual page was written by Joshua Timberman <joshua@opscode.com> with help2man |
| 102 | +for the Debian project (but may be used by others).. Permission is granted |
| 103 | + to copy, distribute and / or modify this document under the terms of the Apache 2.0 License. |
| 104 | + |
| 105 | + On Debian systems, the complete text of the Apache 2.0 License can be found in |
| 106 | + /usr/share/common-licenses/Apache-2.0. |
0 commit comments