################################################################################

################################################################################

# rhodecode - Pylons environment configuration                                    #

#                                                                              # 

# The %(here)s variable will be replaced with the parent directory of this file#

################################################################################

[DEFAULT]

debug = true

################################################################################

## Uncomment and replace with the address which should receive                ## 

## any error reports after application crash								  ##

## Additionally those settings will be used by rhodecode mailing system          ##

################################################################################

#email_to = admin@localhost

#error_email_from = paste_error@localhost

#app_email_from = rhodecode-noreply@localhost

#error_message =

#smtp_server = mail.server.com

#smtp_username = 

#smtp_password =

#smtp_port = 

#smtp_use_tls = 

[server:main]

##nr of threads to spawn

threadpool_workers = 5

##max request before

threadpool_max_requests = 6

##option to use threads of process

use_threadpool = false

use = egg:Paste#http

host = 127.0.0.1

port = 5000

[app:main]

use = egg:rhodecode

full_stack = true

static_files = true

lang=en

cache_dir = %(here)s/data

####################################

###         BEAKER CACHE        ####

####################################

 beaker.cache.data_dir=/%(here)s/data/cache/data

 beaker.cache.lock_dir=/%(here)s/data/cache/lock

 beaker.cache.regions=super_short_term,short_term,long_term,sql_cache_short,sql_cache_med,sql_cache_long

 beaker.cache.short_term.type=memory

 beaker.cache.short_term.expire=60

 beaker.cache.sql_cache_short.type=memory

 beaker.cache.sql_cache_short.expire=5

 beaker.cache.sql_cache_med.type=memory

 beaker.cache.sql_cache_med.expire=360

 beaker.cache.sql_cache_long.type=file

 beaker.cache.sql_cache_long.expire=3600

####################################

###       BEAKER SESSION        ####

####################################

## Type of storage used for the session, current types are 

## "dbm", "file", "memcached", "database", and "memory". 

## The storage uses the Container API 

##that is also used by the cache system.

beaker.session.type = file

beaker.session.key = rhodecode

beaker.session.secret = g654dcno0-9873jhgfreyu

beaker.session.timeout = 36000

##auto save the session to not to use .save()

beaker.session.auto = False

##true exire at browser close

#beaker.session.cookie_expires = 3600

################################################################################

## WARNING: *THE LINE BELOW MUST BE UNCOMMENTED ON A PRODUCTION ENVIRONMENT*  ##

## Debug mode will enable the interactive debugging tool, allowing ANYONE to  ##

## execute malicious code after an exception is raised.                       ##

################################################################################

#set debug = false

##################################

###       LOGVIEW CONFIG       ###

##################################

logview.sqlalchemy = #faa

logview.pylons.templating = #bfb

logview.pylons.util = #eee

#########################################################

### DB CONFIGS - EACH DB WILL HAVE IT'S OWN CONFIG    ###

#########################################################

sqlalchemy.db1.url = sqlite:///%(here)s/rhodecode.db

#sqlalchemy.db1.echo = False

#sqlalchemy.db1.pool_recycle = 3600

sqlalchemy.convert_unicode = true

################################

### LOGGING CONFIGURATION   ####

################################

[loggers]

keys = root, routes, rhodecode, sqlalchemy

[handlers]

keys = console

[formatters]

keys = generic,color_formatter

#############

## LOGGERS ##

#############

[logger_root]

level = NOTSET

handlers = console

[logger_routes]

level = DEBUG

handlers = console

qualname = routes.middleware

# "level = DEBUG" logs the route matched and routing variables.

[logger_rhodecode]

level = DEBUG

handlers = console

qualname = rhodecode

propagate = 0

[logger_sqlalchemy]

level = ERROR

handlers = console

qualname = sqlalchemy.engine

propagate = 0

##############

## HANDLERS ##

##############

[handler_console]

class = StreamHandler

args = (sys.stderr,)

level = NOTSET

formatter = color_formatter

################

## FORMATTERS ##

################

[formatter_generic]

format = %(asctime)s.%(msecs)03d %(levelname)-5.5s [%(name)s] %(message)s

datefmt = %Y-%m-%d %H:%M:%S

[formatter_color_formatter]

class=rhodecode.lib.colored_formatter.ColorFormatter

format= %(asctime)s.%(msecs)03d %(levelname)-5.5s [%(name)s] %(message)s

datefmt = %Y-%m-%d %H:%M:%S

.. _changelog:

Changelog

=========

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

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.

.. _setup:

Setup

=====

Setting up the application

--------------------------

::

 paster make-config RhodeCode production.ini

- This will create `production.ini` config inside the directory

  this config contain various settings for rhodecode, e.g port, email settings

  static files, cache and logging.

