doc fix

docs/changelog.rst

@@ -1,161 +1,161 b''
 .. _changelog:
 
 Changelog
 =========
 
 1.2.0 (**2011-XX-XX**)
-----------------------
+======================
 
 :status: in-progress
 :branch: beta
 
 news
-++++
+----
 
 - implemented #89 Can setup google analytics code from settings menu
 - implemented #91 added nicer looking archive urls
 - implemented #44 into file browsing, and added follow branch option
 - anonymous repository can be cloned without having to pass default:default
   into clone url
 - fixed #90 whoosh indexer can index chooses repositories passed in command 
   line
 
 fixes
-++++
+-----
 
 - fixed file browser bug, when switching into given form revision the url was 
   not changing
 - fixed propagation to error controller on simplehg and simplegit middlewares
 
 
 1.1.1 (**2011-01-06**)
-----------------------
+======================
  
 news
-++++
+----
 
 - added force https option into ini files for easier https usage (no need to
   set server headers with this options)
 - small css updates
 
 fixes
-++++
+-----
 
 - fixed #96 redirect loop on files view on repositories without changesets
 - fixed #97 unicode string passed into server header in special cases (mod_wsgi)
   and server crashed with errors
 - fixed large tooltips problems on main page
 - fixed #92 whoosh indexer is more error proof
 
 1.1.0 (**2010-12-18**)
-----------------------
+======================
 
 news
