diff docs/setup.rst @ 845:a040597b070b beta

docs update
author Marcin Kuzminski <marcin@python-works.com>
date Sun, 12 Dec 2010 19:30:11 +0100
parents aac24db58ce8
children 3d0661b8aaa4 7f9e006aa26f
line wrap: on
line diff
--- a/docs/setup.rst	Sun Dec 12 03:23:28 2010 +0100
+++ b/docs/setup.rst	Sun Dec 12 19:30:11 2010 +0100
@@ -7,13 +7,20 @@
 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.
 
 ::
 
@@ -24,10 +31,11 @@
   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
 
 ::
  
@@ -35,10 +43,12 @@
  
 - 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
+  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
@@ -52,13 +62,13 @@
 
 ::
 
- 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
 
@@ -68,7 +78,7 @@
 
 ::
  
- /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 
@@ -234,7 +244,6 @@
 
  - 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