::

- 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. 

- Run 

::

 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.

Setting up Whoosh

-----------------

- For full text search You can either put crontab entry for

::

 python /var/www/rhodecode/<rhodecode_installation_path>/lib/indexers/daemon.py incremental <put_here_path_to_repos>

When using incremental 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 scrach, in admin pannel You can check `build from scratch` flag

and in standalone daemon You can pass `full` instead on incremental to build

remove previos index and build new one.

Nginx virtual host example

--------------------------

Sample config for nginx::

 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 !!!

            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.

Other configuration files

-------------------------

Some extra configuration files and examples can be found here:

http://hg.python-works.com/rhodecode/files/tip/init.d

and also an celeryconfig file can be use from here:

http://hg.python-works.com/rhodecode/files/tip/celeryconfig.py

.. _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/

################################################################################

################################################################################

# rhodecode - Pylons environment configuration                                    #

#                                                                              # 

# The %(here)s variable will be replaced with the parent directory of this file#

################################################################################

[DEFAULT]

debug = true

################################################################################

## Uncomment and replace with the address which should receive                ## 

## any error reports after application crash								  ##

## Additionally those settings will be used by rhodecode mailing system          ##

################################################################################

#email_to = admin@localhost

#error_email_from = paste_error@localhost

#app_email_from = rhodecode-noreply@localhost

#error_message =

#smtp_server = mail.server.com

#smtp_username = 

#smtp_password = 

#smtp_port = 

#smtp_use_tls = false

[server:main]

##nr of threads to spawn

threadpool_workers = 5

##max request before thread respawn

threadpool_max_requests = 2

##option to use threads of process

use_threadpool = true

use = egg:Paste#http

host = 127.0.0.1

port = 8001

[app:main]

use = egg:rhodecode

full_stack = true

static_files = false

lang=en

cache_dir = %(here)s/data

####################################

###         BEAKER CACHE        ####

####################################

 beaker.cache.data_dir=/%(here)s/data/cache/data

 beaker.cache.lock_dir=/%(here)s/data/cache/lock

 beaker.cache.regions=super_short_term,short_term,long_term,sql_cache_short,sql_cache_med,sql_cache_long

 beaker.cache.short_term.type=memory

 beaker.cache.short_term.expire=60

 beaker.cache.sql_cache_short.type=memory

 beaker.cache.sql_cache_short.expire=5

 beaker.cache.sql_cache_med.type=memory

 beaker.cache.sql_cache_med.expire=360

 beaker.cache.sql_cache_long.type=file

 beaker.cache.sql_cache_long.expire=3600

####################################

###       BEAKER SESSION        ####

####################################

## Type of storage used for the session, current types are 

## "dbm", "file", "memcached", "database", and "memory".

## The storage uses the Container API 

##that is also used by the cache system.

beaker.session.type = file

beaker.session.key = rhodecode

beaker.session.secret = g654dcno0-9873jhgfreyu

beaker.session.timeout = 36000

##auto save the session to not to use .save()

beaker.session.auto = False

##true exire at browser close

#beaker.session.cookie_expires = 3600

################################################################################

## WARNING: *THE LINE BELOW MUST BE UNCOMMENTED ON A PRODUCTION ENVIRONMENT*  ##

## Debug mode will enable the interactive debugging tool, allowing ANYONE to  ##

## execute malicious code after an exception is raised.                       ##

################################################################################

set debug = false

##################################

###       LOGVIEW CONFIG       ###

##################################

logview.sqlalchemy = #faa

logview.pylons.templating = #bfb

logview.pylons.util = #eee

#########################################################

### DB CONFIGS - EACH DB WILL HAVE IT'S OWN CONFIG    ###

#########################################################

sqlalchemy.db1.url = sqlite:///%(here)s/rhodecode.db

#sqlalchemy.db1.echo = False

#sqlalchemy.db1.pool_recycle = 3600

sqlalchemy.convert_unicode = true

################################

### LOGGING CONFIGURATION   ####

################################

[loggers]

keys = root, routes, rhodecode, sqlalchemy

[handlers]

keys = console

[formatters]

keys = generic,color_formatter

#############

## LOGGERS ##

#############

[logger_root]

level = INFO

handlers = console

[logger_routes]

level = INFO

handlers = console

qualname = routes.middleware

# "level = DEBUG" logs the route matched and routing variables.

[logger_rhodecode]

level = DEBUG

handlers = console

qualname = rhodecode

propagate = 0

[logger_sqlalchemy]

level = ERROR

handlers = console

qualname = sqlalchemy.engine

propagate = 0

##############

## HANDLERS ##

##############