-++++
+----
 
 - rewrite of internals for vcs >=0.1.10
 - uses mercurial 1.7 with dotencode disabled for maintaining compatibility 
   with older clients
 - anonymous access, authentication via ldap
 - performance upgrade for cached repos list - each repository has it's own 
   cache that's invalidated when needed.
 - performance upgrades on repositories with large amount of commits (20K+)
 - main page quick filter for filtering repositories
 - user dashboards with ability to follow chosen repositories actions
 - sends email to admin on new user registration
 - added cache/statistics reset options into repository settings
 - more detailed action logger (based on hooks) with pushed changesets lists
   and options to disable those hooks from admin panel
 - introduced new enhanced changelog for merges that shows more accurate results
 - new improved and faster code stats (based on pygments lexers mapping tables, 
   showing up to 10 trending sources for each repository. Additionally stats
   can be disabled in repository settings.
 - gui optimizations, fixed application width to 1024px
 - added cut off (for large files/changesets) limit into config files
 - whoosh, celeryd, upgrade moved to paster command
 - other than sqlite database backends can be used
 
 fixes
-+++++
+-----
 
 - fixes #61 forked repo was showing only after cache expired
 - fixes #76 no confirmation on user deletes
 - fixes #66 Name field misspelled
 - fixes #72 block user removal when he owns repositories
 - fixes #69 added password confirmation fields
 - fixes #87 RhodeCode crashes occasionally on updating repository owner
 - fixes #82 broken annotations on files with more than 1 blank line at the end
 - a lot of fixes and tweaks for file browser
 - fixed detached session issues
 - fixed when user had no repos he would see all repos listed in my account
 - fixed ui() instance bug when global hgrc settings was loaded for server 
   instance and all hgrc options were merged with our db ui() object
 - numerous small bugfixes
  
 (special thanks for TkSoh for detailed feedback)
 
 
 1.0.2 (**2010-11-12**)
-----------------------
+======================
 
 news
-++++
+----
 
 - tested under python2.7
 - bumped sqlalchemy and celery versions
 
 fixes
-+++++
+-----
 
 - fixed #59 missing graph.js
 - fixed repo_size crash when repository had broken symlinks
 - fixed python2.5 crashes.
 
 
 1.0.1 (**2010-11-10**)
-----------------------
+======================
 
 news
-++++
+----
 
 - small css updated
 
 fixes
-+++++
+-----
 
 - fixed #53 python2.5 incompatible enumerate calls
 - fixed #52 disable mercurial extension for web
 - fixed #51 deleting repositories don't delete it's dependent objects
 
 
 1.0.0 (**2010-11-02**)
-----------------------
+======================
 
 - security bugfix simplehg wasn't checking for permissions on commands
   other than pull or push.
 - fixed doubled messages after push or pull in admin journal
 - templating and css corrections, fixed repo switcher on chrome, updated titles
 - admin menu accessible from options menu on repository view
 - permissions cached queries
 
 1.0.0rc4  (**2010-10-12**)
---------------------------
+==========================
 
 - fixed python2.5 missing simplejson imports (thanks to Jens Bäckman)
 - removed cache_manager settings from sqlalchemy meta
 - added sqlalchemy cache settings to ini files
 - validated password length and added second try of failure on paster setup-app
 - fixed setup database destroy prompt even when there was no db
 
 
 1.0.0rc3 (**2010-10-11**)
--------------------------
+=========================
 
 - fixed i18n during installation.
 
 1.0.0rc2 (**2010-10-11**)
--------------------------
+=========================
 
 - Disabled dirsize in file browser, it's causing nasty bug when dir renames 
   occure. After vcs is fixed it'll be put back again.
 - templating/css rewrites, optimized css.
  No newline at end of file

docs/setup.rst

@@ -1,328 +1,328 b''
 .. _setup:
 
 Setup
 =====
 
 
 Setting up the application
 --------------------------
 
 First You'll ned to create RhodeCode config file. Run the following command 
 to do this
 
 ::
  
  paster make-config RhodeCode production.ini
 
 - This will create `production.ini` config inside the directory
   this config contains various settings for RhodeCode, e.g proxy port, 
   email settings, usage of static files, cache, celery settings and logging.
 
 
 
 Next we need to create the database.
 
 ::
 
  paster setup-app production.ini
 
 - This command will create all needed tables and an admin account. 
   When asked for a path You can either use a new location of one with already 
   existing ones. RhodeCode will simply add all new found repositories to 
   it's database. Also make sure You specify correct path to repositories.
 - Remember that the given path for mercurial_ repositories must be write 
   accessible for the application. It's very important since RhodeCode web 
   interface will work even without such an access but, when trying to do a 
   push it'll eventually fail with permission denied errors. 
 
 You are ready to use rhodecode, to run it simply execute
 
 ::
  
  paster serve production.ini
  
 - This command runs the RhodeCode server the app should be available at the 
   127.0.0.1:5000. This ip and port is configurable via the production.ini 
   file created in previous step
 - Use admin account you created to login.
 - Default permissions on each repository is read, and owner is admin. So 
   remember to update these if needed. In the admin panel You can toggle ldap,
   anonymous, permissions settings. As well as edit more advanced options on 
   users and repositories
   
 Using RhodeCode with SSH
 ------------------------
 
 RhodeCode repository structures are kept in directories with the same name 
 as the project, when using repository groups, each group is a a subdirectory.
 This will allow You to use ssh for accessing repositories quite easy. There
 are some exceptions when using ssh for accessing repositories.
 
 You have to make sure that the webserver as well as the ssh users have unix
 permission for directories. Secondly when using ssh rhodecode will not 
 authenticate those requests and permissions set by the web interface will not
 work on the repositories accessed via ssh. There is a solution to this to use 
 auth hooks, that connects to rhodecode db, and runs check functions for
 permissions.
 
 TODO: post more info on this !
 
 if Your main directory (the same as set in RhodeCode settings) is set to
 for example `\home\hg` and repository You are using is `rhodecode`
 
 The command runned should look like this::
  hg clone ssh://[e-mail]/home/hg/rhodecode
  
 Using external tools such as mercurial server or using ssh key based auth is
 fully supported.
     
 Setting up Whoosh full text search
 ----------------------------------
 
 Starting from version 1.1 whoosh index can be build using paster command.
 You have to specify the config file that stores location of index, and
 location of repositories (`--repo-location`). Starting from version 1.2 it is 
 also possible to specify a comma separated list of repositories (`--index-only`)
 to build index only on chooses repositories skipping any other found in repos
 location
 
 There is possible also to pass `-f` to the options
 to enable full index rebuild. Without that indexing will run always in in
 incremental mode.
 
 incremental mode::
 
  paster make-index production.ini --repo-location=<location for repos> 
 
 
 
 for full index rebuild You can use::
 
  paster make-index production.ini -f --repo-location=<location for repos>
 
 
 building index just for chosen repositories is possible with such command::
  
  paster make-index production.ini --repo-location=<location for repos> --index-only=vcs,rhodecode
 
 
 In order to do periodical index builds and keep Your index always up to date.
 It's recommended to do a crontab entry for incremental indexing. 
 An example entry might look like this
 
 ::
  
  /path/to/python/bin/paster /path/to/rhodecode/production.ini --repo-location=<location for repos> 
   
 When using incremental (default) mode whoosh will check last modification date 
 of each file and add it to reindex if newer file is available. Also indexing 
 daemon checks for removed files and removes them from index. 
 
 Sometime You might want to rebuild index from scratch. You can do that using 
 the `-f` flag passed to paster command or, in admin panel You can check 
 `build from scratch` flag.
 
 
 Setting up LDAP support
 -----------------------
 
 RhodeCode starting from version 1.1 supports ldap authentication. In order
 to use ldap, You have to install python-ldap package. This package is available
 via pypi, so You can install it by running
 
 ::
 
  easy_install python-ldap
  
 ::
 
  pip install python-ldap
 
 .. note::
    python-ldap requires some certain libs on Your system, so before installing 
    it check that You have at least `openldap`, and `sasl` libraries.
 
 ldap settings are located in admin->ldap section,
 
 Here's a typical ldap setup::
 
  Enable ldap  = checked                 #controls if ldap access is enabled
  Host         = host.domain.org         #actual ldap server to connect
  Port         = 389 or 689 for ldaps    #ldap server ports
  Enable LDAPS = unchecked               #enable disable ldaps
  Account      = <account>               #access for ldap server(if required)
  Password     = <password>              #password for ldap server(if required)
  Base DN      = uid=%(user)s,CN=users,DC=host,DC=domain,DC=org
  
 
 `Account` and `Password` are optional, and used for two-phase ldap 
 authentication so those are credentials to access Your ldap, if it doesn't 
 support anonymous search/user lookups. 
 
 Base DN must have %(user)s template inside, it's a placer where Your uid used
 to login would go, it allows admins to specify not standard schema for uid 
 variable
 
 If all data are entered correctly, and `python-ldap` is properly installed
 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 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 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> 
+    <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 example init.d script can be found here, for debian and gentoo:
 
 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