summaryrefslogtreecommitdiff
path: root/distro/common/man/man8/chef-server.8
diff options
context:
space:
mode:
Diffstat (limited to 'distro/common/man/man8/chef-server.8')
-rw-r--r--distro/common/man/man8/chef-server.8147
1 files changed, 147 insertions, 0 deletions
diff --git a/distro/common/man/man8/chef-server.8 b/distro/common/man/man8/chef-server.8
new file mode 100644
index 0000000000..5928f7b7a1
--- /dev/null
+++ b/distro/common/man/man8/chef-server.8
@@ -0,0 +1,147 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "CHEF\-SERVER" "8" "September 2012" "Chef 11.0.0.alpha" "Chef Manual"
+.
+.SH "NAME"
+\fBchef\-server\fR \- Start the Chef Server merb application slice\.
+.
+.SH "SYNOPSIS"
+\fBchef\-server\fR \fI(options)\fR
+.
+.TP
+\fB\-u\fR, \fB\-\-user USER\fR
+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 \-\-group option for it to take effect\.
+.
+.TP
+\fB\-G\fR, \fB\-\-group GROUP\fR
+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 \-\-user option for it to take effect\.
+.
+.TP
+\fB\-d\fR, \fB\-\-daemonize\fR
+This will run a single chef\-server\-webui in the background\.
+.
+.TP
+\fB\-N\fR, \fB\-\-no\-daemonize\fR
+This will allow you to run a cluster in console mode\.
+.
+.TP
+\fB\-c\fR, \fB\-\-cluster\-nodes NUM_MERBS\fR
+Number of merb daemons to run for chef\-server\-webui\.
+.
+.TP
+\fB\-I\fR, \fB\-\-init\-file FILE\fR
+File to use for initialization on load, defaults to config/init\.rb\.
+.
+.TP
+\fB\-p\fR, \fB\-\-port PORTNUM\fR
+Port to run chef\-server\-webui on, defaults to 4040\. Additional nodes (\-c) listen on incrementing port numbers\.
+.
+.TP
+\fB\-o\fR, \fB\-\-socket\-file FILE\fR
+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 \fIonly\fR if you \fImust\fR\.
+.
+.TP
+\fB\-s\fR, \fB\-\-socket SOCKNUM\fR
+Socket number to run chef\-server\-webui on, defaults to 0\.
+.
+.TP
+\fB\-n\fR, \fB\-\-name NAME\fR
+Set the name of the application\. This is used in the process title and log file names\.
+.
+.TP
+\fB\-P\fR, \fB\-\-pid PIDFILE\fR
+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: \-P myapp\.%s\.pid\.
+.
+.TP
+\fB\-h\fR, \fB\-\-host HOSTNAME\fR
+Host to bind to (default is 0\.0\.0\.0)\.
+.
+.TP
+\fB\-m\fR, \fB\-\-merb\-root PATH_TO_APP_ROOT\fR
+The path to the Merb\.root for the app you want to run (default is current working directory)\.
+.
+.TP
+\fB\-a\fR, \fB\-\-adapter ADAPTER\fR
+The rack adapter to use to run chef\-server\-webui (default is mongrel) [mongrel, emongrel, thin, ebb, fastcgi, webrick]\.
+.
+.TP
+\fB\-R\fR, \fB\-\-rackup FILE\fR
+Load an alternate Rack config file (default is config/rack\.rb)\.
+.
+.TP
+\fB\-i\fR, \fB\-\-irb\-console\fR
+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\.
+.
+.TP
+\fB\-S\fR, \fB\-\-sandbox\fR
+This flag will enable a sandboxed irb console\. If your ORM supports transactions, all edits will be rolled back on exit\.
+.
+.TP
+\fB\-l\fR, \fB\-\-log\-level LEVEL\fR
+Log levels can be set to any of these options: debug < info < warn < error < fatal (default is info)\.
+.
+.TP
+\fB\-L\fR, \fB\-\-log LOGFILE\fR
+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\.
+.
+.TP
+\fB\-e\fR, \fB\-\-environment STRING\fR
+Environment to run Merb under [development, production, testing] (default is development)\.
+.
+.TP
+\fB\-r\fR, \fB\-\-script\-runner [\'RUBY CODE\'| FULL_SCRIPT_PATH]\fR
+Command\-line option to run scripts and/or code in the chef\-server\-webui app\.
+.
+.TP
+\fB\-K\fR, \fB\-graceful PORT or all\fR
+Gracefully kill chef\-server\-webui proceses by port number\. Use chef\-server \-K all to gracefully kill all merbs\.
+.
+.TP
+\fB\-k\fR, \fB\-\-kill PORT\fR
+Force kill one merb worker by port number\. This will cause the worker to be respawned\.
+.
+.TP
+\fB\-\-fast\-deploy\fR
+Reload the code, but not yourinit\.rb or gems\.
+.
+.TP
+\fB\-X\fR, \fB\-\-mutex on/off\fR
+This flag is for turning the mutex lock on and off\.
+.
+.TP
+\fB\-D\fR, \fB\-\-debugger\fR
+Run chef\-server\-webui using rDebug\.
+.
+.TP
+\fB\-V\fR, \fB\-\-verbose\fR
+Print extra information\.
+.
+.TP
+\fB\-C\fR, \fB\-\-console\-trap\fR
+Enter an irb console on ^C\.
+.
+.TP
+\fB\-?\fR, \fB\-H\fR, \fB\-\-help\fR
+Show this help message\.
+.
+.SH "DESCRIPTION"
+The Chef Server provides a central point for the distribution of Cookbooks, management and authentication of Nodes, and the use of Search\. It provides a REST API\.
+.
+.P
+The API service is what clients use to interact with the server to manage node configuration in Chef\. By default, the service is started on port 4000 as a Merb application slice running with the thin server adapter\.
+.
+.P
+The two methods of interaction with the API for humans are the command\-line tool Knife and the Management Console\. The Chef Client library is used for interacting with the API for client nodes\.
+.
+.SH "SEE ALSO"
+\fBchef\-client\fR(8) \fBchef\-server\-webui\fR(8) \fBknife\fR(1)
+.
+.P
+Full documentation for Chef and chef\-server is located on the Chef wiki, http://wiki\.opscode\.com/display/chef/Home\.
+.
+.SH "AUTHOR"
+Chef was written by Adam Jacob \fIadam@ospcode\.com\fR of Opscode (http://www\.opscode\.com), with contributions from the community\. This manual page was written by Joshua Timberman \fIjoshua@opscode\.com\fR with help2man\. Permission is granted to copy, distribute and / or modify this document under the terms of the Apache 2\.0 License\.
+.
+.P
+On Debian systems, the complete text of the Apache 2\.0 License can be found in /usr/share/common\-licenses/Apache\-2\.0\.