[handler_console]

class = StreamHandler

args = (sys.stderr,)

level = NOTSET

formatter = color_formatter

################

## FORMATTERS ##

################

[formatter_generic]

format = %(asctime)s.%(msecs)03d %(levelname)-5.5s [%(name)s] %(message)s

datefmt = %Y-%m-%d %H:%M:%S

[formatter_color_formatter]

class=rhodecode.lib.colored_formatter.ColorFormatter

format= %(asctime)s.%(msecs)03d %(levelname)-5.5s [%(name)s] %(message)s

datefmt = %Y-%m-%d %H:%M:%S

################################################################################

################################################################################

# rhodecode - Pylons environment configuration                                 #

#                                                                              # 

# The %(here)s variable will be replaced with the parent directory of this file#

################################################################################

[DEFAULT]

debug = true

################################################################################

## Uncomment and replace with the address which should receive                ## 

## any error reports after application crash                                  ##

## Additionally those settings will be used by rhodecode mailing system       ##

################################################################################

#email_to = admin@localhost

#error_email_from = paste_error@localhost

#app_email_from = rhodecode-noreply@localhost

#error_message =

#smtp_server = mail.server.com

#smtp_username = 

#smtp_password = 

#smtp_port = 

#smtp_use_tls = false

[server:main]

##nr of threads to spawn

threadpool_workers = 5

##max request before thread respawn

threadpool_max_requests = 2

##option to use threads of process

use_threadpool = true

use = egg:Paste#http

host = 127.0.0.1

port = 5000

[app:main]

use = egg:rhodecode

full_stack = true

static_files = true

lang=en

cache_dir = %(here)s/data

app_instance_uuid = ${app_instance_uuid}

####################################

###         BEAKER CACHE        ####

####################################

 beaker.cache.data_dir=/%(here)s/data/cache/data

 beaker.cache.lock_dir=/%(here)s/data/cache/lock

 beaker.cache.regions=super_short_term,short_term,long_term,sql_cache_short,sql_cache_med,sql_cache_long

 beaker.cache.short_term.type=memory

 beaker.cache.short_term.expire=60

 beaker.cache.sql_cache_short.type=memory

 beaker.cache.sql_cache_short.expire=5

 beaker.cache.sql_cache_med.type=memory

 beaker.cache.sql_cache_med.expire=360

 beaker.cache.sql_cache_long.type=file

 beaker.cache.sql_cache_long.expire=3600

####################################

###       BEAKER SESSION        ####

####################################

## Type of storage used for the session, current types are 

## "dbm", "file", "memcached", "database", and "memory".

## The storage uses the Container API 

##that is also used by the cache system.

beaker.session.type = file

beaker.session.key = rhodecode

beaker.session.secret = ${app_instance_secret}

beaker.session.timeout = 36000

##auto save the session to not to use .save()

beaker.session.auto = False

##true exire at browser close

#beaker.session.cookie_expires = 3600

################################################################################

## WARNING: *THE LINE BELOW MUST BE UNCOMMENTED ON A PRODUCTION ENVIRONMENT*  ##

## Debug mode will enable the interactive debugging tool, allowing ANYONE to  ##

## execute malicious code after an exception is raised.                       ##

################################################################################

set debug = false

##################################

###       LOGVIEW CONFIG       ###

##################################

logview.sqlalchemy = #faa

logview.pylons.templating = #bfb

logview.pylons.util = #eee

#########################################################

### DB CONFIGS - EACH DB WILL HAVE IT'S OWN CONFIG    ###

#########################################################

sqlalchemy.db1.url = sqlite:///%(here)s/rhodecode.db

#sqlalchemy.db1.echo = False

#sqlalchemy.db1.pool_recycle = 3600

sqlalchemy.convert_unicode = true

################################

### LOGGING CONFIGURATION   ####

################################

[loggers]

keys = root, routes, rhodecode, sqlalchemy

[handlers]

keys = console

[formatters]

keys = generic,color_formatter

#############

## LOGGERS ##

#############

[logger_root]

level = INFO

handlers = console

[logger_routes]

level = INFO

handlers = console

qualname = routes.middleware

# "level = DEBUG" logs the route matched and routing variables.

[logger_rhodecode]

level = DEBUG

handlers = console

qualname = rhodecode

propagate = 0

[logger_sqlalchemy]

level = ERROR

handlers = console

qualname = sqlalchemy.engine

propagate = 0

##############

## HANDLERS ##

##############

[handler_console]

class = StreamHandler

args = (sys.stderr,)

level = NOTSET

formatter = color_formatter

################

## FORMATTERS ##

################

[formatter_generic]

