diff options
Diffstat (limited to 'distro/common/html/chef-server.8.html')
| -rw-r--r-- | distro/common/html/chef-server.8.html | 182 |
1 files changed, 182 insertions, 0 deletions
diff --git a/distro/common/html/chef-server.8.html b/distro/common/html/chef-server.8.html new file mode 100644 index 0000000000..6613b6c90f --- /dev/null +++ b/distro/common/html/chef-server.8.html @@ -0,0 +1,182 @@ +<!DOCTYPE html> +<html> +<head> + <meta http-equiv='content-type' value='text/html;charset=utf8'> + <meta name='generator' value='Ronn/v0.7.3 (http://github.com/rtomayko/ronn/tree/0.7.3)'> + <title>chef-server(8) - Start the Chef Server merb application slice.</title> + <style type='text/css' media='all'> + /* style: man */ + body#manpage {margin:0} + .mp {max-width:100ex;padding:0 9ex 1ex 4ex} + .mp p,.mp pre,.mp ul,.mp ol,.mp dl {margin:0 0 20px 0} + .mp h2 {margin:10px 0 0 0} + .mp > p,.mp > pre,.mp > ul,.mp > ol,.mp > dl {margin-left:8ex} + .mp h3 {margin:0 0 0 4ex} + .mp dt {margin:0;clear:left} + .mp dt.flush {float:left;width:8ex} + .mp dd {margin:0 0 0 9ex} + .mp h1,.mp h2,.mp h3,.mp h4 {clear:left} + .mp pre {margin-bottom:20px} + .mp pre+h2,.mp pre+h3 {margin-top:22px} + .mp h2+pre,.mp h3+pre {margin-top:5px} + .mp img {display:block;margin:auto} + .mp h1.man-title {display:none} + .mp,.mp code,.mp pre,.mp tt,.mp kbd,.mp samp,.mp h3,.mp h4 {font-family:monospace;font-size:14px;line-height:1.42857142857143} + .mp h2 {font-size:16px;line-height:1.25} + .mp h1 {font-size:20px;line-height:2} + .mp {text-align:justify;background:#fff} + .mp,.mp code,.mp pre,.mp pre code,.mp tt,.mp kbd,.mp samp {color:#131211} + .mp h1,.mp h2,.mp h3,.mp h4 {color:#030201} + .mp u {text-decoration:underline} + .mp code,.mp strong,.mp b {font-weight:bold;color:#131211} + .mp em,.mp var {font-style:italic;color:#232221;text-decoration:none} + .mp a,.mp a:link,.mp a:hover,.mp a code,.mp a pre,.mp a tt,.mp a kbd,.mp a samp {color:#0000ff} + .mp b.man-ref {font-weight:normal;color:#434241} + .mp pre {padding:0 4ex} + .mp pre code {font-weight:normal;color:#434241} + .mp h2+pre,h3+pre {padding-left:0} + ol.man-decor,ol.man-decor li {margin:3px 0 10px 0;padding:0;float:left;width:33%;list-style-type:none;text-transform:uppercase;color:#999;letter-spacing:1px} + ol.man-decor {width:100%} + ol.man-decor li.tl {text-align:left} + ol.man-decor li.tc {text-align:center;letter-spacing:4px} + ol.man-decor li.tr {text-align:right;float:right} + </style> + <style type='text/css' media='all'> + /* style: toc */ + .man-navigation {display:block !important;position:fixed;top:0;left:113ex;height:100%;width:100%;padding:48px 0 0 0;border-left:1px solid #dbdbdb;background:#eee} + .man-navigation a,.man-navigation a:hover,.man-navigation a:link,.man-navigation a:visited {display:block;margin:0;padding:5px 2px 5px 30px;color:#999;text-decoration:none} + .man-navigation a:hover {color:#111;text-decoration:underline} + </style> +</head> +<!-- + The following styles are deprecated and will be removed at some point: + div#man, div#man ol.man, div#man ol.head, div#man ol.man. + + The .man-page, .man-decor, .man-head, .man-foot, .man-title, and + .man-navigation should be used instead. +--> +<body id='manpage'> + <div class='mp' id='man'> + + <div class='man-navigation' style='display:none'> + <a href="#NAME">NAME</a> + <a href="#SYNOPSIS">SYNOPSIS</a> + <a href="#DESCRIPTION">DESCRIPTION</a> + <a href="#SEE-ALSO">SEE ALSO</a> + <a href="#AUTHOR">AUTHOR</a> + </div> + + <ol class='man-decor man-head man head'> + <li class='tl'>chef-server(8)</li> + <li class='tc'>Chef Manual</li> + <li class='tr'>chef-server(8)</li> + </ol> + + <h2 id="NAME">NAME</h2> +<p class="man-name"> + <code>chef-server</code> - <span class="man-whatis">Start the Chef Server merb application slice.</span> +</p> + +<h2 id="SYNOPSIS">SYNOPSIS</h2> + +<p><strong>chef-server</strong> <em>(options)</em></p> + +<dl> +<dt><code>-u</code>, <code>--user USER</code></dt><dd>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.</dd> +<dt><code>-G</code>, <code>--group GROUP</code></dt><dd>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.</dd> +<dt><code>-d</code>, <code>--daemonize</code></dt><dd>This will run a single chef-server-webui in the background.</dd> +<dt><code>-N</code>, <code>--no-daemonize</code></dt><dd>This will allow you to run a cluster in console mode.</dd> +<dt><code>-c</code>, <code>--cluster-nodes NUM_MERBS</code></dt><dd>Number of merb daemons to run for chef-server-webui.</dd> +<dt><code>-I</code>, <code>--init-file FILE</code></dt><dd>File to use for initialization on load, defaults to config/init.rb.</dd> +<dt><code>-p</code>, <code>--port PORTNUM</code></dt><dd>Port to run chef-server-webui on, defaults to 4040. Additional nodes (-c) +listen on incrementing port numbers.</dd> +<dt><code>-o</code>, <code>--socket-file FILE</code></dt><dd>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 <em>only</em> if you <em>must</em>.</dd> +<dt><code>-s</code>, <code>--socket SOCKNUM</code></dt><dd>Socket number to run chef-server-webui on, defaults to 0.</dd> +<dt><code>-n</code>, <code>--name NAME</code></dt><dd>Set the name of the application. This is used in the process title and +log file names.</dd> +<dt><code>-P</code>, <code>--pid PIDFILE</code></dt><dd>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.</dd> +<dt><code>-h</code>, <code>--host HOSTNAME</code></dt><dd>Host to bind to (default is 0.0.0.0).</dd> +<dt><code>-m</code>, <code>--merb-root PATH_TO_APP_ROOT</code></dt><dd>The path to the Merb.root for the app you want to run +(default is current working directory).</dd> +<dt><code>-a</code>, <code>--adapter ADAPTER</code></dt><dd>The rack adapter to use to run chef-server-webui (default is mongrel) +[mongrel, emongrel, thin, ebb, fastcgi, webrick].</dd> +<dt><code>-R</code>, <code>--rackup FILE</code></dt><dd>Load an alternate Rack config file (default is config/rack.rb).</dd> +<dt><code>-i</code>, <code>--irb-console</code></dt><dd>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.</dd> +<dt><code>-S</code>, <code>--sandbox</code></dt><dd>This flag will enable a sandboxed irb console. If your ORM supports +transactions, all edits will be rolled back on exit.</dd> +<dt><code>-l</code>, <code>--log-level LEVEL</code></dt><dd>Log levels can be set to any of these options: +debug < info < warn < error < fatal (default is info).</dd> +<dt><code>-L</code>, <code>--log LOGFILE</code></dt><dd>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.</dd> +<dt><code>-e</code>, <code>--environment STRING</code></dt><dd>Environment to run Merb under [development, production, testing] +(default is development).</dd> +<dt><code>-r</code>, <code>--script-runner ['RUBY CODE'| FULL_SCRIPT_PATH]</code></dt><dd>Command-line option to run scripts and/or code in the chef-server-webui +app.</dd> +<dt><code>-K</code>, <code>-graceful PORT or all</code></dt><dd>Gracefully kill chef-server-webui proceses by port number. +Use chef-server -K all to gracefully kill all merbs.</dd> +<dt><code>-k</code>, <code>--kill PORT</code></dt><dd>Force kill one merb worker by port number. This will cause the worker +to be respawned.</dd> +<dt><code>--fast-deploy</code></dt><dd>Reload the code, but not yourinit.rb or gems.</dd> +<dt><code>-X</code>, <code>--mutex on/off</code></dt><dd>This flag is for turning the mutex lock on and off.</dd> +<dt><code>-D</code>, <code>--debugger</code></dt><dd>Run chef-server-webui using rDebug.</dd> +<dt><code>-V</code>, <code>--verbose</code></dt><dd>Print extra information.</dd> +<dt><code>-C</code>, <code>--console-trap</code></dt><dd>Enter an irb console on ^C.</dd> +<dt><code>-?</code>, <code>-H</code>, <code>--help</code></dt><dd>Show this help message.</dd> +</dl> + + +<h2 id="DESCRIPTION">DESCRIPTION</h2> + +<p>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> + +<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> + +<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.</p> + +<h2 id="SEE-ALSO">SEE ALSO</h2> + +<p><strong>chef-client</strong>(8) +<strong>chef-server-webui</strong>(8) +<strong>knife</strong>(1)</p> + +<p>Full documentation for Chef and chef-server is located on the Chef +wiki, http://wiki.opscode.com/display/chef/Home.</p> + +<h2 id="AUTHOR">AUTHOR</h2> + +<p>Chef was written by Adam Jacob <a href="mailto:adam@ospcode.com" data-bare-link="true">adam@ospcode.com</a> of Opscode +(http://www.opscode.com), with contributions from the community. This +manual page was written by Joshua Timberman <a href="mailto:joshua@opscode.com" data-bare-link="true">joshua@opscode.com</a> with +help2man. Permission is granted to copy, distribute and / or modify +this document under the terms of the Apache 2.0 License.</p> + +<p>On Debian systems, the complete text of the Apache 2.0 License can be +found in /usr/share/common-licenses/Apache-2.0.</p> + + + <ol class='man-decor man-foot man foot'> + <li class='tl'>Chef 11.0.0.alpha</li> + <li class='tc'>September 2012</li> + <li class='tr'>chef-server(8)</li> + </ol> + + </div> +</body> +</html> |