comparison docs/setup.rst @ 1408:93cffcb6fd54 beta

Adding documentation for indexer's self-resolving repos location.
author Jared Bunting <jared.bunting@peachjean.com>
date Fri, 01 Jul 2011 17:46:01 -0500
parents 00b8fca6886c
children a2fe0ac8d007
comparison
equal deleted inserted replaced
1407:2744f5b01d00 1408:93cffcb6fd54
101 Setting up Whoosh full text search 101 Setting up Whoosh full text search
102 ---------------------------------- 102 ----------------------------------
103 103
104 Starting from version 1.1 the whoosh index can be build by using the paster 104 Starting from version 1.1 the whoosh index can be build by using the paster
105 command ``make-index``. To use ``make-index`` you must specify the configuration 105 command ``make-index``. To use ``make-index`` you must specify the configuration
106 file that stores the location of the index, and the location of the repositories 106 file that stores the location of the index. You may specify the location of the
107 (`--repo-location`).Starting from version 1.2 it is 107 repositories (`--repo-location`). If not specified, this value is retrieved
108 also possible to specify a comma separated list of repositories (`--index-only`) 108 from the RhodeCode database. This was required prior to 1.2. Starting from
109 to build index only on chooses repositories skipping any other found in repos 109 version 1.2 it is also possible to specify a comma separated list of
110 location 110 repositories (`--index-only`) to build index only on chooses repositories
111 skipping any other found in repos location
111 112
112 You may optionally pass the option `-f` to enable a full index rebuild. Without 113 You may optionally pass the option `-f` to enable a full index rebuild. Without
113 the `-f` option, indexing will run always in "incremental" mode. 114 the `-f` option, indexing will run always in "incremental" mode.
114 115
115 For an incremental index build use:: 116 For an incremental index build use::
116 117
117 paster make-index production.ini --repo-location=<location for repos> 118 paster make-index production.ini
118 119
119 For a full index rebuild use:: 120 For a full index rebuild use::
120 121
121 paster make-index production.ini -f --repo-location=<location for repos> 122 paster make-index production.ini -f
122 123
123 124
124 building index just for chosen repositories is possible with such command:: 125 building index just for chosen repositories is possible with such command::
125 126
126 paster make-index production.ini --repo-location=<location for repos> --index-only=vcs,rhodecode 127 paster make-index production.ini --index-only=vcs,rhodecode
127 128
128 129
129 In order to do periodical index builds and keep your index always up to date. 130 In order to do periodical index builds and keep your index always up to date.
130 It's recommended to do a crontab entry for incremental indexing. 131 It's recommended to do a crontab entry for incremental indexing.
131 An example entry might look like this:: 132 An example entry might look like this::
132 133
133 /path/to/python/bin/paster /path/to/rhodecode/production.ini --repo-location=<location for repos> 134 /path/to/python/bin/paster make-index /path/to/rhodecode/production.ini
134 135
135 When using incremental mode (the default) whoosh will check the last 136 When using incremental mode (the default) whoosh will check the last
136 modification date of each file and add it to be reindexed if a newer file is 137 modification date of each file and add it to be reindexed if a newer file is
137 available. The indexing daemon checks for any removed files and removes them 138 available. The indexing daemon checks for any removed files and removes them
138 from index. 139 from index.