summaryrefslogtreecommitdiff
path: root/distro/common/html/chef-solr.8.html
blob: 0e13c25d900f3fc55aa6af4442f9df59b294a83c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
<!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-solr(8) - Runs as Chef's search server</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-solr(8)</li>
    <li class='tc'>Chef Manual</li>
    <li class='tr'>chef-solr(8)</li>
  </ol>

  <h2 id="NAME">NAME</h2>
<p class="man-name">
  <code>chef-solr</code> - <span class="man-whatis">Runs as Chef's search server</span>
</p>

<h2 id="SYNOPSIS">SYNOPSIS</h2>

<p><strong>chef-solr</strong> <em>(options)</em></p>

<dl>
<dt><code>-c</code>, <code>--config CONFIG</code></dt><dd>The configuration file to use</dd>
<dt><code>-d</code>, <code>--daemonize</code></dt><dd>Daemonize the process</dd>
<dt><code>-g</code>, <code>--group GROUP</code></dt><dd>Group to set privilege to</dd>
<dt><code>-l</code>, <code>--log_level LEVEL</code></dt><dd>Set the log level (debug, info, warn, error, fatal)</dd>
<dt><code>-L</code>, <code>--logfile LOGLOCATION</code></dt><dd>Set the log file location, defaults to STDOUT - recommended for daemonizing</dd>
<dt><code>-P</code>, <code>--pid PIDFILE</code></dt><dd>Set the PID file location, defaults to /tmp/chef-solr.pid</dd>
<dt><code>-D</code>, <code>--solr-data-dir PATH</code></dt><dd>Where the Solr data lives</dd>
<dt><code>-x</code>, <code>--solor-heap-size SIZE</code></dt><dd>Set the size of the Java Heap</dd>
<dt><code>-H</code>, <code>--solr-home-dir PATH</code></dt><dd>Solr home directory</dd>
<dt><code>-j</code>, <code>--java-opts OPTS</code></dt><dd>Raw options passed to Java</dd>
<dt><code>-x</code>, <code>--solor-heap-size</code></dt><dd>Set the size of the Java Heap</dd>
<dt><code>-W</code>, <code>--solr-jetty-dir PATH</code></dt><dd>Where to place the Solr Jetty instance</dd>
<dt><code>-u</code>, <code>--user USER</code></dt><dd>User to set privilege to</dd>
<dt><code>-v</code>, <code>--version</code></dt><dd>Show chef-solr version</dd>
<dt><code>-h</code>, <code>--help</code></dt><dd>Show this message</dd>
</dl>


<h2 id="DESCRIPTION">DESCRIPTION</h2>

<p>Chef-solr provides search service for Chef. You need to have both
chef-solr and chef-expander-cluster running in order for search to work.</p>

<p><strong>Installation</strong></p>

<p>Make sure you backed up your data if you are upgrading from a previous version.
Run chef-solr-installer to upgrade your Chef Solr installation. Answer "yes"
when prompted for confirmation. The process should look like this:</p>

<pre><code>yourshell&gt; chef-solr-installer
Configuration setting solr_heap_size is unknown and will be ignored

Chef Solr is already installed in /var/chef/solr
Do you want to overwrite the current install? All existing Solr data will be lost. [y/n] y
Removing the existing Chef Solr installation
  rm -rf /var/chef/solr
  rm -rf /var/chef/solr-jetty
  rm -rf /var/chef/solr/data
Creating Solr Home Directory
  mkdir -p /var/chef/solr
  entering /var/chef/solr
  tar zxvf /Users/ddeleo/opscode/chef/chef-solr/solr/solr-home.tar.gz
Creating Solr Data Directory
  mkdir -p /var/chef/solr/data
Unpacking Solr Jetty
  mkdir -p /var/chef/solr-jetty
  entering /var/chef/solr-jetty
  tar zxvf /Users/ddeleo/opscode/chef/chef-solr/solr/solr-jetty.tar.gz

Successfully installed Chef Solr.
You can restore your search index using `knife index rebuild`
</code></pre>

<h2 id="SEE-ALSO">SEE ALSO</h2>

<p><strong>chef-expander-cluster</strong>(8)</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="&#109;&#x61;&#105;&#108;&#x74;&#x6f;&#x3a;&#97;&#x64;&#x61;&#109;&#64;&#111;&#x73;&#x70;&#99;&#x6f;&#100;&#101;&#46;&#99;&#x6f;&#x6d;" data-bare-link="true">&#97;&#100;&#97;&#109;&#x40;&#x6f;&#115;&#112;&#99;&#111;&#x64;&#101;&#x2e;&#99;&#x6f;&#109;</a> of Opscode
(http://www.opscode.com),  with contributions from the community.  This
manual page was written by Joshua Timberman  <a href="&#x6d;&#97;&#105;&#108;&#116;&#x6f;&#x3a;&#106;&#x6f;&#x73;&#104;&#x75;&#97;&#x40;&#111;&#112;&#115;&#x63;&#111;&#x64;&#101;&#x2e;&#x63;&#111;&#x6d;" data-bare-link="true">&#106;&#111;&#115;&#x68;&#x75;&#97;&#64;&#x6f;&#x70;&#115;&#x63;&#111;&#100;&#101;&#x2e;&#x63;&#111;&#109;</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-solr(8)</li>
  </ol>

  </div>
</body>
</html>