##// END OF EJS Templates
docs: updated docs about configuration of vcsserver.
marcink -
r1707:4b0fc208 default
parent child Browse files
Show More
@@ -7,7 +7,7 b' The VCS Server handles |RCM| backend fun'
7 a VCS Server to run with a |RCM| instance. If you do not, you will be missing
7 a VCS Server to run with a |RCM| instance. If you do not, you will be missing
8 the connection between |RCM| and its |repos|. This will cause error messages
8 the connection between |RCM| and its |repos|. This will cause error messages
9 on the web interface. You can run your setup in the following configurations,
9 on the web interface. You can run your setup in the following configurations,
10 currently the best performance is one VCS Server per |RCM| instance:
10 currently the best performance is one of following:
11
11
12 * One VCS Server per |RCM| instance.
12 * One VCS Server per |RCM| instance.
13 * One VCS Server handling multiple instances.
13 * One VCS Server handling multiple instances.
@@ -59,7 +59,8 b' instance in the'
59 \vcs.backends <available-vcs-systems>
59 \vcs.backends <available-vcs-systems>
60 Set a comma-separated list of the |repo| options available from the
60 Set a comma-separated list of the |repo| options available from the
61 web interface. The default is ``hg, git, svn``,
61 web interface. The default is ``hg, git, svn``,
62 which is all |repo| types available.
62 which is all |repo| types available. The order of backends is also the
63 order backend will try to detect requests type.
63
64
64 \vcs.connection_timeout <seconds>
65 \vcs.connection_timeout <seconds>
65 Set the length of time in seconds that the VCS Server waits for
66 Set the length of time in seconds that the VCS Server waits for
@@ -159,9 +160,10 b' for full details see the :ref:`RhodeCode'
159
160
160 - NAME: vcsserver-1
161 - NAME: vcsserver-1
161 - STATUS: RUNNING
162 - STATUS: RUNNING
162 - TYPE: VCSServer
163 logs:/home/ubuntu/.rccontrol/vcsserver-1/vcsserver.log
163 - VERSION: 1.0.0
164 - VERSION: 4.7.2 VCSServer
164 - URL: http://127.0.0.1:10001
165 - URL: http://127.0.0.1:10008
166 - CONFIG: /home/ubuntu/.rccontrol/vcsserver-1/vcsserver.ini
165
167
166 $ rccontrol restart vcsserver-1
168 $ rccontrol restart vcsserver-1
167 Instance "vcsserver-1" successfully stopped.
169 Instance "vcsserver-1" successfully stopped.
@@ -181,7 +183,9 b' For a more detailed explanation of the l'
181 .. rst-class:: dl-horizontal
183 .. rst-class:: dl-horizontal
182
184
183 \host <ip-address>
185 \host <ip-address>
184 Set the host on which the VCS Server will run.
186 Set the host on which the VCS Server will run. VCSServer is not
187 protected by any authentication, so we *highly* recommend running it
188 under localhost ip that is `127.0.0.1`
185
189
186 \port <int>
190 \port <int>
187 Set the port number on which the VCS Server will be available.
191 Set the port number on which the VCS Server will be available.
@@ -189,13 +193,22 b' For a more detailed explanation of the l'
189 \locale <locale_utf>
193 \locale <locale_utf>
190 Set the locale the VCS Server expects.
194 Set the locale the VCS Server expects.
191
195
192 \threadpool_size <int>
196 \workers <int>
193 Set the size of the threadpool used to communicate
197 Set the number of process workers.Recommended
194 with the WSGI workers. This should be at least 6 times the number of
198 value is (2 * NUMBER_OF_CPUS + 1), eg 2CPU = 5 workers
195 WSGI worker processes.
196
199
197 \timeout <seconds>
200 \max_requests <int>
198 Set the timeout for RPC communication in seconds.
201 The maximum number of requests a worker will process before restarting.
202 Any value greater than zero will limit the number of requests a work
203 will process before automatically restarting. This is a simple method
204 to help limit the damage of memory leaks.
205
206 \max_requests_jitter <int>
207 The maximum jitter to add to the max_requests setting.
208 The jitter causes the restart per worker to be randomized by
209 randint(0, max_requests_jitter). This is intended to stagger worker
210 restarts to avoid all workers restarting at the same time.
211
199
212
200 .. note::
213 .. note::
201
214
@@ -204,27 +217,54 b' For a more detailed explanation of the l'
204 .. code-block:: ini
217 .. code-block:: ini
205
218
206 ################################################################################
219 ################################################################################
207 # RhodeCode VCSServer - configuration #
220 # RhodeCode VCSServer with HTTP Backend - configuration #
208 # #
221 # #
209 ################################################################################
222 ################################################################################
210
223
211 [DEFAULT]
224
225 [server:main]
226 ## COMMON ##
212 host = 127.0.0.1
227 host = 127.0.0.1
213 port = 9900
228 port = 10002
229
230 ##########################
231 ## GUNICORN WSGI SERVER ##
232 ##########################
233 ## run with gunicorn --log-config vcsserver.ini --paste vcsserver.ini
234 use = egg:gunicorn#main
235 ## Sets the number of process workers. Recommended
236 ## value is (2 * NUMBER_OF_CPUS + 1), eg 2CPU = 5 workers
237 workers = 3
238 ## process name
239 proc_name = rhodecode_vcsserver
240 ## type of worker class, one of sync, gevent
241 ## recommended for bigger setup is using of of other than sync one
242 worker_class = sync
243 ## The maximum number of simultaneous clients. Valid only for Gevent
244 #worker_connections = 10
245 ## max number of requests that worker will handle before being gracefully
246 ## restarted, could prevent memory leaks
247 max_requests = 1000
248 max_requests_jitter = 30
249 ## amount of time a worker can spend with handling a request before it
250 ## gets killed and restarted. Set to 6hrs
251 timeout = 21600
252
253 [app:main]
254 use = egg:rhodecode-vcsserver
255
256 pyramid.default_locale_name = en
257 pyramid.includes =
258
259 ## default locale used by VCS systems
214 locale = en_US.UTF-8
260 locale = en_US.UTF-8
215 # number of worker threads, this should be set based on a formula threadpool=N*6
216 # where N is number of RhodeCode Enterprise workers, eg. running 2 instances
217 # 8 gunicorn workers each would be 2 * 8 * 6 = 96, threadpool_size = 96
218 threadpool_size = 16
219 timeout = 0
220
261
221 # cache regions, please don't change
262 # cache regions, please don't change
222 beaker.cache.regions = repo_object
263 beaker.cache.regions = repo_object
223 beaker.cache.repo_object.type = memorylru
264 beaker.cache.repo_object.type = memorylru
224 beaker.cache.repo_object.max_items = 1000
265 beaker.cache.repo_object.max_items = 100
225
226 # cache auto-expires after N seconds
266 # cache auto-expires after N seconds
227 beaker.cache.repo_object.expire = 10
267 beaker.cache.repo_object.expire = 300
228 beaker.cache.repo_object.enabled = true
268 beaker.cache.repo_object.enabled = true
229
269
230
270
@@ -270,20 +310,6 b' For a more detailed explanation of the l'
270 level = DEBUG
310 level = DEBUG
271 formatter = generic
311 formatter = generic
272
312
273 [handler_file]
274 class = FileHandler
275 args = ('vcsserver.log', 'a',)
276 level = DEBUG
277 formatter = generic
278
279 [handler_file_rotating]
280 class = logging.handlers.TimedRotatingFileHandler
281 # 'D', 5 - rotate every 5days
282 # you can set 'h', 'midnight'
283 args = ('vcsserver.log', 'D', 5, 10,)
284 level = DEBUG
285 formatter = generic
286
287 ################
313 ################
288 ## FORMATTERS ##
314 ## FORMATTERS ##
289 ################
315 ################
General Comments 0
You need to be logged in to leave comments. Login now