Changeset - 68aaa0aca0d2
[Not reviewed]
beta
0 1 0
Marcin Kuzminski - 15 years ago 2010-12-27 15:30:04
marcin@python-works.com
Updated docs, added apache proxy example config
1 file changed with 34 insertions and 8 deletions:
0 comments (0 inline, 0 general)
docs/setup.rst
Show inline comments
 
@@ -133,136 +133,162 @@ If all data are entered correctly, and `
 
Users should be granted to access RhodeCode wit ldap accounts. When 
 
logging at the first time an special ldap account is created inside RhodeCode, 
 
so You can control over permissions even on ldap users. If such user exists 
 
already in RhodeCode database ldap user with the same username would be not 
 
able to access RhodeCode.
 

	
 
If You have problems with ldap access and believe You entered correct 
 
information check out the RhodeCode logs,any error messages sent from 
 
ldap will be saved there.
 

	
 

	
 

	
 
Setting Up Celery
 
-----------------
 

	
 
Since version 1.1 celery is configured by the rhodecode ini configuration files
 
simply set use_celery=true in the ini file then add / change the configuration 
 
variables inside the ini file.
 

	
 
Remember that the ini files uses format with '.' not with '_' like celery
 
so for example setting `BROKER_HOST` in celery means setting `broker.host` in
 
the config file.
 

	
 
In order to make start using celery run::
 
 paster celeryd <configfile.ini>
 

	
 

	
 

	
 
.. note::
 
   Make sure You run this command from same virtualenv, and with the same user
 
   that rhodecode runs.
 

	
 

	
 
Nginx virtual host example
 
--------------------------
 

	
 
Sample config for nginx using proxy::
 

	
 
 server {
 
    listen          80;
 
    server_name     hg.myserver.com;
 
    access_log      /var/log/nginx/rhodecode.access.log;
 
    error_log       /var/log/nginx/rhodecode.error.log;
 
    location / {
 
            root /var/www/rhodecode/rhodecode/public/;
 
            if (!-f $request_filename){
 
                proxy_pass      http://127.0.0.1:5000;
 
            }
 
            #this is important for https !!!
 
            #this is important if You want to use https !!!
 
            proxy_set_header X-Url-Scheme $scheme;
 
            include         /etc/nginx/proxy.conf;  
 
    }
 
 }  
 
  
 
Here's the proxy.conf. It's tuned so it'll not timeout on long
 
pushes and also on large pushes::
 

	
 
    proxy_redirect              off;
 
    proxy_set_header            Host $host;
 
    proxy_set_header            X-Host $http_host;
 
    proxy_set_header            X-Real-IP $remote_addr;
 
    proxy_set_header            X-Forwarded-For $proxy_add_x_forwarded_for;
 
    proxy_set_header            Proxy-host $proxy_host;
 
    client_max_body_size        400m;
 
    client_body_buffer_size     128k;
 
    proxy_buffering             off;
 
    proxy_connect_timeout       3600;
 
    proxy_send_timeout          3600;
 
    proxy_read_timeout          3600;
 
    proxy_buffer_size           8k;
 
    proxy_buffers               8 32k;
 
    proxy_busy_buffers_size     64k;
 
    proxy_temp_file_write_size  64k;
 
 
 
Also when using root path with nginx You might set the static files to false
 
in production.ini file::
 

	
 
  [app:main]
 
    use = egg:rhodecode
 
    full_stack = true
 
    static_files = false
 
    lang=en
 
    cache_dir = %(here)s/data
 

	
 
To not have the statics served by the application. And improve speed.
 

	
 
Apache reverse proxy
 
--------------------
 
Tutorial can be found here
 

	
 
Apache virtual host example
 
---------------------------
 

	
 
Sample config for apache using proxy::
 

	
 
<VirtualHost *:80>
 
        ServerName hg.myserver.com
 
        ServerAlias hg.myserver.com
 

	
 
        <Proxy *>
 
          Order allow,deny
 
          Allow from all
 
        </Proxy>
 

	
 
        #important !
 
        #Directive to properly generate url (clone url) for pylons
 
        ProxyPreserveHost On
 

	
 
        #rhodecode instance
 
        ProxyPass / http://127.0.0.1:5000/
 
        ProxyPassReverse / http://127.0.0.1:5000/
 
        
 
        #to enable https use line below
 
        #SetEnvIf X-Url-Scheme https HTTPS=1
 
        
 
</VirtualHost> 
 

	
 

	
 
Additional tutorial
 
http://wiki.pylonshq.com/display/pylonscookbook/Apache+as+a+reverse+proxy+for+Pylons
 

	
 

	
 
Apache's example FCGI config
 
----------------------------
 

	
 
TODO !
 

	
 
Other configuration files
 
-------------------------
 

	
 
Some extra configuration files and examples can be found here:
 
http://hg.python-works.com/rhodecode/files/tip/init.d
 
Some example init.d script can be found here, for debian and gentoo:
 

	
 
and also an celeryconfig file can be use from here:
 
http://hg.python-works.com/rhodecode/files/tip/celeryconfig.py
 
https://rhodeocode.org/rhodecode/files/tip/init.d
 

	
 

	
 
Troubleshooting
 
---------------
 

	
 
- missing static files ?
 

	
 
 - make sure either to set the `static_files = true` in the .ini file or
 
   double check the root path for Your http setup. It should point to 
 
   for example:
 
   /home/my-virtual-python/lib/python2.6/site-packages/rhodecode/public
 
   
 
- can't install celery/rabbitmq
 

	
 
 - don't worry RhodeCode works without them too. No extra setup required
 

	
 
- long lasting push timeouts ?
 

	
 
 - make sure You set a longer timeouts in Your proxy/fcgi settings, timeouts
 
   are caused by https server and not RhodeCode
 

	
 
- large pushes timeouts ?
 
 
 
 - make sure You set a proper max_body_size for the http server
 

	
 

	
 

	
 
.. _virtualenv: http://pypi.python.org/pypi/virtualenv
 
.. _python: http://www.python.org/
 
.. _mercurial: http://mercurial.selenic.com/
 
.. _celery: http://celeryproject.org/
 
.. _rabbitmq: http://www.rabbitmq.com/
 
\ No newline at end of file
0 comments (0 inline, 0 general)