kallithea Changeset - a040597b070b

Changeset - a040597b070b

Parent rev.

Child rev.

[Not reviewed]

beta

0 5 0

Marcin Kuzminski - 15 years ago 2010-12-12 19:30:11
marcin@python-works.com

docs update

5 files changed with 51 insertions and 22 deletions:

docs/changelog.rst

docs/enable_git.rst

docs/installation.rst

docs/setup.rst

docs/upgrade.rst

0 comments (0 inline, 0 general)

docs/changelog.rst

➞

Show inline comments

@@ @@ -24,25 +24,29 @@ news @@
 - 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
   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

docs/enable_git.rst

➞

Show inline comments

@@ @@ -14,8 +14,8 @@ uncomment git line in rhodecode/__init__ @@
        'hg': 'Mercurial repository',
        #'git': 'Git repository',
+   }
 .. note::
    Please note that it's not fully stable and it might crash (that's why it
-   was disabled), so be carefull about enabling git support. Don't use it in
+   was disabled), so be careful about enabling git support. Don't use it in
    production !
@@ \ No newline at end of file @@

docs/installation.rst

➞

Show inline comments

@@ @@ -7,17 +7,17 @@ Installation @@
 potential there are some third-party requirements. When RhodeCode is used
 together with celery You have to install some kind of message broker,
 recommended one is rabbitmq_ to make the async tasks work.
 Of course RhodeCode works in sync mode also, then You don't have to install
 any third party apps. Celery_ will give You large speed improvement when using
-many big repositories. If You plan to use it for 2 or 3 small repositories, it
+many big repositories. If You plan to use it for 7 or 10 small repositories, it
 will work just fine without celery running.
 After You decide to Run it with celery make sure You run celeryd and
 message broker together with the application.
 After You decide to Run it with celery make sure You run celeryd using paster
 and message broker together with the application.
 Requirements for Celery
 -----------------------
 .. note::
    Installing message broker and using celery is optional, RhodeCode will
@@ @@ -32,14 +32,13 @@ Requirements for Celery @@
 For installation instructions You can visit:
 http://ask.github.com/celery/getting-started/index.html
 It's very nice tutorial how to start celery_ with rabbitmq_
 Install from Cheese Shop
 ------------------------
 Rhodecode requires python 2.5 or 2.6 and will not run on older or newer
 versions of python. Python 2.7 is untested and thus not supported.
 Rhodecode requires python 2.x greater than version 2.5
 Easiest way to install ``rhodecode`` is to run::
  easy_install rhodecode
 Or::
@@ @@ -53,14 +52,15 @@ http://pypi.python.org/pypi/rhodecode, d @@
 Step by step installation example
 ---------------------------------
 - Assuming You have installed virtualenv_ create one using. The `--no-site-packages`
   will make sure non of Your system libs are linked with this virtualenv_
 - Assuming You have installed virtualenv_ create one using.
   The `--no-site-packages` will make sure non of Your system libs are linked
   with this virtualenv_
 ::
  virtualenv --no-site-packages /var/www/rhodecode-venv
 - this will install new virtualenv_ into `/var/www/rhodecode-venv`.

docs/setup.rst

➞

Show inline comments

@@ @@ -4,44 +4,54 @@ 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,static files, cache and logging.
   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.
 - Run
   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
 .0.0.1:5000. This ip and port is configurable via the production.ini
-  file  created in previous step
   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.
   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
 Setting up Whoosh full text search
 ----------------------------------
 Index for whoosh can be build starting from version 1.1 using paster command
@@ @@ -49,29 +59,29 @@ passing repo locations to index, as well @@
 whoosh index files locations. There is possible to pass `-f` to the options
 to enable full index rebuild. Without that indexing will run always in in
 incremental mode.
 ::
- paster make-index --repo-location=<location for repos> production.ini
+ paster make-index production.ini --repo-location=<location for repos>
 for full index rebuild You can use
 ::
- paster make-index -f --repo-location=<location for repos> production.ini
+ paster make-index production.ini -f --repo-location=<location for repos>
 - For full text search You can either put crontab entry for
 This command can be run even from crontab in order to do periodical
 index builds and keep Your index always up to date. An example entry might
 look like this
 ::
- /path/to/python/bin/paster --repo-location=<location for repos> /path/to/rhodecode/production.ini
+ /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
@@ @@ -231,13 +241,12 @@ Troubleshooting @@
    /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 ?

docs/upgrade.rst

➞

Show inline comments

@@ @@ -19,16 +19,32 @@ Then make sure You run from the installa @@
 ::
  paster make-config RhodeCode production.ini
 This will display any changes made from new version of RhodeCode To your
 current config. And tries to do an automerge.
 current config. And tries to do an automerge. It's always better to do a backup
 of config file and recheck the content after merge.
 It's also good to rebuild the whoosh index since after upgrading the whoosh
 versionthere could be introduced incompatible index changes
 version there could be introduced incompatible index changes.
 The last step is to upgrade the database. To do this simply run
 ::
  paster upgrade-db production.ini
 This will upgrade schema, as well as update some default on the database,
 always recheck the settings of the application, if there are no new options
 that need to be set.
 .. note::
    Always perform a database backup before doing upgrade.
 .. _virtualenv: http://pypi.python.org/pypi/virtualenv
 .. _python: http://www.python.org/
 .. _mercurial: http://mercurial.selenic.com/
 .. _celery: http://celeryproject.org/

0 comments (0 inline, 0 general)