format = %(asctime)s.%(msecs)03d %(levelname)-5.5s [%(name)s] %(message)s

datefmt = %Y-%m-%d %H:%M:%S

[formatter_color_formatter]

class=rhodecode.lib.colored_formatter.ColorFormatter

format= %(asctime)s.%(msecs)03d %(levelname)-5.5s [%(name)s] %(message)s

datefmt = %Y-%m-%d %H:%M:%S

#!/usr/bin/env python

# encoding: utf-8

# database management for RhodeCode

# Copyright (C) 2009-2010 Marcin Kuzminski <marcin@python-works.com>

#

# This program is free software; you can redistribute it and/or

# modify it under the terms of the GNU General Public License

# as published by the Free Software Foundation; version 2

# of the License or (at your opinion) any later version of the license.

# 

# This program is distributed in the hope that it will be useful,

# but WITHOUT ANY WARRANTY; without even the implied warranty of

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

# GNU General Public License for more details.

# 

# You should have received a copy of the GNU General Public License

# along with this program; if not, write to the Free Software

# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,

# MA  02110-1301, USA.

"""

Created on April 10, 2010

database management and creation for RhodeCode

@author: marcink

"""

from os.path import dirname as dn, join as jn

import os

import sys

import uuid

from rhodecode.lib.auth import get_crypt_password

from rhodecode.lib.utils import ask_ok

from rhodecode.model import init_model

from rhodecode.model.db import User, Permission, RhodeCodeUi, RhodeCodeSettings, \

    UserToPerm

from rhodecode.model import meta

from sqlalchemy.engine import create_engine

import logging

log = logging.getLogger(__name__)

class DbManage(object):

    def __init__(self, log_sql, dbname, root, tests=False):

        self.dbname = dbname

        self.tests = tests

        self.root = root

        dburi = 'sqlite:////%s' % jn(self.root, self.dbname)

        engine = create_engine(dburi, echo=log_sql) 

        init_model(engine)

        self.sa = meta.Session

        self.db_exists = False

    def check_for_db(self, override):

        db_path = jn(self.root, self.dbname)

        log.info('checking for existing db in %s', db_path)

        if os.path.isfile(db_path):

            self.db_exists = True

            if not override:

                raise Exception('database already exists')

    def create_tables(self, override=False):

        """

        Create a auth database

        """

        self.check_for_db(override)

            log.info("database exist and it's going to be destroyed")

            if self.tests:

                destroy = True

            else:

                destroy = ask_ok('Are you sure to destroy old database ? [y/n]')

            if not destroy:

                sys.exit()

            if self.db_exists and destroy:

                os.remove(jn(self.root, self.dbname))

        checkfirst = not override

        meta.Base.metadata.create_all(checkfirst=checkfirst)

        log.info('Created tables for %s', self.dbname)

        if not self.tests:

            import getpass

            confirm = getpass.getpass('Confirm password:')

            if password != confirm:

                log.error('passwords mismatch')

                sys.exit()

            email = raw_input('Specify admin email:')

            self.create_user(username, password, email, True)

        else:

            log.info('creating admin and regular test users')

            self.create_user('test_admin', 'test12', 'test_admin@mail.com', True)

            self.create_user('test_regular', 'test12', 'test_regular@mail.com', False)

            self.create_user('test_regular2', 'test12', 'test_regular2@mail.com', False)

    def config_prompt(self, test_repo_path=''):

        log.info('Setting up repositories config')

        if not self.tests and not test_repo_path:

            path = raw_input('Specify valid full path to your repositories'

                        ' you can change this later in application settings:')

        else:

            path = test_repo_path

        if not os.path.isdir(path):

            log.error('You entered wrong path: %s', path)

            sys.exit()

        hooks1 = RhodeCodeUi()

        hooks1.ui_section = 'hooks'

        hooks1.ui_key = 'changegroup.update'

        hooks1.ui_value = 'hg update >&2'

        hooks1.ui_active = False

        hooks2 = RhodeCodeUi()

        hooks2.ui_section = 'hooks'

        hooks2.ui_key = 'changegroup.repo_size'

        hooks2.ui_value = 'python:rhodecode.lib.hooks.repo_size' 

        web1 = RhodeCodeUi()

        web1.ui_section = 'web'

        web1.ui_key = 'push_ssl'

        web1.ui_value = 'false'

        web2 = RhodeCodeUi()

        web2.ui_section = 'web'

        web2.ui_key = 'allow_archive'

        web2.ui_value = 'gz zip bz2'

        web3 = RhodeCodeUi()

        web3.ui_section = 'web'

        web3.ui_key = 'allow_push'

        web3.ui_value = '*'

        web4 = RhodeCodeUi()