##// END OF EJS Templates
docs update
marcink -
r845:a040597b beta
parent child Browse files
Show More
@@ -27,8 +27,10 b' news'
27 and options to disable those hooks from admin panel
27 and options to disable those hooks from admin panel
28 - introduced new enhanced changelog for merges that shows more accurate results
28 - introduced new enhanced changelog for merges that shows more accurate results
29 - new improved and faster code stats (based on pygments lexers mapping tables,
29 - new improved and faster code stats (based on pygments lexers mapping tables,
30 showing up to 10 trending sources for each repository
30 showing up to 10 trending sources for each repository. Additionally stats
31 can be disabled in repository settings.
31 - gui optimizations, fixed application width to 1024px
32 - gui optimizations, fixed application width to 1024px
33 - added cut off (for large files/changesets) limit into config files
32 - whoosh, celeryd, upgrade moved to paster command
34 - whoosh, celeryd, upgrade moved to paster command
33 - other than sqlite database backends can be used
35 - other than sqlite database backends can be used
34
36
@@ -40,6 +42,8 b' fixes'
40 - fixes #66 Name field misspelled
42 - fixes #66 Name field misspelled
41 - fixes #72 block user removal when he owns repositories
43 - fixes #72 block user removal when he owns repositories
42 - fixes #69 added password confirmation fields
44 - fixes #69 added password confirmation fields
45 - fixes #87 RhodeCode crashes occasionally on updating repository owner
46 - fixes #82 broken annotations on files with more than 1 blank line at the end
43 - a lot of fixes and tweaks for file browser
47 - a lot of fixes and tweaks for file browser
44 - fixed detached session issues
48 - fixed detached session issues
45 - fixed when user had no repos he would see all repos listed in my account
49 - fixed when user had no repos he would see all repos listed in my account
@@ -17,5 +17,5 b' uncomment git line in rhodecode/__init__'
17
17
18 .. note::
18 .. note::
19 Please note that it's not fully stable and it might crash (that's why it
19 Please note that it's not fully stable and it might crash (that's why it
20 was disabled), so be carefull about enabling git support. Don't use it in
20 was disabled), so be careful about enabling git support. Don't use it in
21 production ! No newline at end of file
21 production !
@@ -10,11 +10,11 b' recommended one is rabbitmq_ to make the'
10
10
11 Of course RhodeCode works in sync mode also, then You don't have to install
11 Of course RhodeCode works in sync mode also, then You don't have to install
12 any third party apps. Celery_ will give You large speed improvement when using
12 any third party apps. Celery_ will give You large speed improvement when using
13 many big repositories. If You plan to use it for 2 or 3 small repositories, it
13 many big repositories. If You plan to use it for 7 or 10 small repositories, it
14 will work just fine without celery running.
14 will work just fine without celery running.
15
15
16 After You decide to Run it with celery make sure You run celeryd and
16 After You decide to Run it with celery make sure You run celeryd using paster
17 message broker together with the application.
17 and message broker together with the application.
18
18
19 Requirements for Celery
19 Requirements for Celery
20 -----------------------
20 -----------------------
@@ -35,8 +35,7 b" It's very nice tutorial how to start cel"
35
35
36 Install from Cheese Shop
36 Install from Cheese Shop
37 ------------------------
37 ------------------------
38 Rhodecode requires python 2.5 or 2.6 and will not run on older or newer
38 Rhodecode requires python 2.x greater than version 2.5
39 versions of python. Python 2.7 is untested and thus not supported.
40
39
41 Easiest way to install ``rhodecode`` is to run::
40 Easiest way to install ``rhodecode`` is to run::
42
41
@@ -56,8 +55,9 b' Step by step installation example'
56 ---------------------------------
55 ---------------------------------
57
56
58
57
59 - Assuming You have installed virtualenv_ create one using. The `--no-site-packages`
58 - Assuming You have installed virtualenv_ create one using.
60 will make sure non of Your system libs are linked with this virtualenv_
59 The `--no-site-packages` will make sure non of Your system libs are linked
60 with this virtualenv_
61
61
62 ::
62 ::
63
63
@@ -7,13 +7,20 b' Setup'
7 Setting up the application
7 Setting up the application
8 --------------------------
8 --------------------------
9
9
10 First You'll ned to create RhodeCode config file. Run the following command
11 to do this
12
10 ::
13 ::
11
14
12 paster make-config RhodeCode production.ini
15 paster make-config RhodeCode production.ini
13
16
14 - This will create `production.ini` config inside the directory
17 - This will create `production.ini` config inside the directory
15 this config contains various settings for RhodeCode, e.g proxy port,
18 this config contains various settings for RhodeCode, e.g proxy port,
16 email settings,static files, cache and logging.
19 email settings, usage of static files, cache, celery settings and logging.
20
21
22
23 Next we need to create the database.
17
24
18 ::
25 ::
19
26
@@ -24,10 +31,11 b' Setting up the application'
24 existing ones. RhodeCode will simply add all new found repositories to
31 existing ones. RhodeCode will simply add all new found repositories to
25 it's database. Also make sure You specify correct path to repositories.
32 it's database. Also make sure You specify correct path to repositories.
26 - Remember that the given path for mercurial_ repositories must be write
33 - Remember that the given path for mercurial_ repositories must be write
27 accessible for the application. It's very important since RhodeCode web interface
34 accessible for the application. It's very important since RhodeCode web
28 will work even without such an access but, when trying to do a push it'll
35 interface will work even without such an access but, when trying to do a
29 eventually fail with permission denied errors.
36 push it'll eventually fail with permission denied errors.
30 - Run
37
38 You are ready to use rhodecode, to run it simply execute
31
39
32 ::
40 ::
33
41
@@ -38,7 +46,9 b' Setting up the application'
38 file created in previous step
46 file created in previous step
39 - Use admin account you created to login.
47 - Use admin account you created to login.
40 - Default permissions on each repository is read, and owner is admin. So
48 - Default permissions on each repository is read, and owner is admin. So
41 remember to update these if needed.
49 remember to update these if needed. In the admin panel You can toggle ldap,
50 anonymous, permissions settings. As well as edit more advanced options on
51 users and repositories
42
52
43
53
44 Setting up Whoosh full text search
54 Setting up Whoosh full text search
@@ -52,13 +62,13 b' incremental mode.'
52
62
53 ::
63 ::
54
64
55 paster make-index --repo-location=<location for repos> production.ini
65 paster make-index production.ini --repo-location=<location for repos>
56
66
57 for full index rebuild You can use
67 for full index rebuild You can use
58
68
59 ::
69 ::
60
70
61 paster make-index -f --repo-location=<location for repos> production.ini
71 paster make-index production.ini -f --repo-location=<location for repos>
62
72
63 - For full text search You can either put crontab entry for
73 - For full text search You can either put crontab entry for
64
74
@@ -68,7 +78,7 b' look like this'
68
78
69 ::
79 ::
70
80
71 /path/to/python/bin/paster --repo-location=<location for repos> /path/to/rhodecode/production.ini
81 /path/to/python/bin/paster /path/to/rhodecode/production.ini --repo-location=<location for repos>
72
82
73 When using incremental(default) mode whoosh will check last modification date
83 When using incremental(default) mode whoosh will check last modification date
74 of each file and add it to reindex if newer file is available. Also indexing
84 of each file and add it to reindex if newer file is available. Also indexing
@@ -234,7 +244,6 b' Troubleshooting'
234
244
235 - don't worry RhodeCode works without them too. No extra setup required
245 - don't worry RhodeCode works without them too. No extra setup required
236
246
237
238 - long lasting push timeouts ?
247 - long lasting push timeouts ?
239
248
240 - make sure You set a longer timeouts in Your proxy/fcgi settings, timeouts
249 - make sure You set a longer timeouts in Your proxy/fcgi settings, timeouts
@@ -22,10 +22,26 b' Then make sure You run from the installa'
22 paster make-config RhodeCode production.ini
22 paster make-config RhodeCode production.ini
23
23
24 This will display any changes made from new version of RhodeCode To your
24 This will display any changes made from new version of RhodeCode To your
25 current config. And tries to do an automerge.
25 current config. And tries to do an automerge. It's always better to do a backup
26 of config file and recheck the content after merge.
26
27
27 It's also good to rebuild the whoosh index since after upgrading the whoosh
28 It's also good to rebuild the whoosh index since after upgrading the whoosh
28 versionthere could be introduced incompatible index changes
29 version there could be introduced incompatible index changes.
30
31
32 The last step is to upgrade the database. To do this simply run
33
34 ::
35
36 paster upgrade-db production.ini
37
38 This will upgrade schema, as well as update some default on the database,
39 always recheck the settings of the application, if there are no new options
40 that need to be set.
41
42 .. note::
43 Always perform a database backup before doing upgrade.
44
29
45
30
46
31 .. _virtualenv: http://pypi.python.org/pypi/virtualenv
47 .. _virtualenv: http://pypi.python.org/pypi/virtualenv
General Comments 0
You need to be logged in to leave comments. Login now