Mercurial > kallithea

annotate docs/setup.rst @ 1089:fd4cd3c1d7e9

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
- First cut at some documentation corrections.
author jfh <jason@jasonfharris.com>
date Sat, 26 Feb 2011 17:27:58 +0100
parents bdc438fb4fe4
children de86a0870874
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
568
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
1 .. _setup:
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
2
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
3 Setup
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
4 =====
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
5
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
6
1089
fd4cd3c1d7e9 - First cut at some documentation corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
7 Setting up RhodeCode
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 568
diff changeset
8 --------------------------
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 568
diff changeset
9
1089
fd4cd3c1d7e9 - First cut at some documentation corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
10 First, you will need to create a RhodeCode configuration file. Run the following
fd4cd3c1d7e9 - First cut at some documentation corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
11 command to do this::
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 568
diff changeset
12
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 568
diff changeset
13 paster make-config RhodeCode production.ini
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 568
diff changeset
14
1089
fd4cd3c1d7e9 - First cut at some documentation corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
15 - This will create the file `production.ini` in the current directory. This
fd4cd3c1d7e9 - First cut at some documentation corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
16 configuration file contains the various settings for RhodeCode, e.g proxy port,
845
a040597b070b docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 777
diff changeset
17 email settings, usage of static files, cache, celery settings and logging.
a040597b070b docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 777
diff changeset
18
a040597b070b docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 777
diff changeset
19
1089
fd4cd3c1d7e9 - First cut at some documentation corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
20 Next, you need to create the databases used by RhodeCode. I recommend that you
fd4cd3c1d7e9 - First cut at some documentation corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
21 use sqlite (default) or postgresql. If you choose a database other than the
fd4cd3c1d7e9 - First cut at some documentation corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
22 default ensure you properly adjust the db url in your production.ini
fd4cd3c1d7e9 - First cut at some documentation corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
23 configuration file to use this other database. Create the databases by running
fd4cd3c1d7e9 - First cut at some documentation corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
24 the following command::
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 568
diff changeset
25
597
53128b6b9a4d added password validation, second try on paster setup-app,
Marcin Kuzminski <marcin@python-works.com>
parents: 592
diff changeset
26 paster setup-app production.ini
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 568
diff changeset
27
1089
fd4cd3c1d7e9 - First cut at some documentation corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
28 This will prompt you for a "root" path. This "root" path is the location where
fd4cd3c1d7e9 - First cut at some documentation corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
29 RhodeCode will store all of its repositories on the current machine. After
fd4cd3c1d7e9 - First cut at some documentation corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
30 entering this "root" path ``setup-app`` will also prompt you for a username and password
fd4cd3c1d7e9 - First cut at some documentation corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
31 for the initial admin account which ``setup-app`` sets up for you.
845
a040597b070b docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 777
diff changeset
32
1089
fd4cd3c1d7e9 - First cut at some documentation corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
33 - The ``setup-app`` command will create all of the needed tables and an admin
fd4cd3c1d7e9 - First cut at some documentation corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
34 account. When choosing a root path You can either use a new empty location, or a
fd4cd3c1d7e9 - First cut at some documentation corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
35 location which already contains existing repositories. If you choose a location
fd4cd3c1d7e9 - First cut at some documentation corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
36 which contains existing repositories RhodeCode will simply add all of the
fd4cd3c1d7e9 - First cut at some documentation corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
37 repositories at the chosen location to it's database. (Note: make sure you
fd4cd3c1d7e9 - First cut at some documentation corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
38 specify the correct path to the root).
fd4cd3c1d7e9 - First cut at some documentation corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
39 - Note: the given path for mercurial_ repositories **must** be write accessible
fd4cd3c1d7e9 - First cut at some documentation corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
40 for the application. It's very important since the RhodeCode web interface will
fd4cd3c1d7e9 - First cut at some documentation corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
41 work without write access, but when trying to do a push it will eventually fail
fd4cd3c1d7e9 - First cut at some documentation corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
42 with permission denied errors unless it has write access.
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 568
diff changeset
43
1089
fd4cd3c1d7e9 - First cut at some documentation corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
44 You are now ready to use RhodeCode, to run it simply execute::
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 568
diff changeset
45
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 568
diff changeset
46 paster serve production.ini
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 568
diff changeset
47
1089
fd4cd3c1d7e9 - First cut at some documentation corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
48 - This command runs the RhodeCode server. The web app should be available at the
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 568
diff changeset
49 127.0.0.1:5000. This ip and port is configurable via the production.ini
845
a040597b070b docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 777
diff changeset
50 file created in previous step
1089
fd4cd3c1d7e9 - First cut at some documentation corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
51 - Use the admin account you created above when running ``setup-app`` to login to the web app.
fd4cd3c1d7e9 - First cut at some documentation corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
52 - The default permissions on each repository is read, and the owner is admin.
fd4cd3c1d7e9 - First cut at some documentation corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
53 Remember to update these if needed.
fd4cd3c1d7e9 - First cut at some documentation corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
54 - In the admin panel You can toggle ldap, anonymous, permissions settings. As
fd4cd3c1d7e9 - First cut at some documentation corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
55 well as edit more advanced options on users and repositories
fd4cd3c1d7e9 - First cut at some documentation corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
56
fd4cd3c1d7e9 - First cut at some documentation corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
57 Try copying your own mercurial repository into the "root" directory you are
fd4cd3c1d7e9 - First cut at some documentation corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
58 using, then from within the RhodeCode web application choose Admin >
fd4cd3c1d7e9 - First cut at some documentation corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
59 repositories. Then choose Add New Repository. Add the repository you copied into
fd4cd3c1d7e9 - First cut at some documentation corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
60 the root. Test that you can browse your repository from within RhodCode and then
fd4cd3c1d7e9 - First cut at some documentation corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
61 try cloning your repository from RhodeCode with::
fd4cd3c1d7e9 - First cut at some documentation corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
62
fd4cd3c1d7e9 - First cut at some documentation corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
63 hg clone http://127.0.0.1:5000/<repository name>
fd4cd3c1d7e9 - First cut at some documentation corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
64
fd4cd3c1d7e9 - First cut at some documentation corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
65 where *repository name* is replaced by the name of your repository.
fd4cd3c1d7e9 - First cut at some documentation corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
66
1071
bdc438fb4fe4 Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents: 939
diff changeset
67 Using RhodeCode with SSH
bdc438fb4fe4 Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents: 939
diff changeset
68 ------------------------
bdc438fb4fe4 Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents: 939
diff changeset
69
bdc438fb4fe4 Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents: 939
diff changeset
70 RhodeCode repository structures are kept in directories with the same name
1089
fd4cd3c1d7e9 - First cut at some documentation corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
71 as the project, when using repository groups, each group is a subdirectory.
fd4cd3c1d7e9 - First cut at some documentation corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
72 This will allow you to use ssh for accessing repositories quite easily. There
1071
bdc438fb4fe4 Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents: 939
diff changeset
73 are some exceptions when using ssh for accessing repositories.
bdc438fb4fe4 Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents: 939
diff changeset
74
1089
fd4cd3c1d7e9 - First cut at some documentation corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
75 You have to make sure that the web-server as well as the ssh users have unix
fd4cd3c1d7e9 - First cut at some documentation corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
76 permission for the appropriate directories. Secondly, when using ssh rhodecode
fd4cd3c1d7e9 - First cut at some documentation corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
77 will not authenticate those requests and permissions set by the web interface
fd4cd3c1d7e9 - First cut at some documentation corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
78 will not work on the repositories accessed via ssh. There is a solution to this
fd4cd3c1d7e9 - First cut at some documentation corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
79 to use auth hooks, that connects to rhodecode db, and runs check functions for
1071
bdc438fb4fe4 Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents: 939
diff changeset
80 permissions.
bdc438fb4fe4 Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents: 939
diff changeset
81
bdc438fb4fe4 Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents: 939
diff changeset
82
1089
fd4cd3c1d7e9 - First cut at some documentation corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
83 If your main directory (the same as set in RhodeCode settings) is for example
fd4cd3c1d7e9 - First cut at some documentation corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
84 set to **/home/hg** and the repository you are using is named `rhodecode`, then
fd4cd3c1d7e9 - First cut at some documentation corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
85 to clone via ssh you should run::
1071
bdc438fb4fe4 Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents: 939
diff changeset
86
bdc438fb4fe4 Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents: 939
diff changeset
87 hg clone ssh://user@server.com/home/hg/rhodecode
bdc438fb4fe4 Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents: 939
diff changeset
88
1089
fd4cd3c1d7e9 - First cut at some documentation corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
89 Using external tools such as mercurial server or using ssh key based
fd4cd3c1d7e9 - First cut at some documentation corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
90 authentication is fully supported.
592
0a48c1ec04fc #37 fixed json imports for python2.5
Marcin Kuzminski <marcin@python-works.com>
parents: 591
diff changeset
91
683
341beaa9edba Implemented whoosh index building as paster command.
Marcin Kuzminski <marcin@python-works.com>
parents: 597
diff changeset
92 Setting up Whoosh full text search
341beaa9edba Implemented whoosh index building as paster command.
Marcin Kuzminski <marcin@python-works.com>
parents: 597
diff changeset
93 ----------------------------------
341beaa9edba Implemented whoosh index building as paster command.
Marcin Kuzminski <marcin@python-works.com>
parents: 597
diff changeset
94
1089
fd4cd3c1d7e9 - First cut at some documentation corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
95 Starting from version 1.1 the whoosh index can be build by using the paster
fd4cd3c1d7e9 - First cut at some documentation corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
96 command ``make-index``. To use ``make-index`` You must specify the configuration
fd4cd3c1d7e9 - First cut at some documentation corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
97 file that stores the location of the index, and the location of the repositories
fd4cd3c1d7e9 - First cut at some documentation corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
98 (`--repo-location`).
1071
bdc438fb4fe4 Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents: 939
diff changeset
99
1089
fd4cd3c1d7e9 - First cut at some documentation corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
100 You may optionally pass the option `-f` to enable a full index rebuild. Without
fd4cd3c1d7e9 - First cut at some documentation corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
101 the `-f` option, indexing will run always in "incremental" mode.
683
341beaa9edba Implemented whoosh index building as paster command.
Marcin Kuzminski <marcin@python-works.com>
parents: 597
diff changeset
102
1089
fd4cd3c1d7e9 - First cut at some documentation corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
103 For an incremental index build use::
707
1105531ae572 docs update, added ldap section, added troubleshooting section
Marcin Kuzminski <marcin@python-works.com>
parents: 683
diff changeset
104
1071
bdc438fb4fe4 Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents: 939
diff changeset
105 paster make-index production.ini --repo-location=<location for repos>
bdc438fb4fe4 Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents: 939
diff changeset
106
683
341beaa9edba Implemented whoosh index building as paster command.
Marcin Kuzminski <marcin@python-works.com>
parents: 597
diff changeset
107
1089
fd4cd3c1d7e9 - First cut at some documentation corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
108 For a full index rebuild use::
707
1105531ae572 docs update, added ldap section, added troubleshooting section
Marcin Kuzminski <marcin@python-works.com>
parents: 683
diff changeset
109
1071
bdc438fb4fe4 Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents: 939
diff changeset
110 paster make-index production.ini -f --repo-location=<location for repos>
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 568
diff changeset
111
1089
fd4cd3c1d7e9 - First cut at some documentation corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
112 - For full text search you can either put crontab entry for
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 568
diff changeset
113
1089
fd4cd3c1d7e9 - First cut at some documentation corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
114 In order to do periodical index builds and keep your index always up to date.
1071
bdc438fb4fe4 Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents: 939
diff changeset
115 It's recommended to do a crontab entry for incremental indexing.
1089
fd4cd3c1d7e9 - First cut at some documentation corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
116 An example entry might look like this::
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 568
diff changeset
117
845
a040597b070b docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 777
diff changeset
118 /path/to/python/bin/paster /path/to/rhodecode/production.ini --repo-location=<location for repos>
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 568
diff changeset
119
1089
fd4cd3c1d7e9 - First cut at some documentation corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
120 When using incremental mode (the default) whoosh will check the last
fd4cd3c1d7e9 - First cut at some documentation corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
121 modification date of each file and add it to be reindexed if a newer file is
fd4cd3c1d7e9 - First cut at some documentation corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
122 available. The indexing daemon checks for any removed files and removes them
fd4cd3c1d7e9 - First cut at some documentation corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
123 from index.
683
341beaa9edba Implemented whoosh index building as paster command.
Marcin Kuzminski <marcin@python-works.com>
parents: 597
diff changeset
124
1089
fd4cd3c1d7e9 - First cut at some documentation corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
125 If you want to rebuild index from scratch, you can use the `-f` flag as above,
fd4cd3c1d7e9 - First cut at some documentation corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
126 or in the admin panel you can check `build from scratch` flag.
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 568
diff changeset
127
707
1105531ae572 docs update, added ldap section, added troubleshooting section
Marcin Kuzminski <marcin@python-works.com>
parents: 683
diff changeset
128
1105531ae572 docs update, added ldap section, added troubleshooting section
Marcin Kuzminski <marcin@python-works.com>
parents: 683
diff changeset
129 Setting up LDAP support
1105531ae572 docs update, added ldap section, added troubleshooting section
Marcin Kuzminski <marcin@python-works.com>
parents: 683
diff changeset
130 -----------------------
1105531ae572 docs update, added ldap section, added troubleshooting section
Marcin Kuzminski <marcin@python-works.com>
parents: 683
diff changeset
131
1105531ae572 docs update, added ldap section, added troubleshooting section
Marcin Kuzminski <marcin@python-works.com>
parents: 683
diff changeset
132 RhodeCode starting from version 1.1 supports ldap authentication. In order
1089
fd4cd3c1d7e9 - First cut at some documentation corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
133 to use LDAP, you have to install python-ldap_ package. This package is available
fd4cd3c1d7e9 - First cut at some documentation corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
134 via pypi, so you can install it by running
707
1105531ae572 docs update, added ldap section, added troubleshooting section
Marcin Kuzminski <marcin@python-works.com>
parents: 683
diff changeset
135
1105531ae572 docs update, added ldap section, added troubleshooting section
Marcin Kuzminski <marcin@python-works.com>
parents: 683
diff changeset
136 ::
1105531ae572 docs update, added ldap section, added troubleshooting section
Marcin Kuzminski <marcin@python-works.com>
parents: 683
diff changeset
137
733
ac701b421053 fixed docs, for python-ldap import
Marcin Kuzminski <marcin@python-works.com>
parents: 715
diff changeset
138 easy_install python-ldap
707
1105531ae572 docs update, added ldap section, added troubleshooting section
Marcin Kuzminski <marcin@python-works.com>
parents: 683
diff changeset
139
1105531ae572 docs update, added ldap section, added troubleshooting section
Marcin Kuzminski <marcin@python-works.com>
parents: 683
diff changeset
140 ::
1105531ae572 docs update, added ldap section, added troubleshooting section
Marcin Kuzminski <marcin@python-works.com>
parents: 683
diff changeset
141
733
ac701b421053 fixed docs, for python-ldap import
Marcin Kuzminski <marcin@python-works.com>
parents: 715
diff changeset
142 pip install python-ldap
707
1105531ae572 docs update, added ldap section, added troubleshooting section
Marcin Kuzminski <marcin@python-works.com>
parents: 683
diff changeset
143
770
5f82a00b92b1 docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 744
diff changeset
144 .. note::
1089
fd4cd3c1d7e9 - First cut at some documentation corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
145 python-ldap requires some certain libs on your system, so before installing
fd4cd3c1d7e9 - First cut at some documentation corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
146 it check that you have at least `openldap`, and `sasl` libraries.
707
1105531ae572 docs update, added ldap section, added troubleshooting section
Marcin Kuzminski <marcin@python-works.com>
parents: 683
diff changeset
147
770
5f82a00b92b1 docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 744
diff changeset
148 ldap settings are located in admin->ldap section,
707
1105531ae572 docs update, added ldap section, added troubleshooting section
Marcin Kuzminski <marcin@python-works.com>
parents: 683
diff changeset
149
1105531ae572 docs update, added ldap section, added troubleshooting section
Marcin Kuzminski <marcin@python-works.com>
parents: 683
diff changeset
150 Here's a typical ldap setup::
1105531ae572 docs update, added ldap section, added troubleshooting section
Marcin Kuzminski <marcin@python-works.com>
parents: 683
diff changeset
151
770
5f82a00b92b1 docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 744
diff changeset
152 Enable ldap = checked #controls if ldap access is enabled
5f82a00b92b1 docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 744
diff changeset
153 Host = host.domain.org #actual ldap server to connect
707
1105531ae572 docs update, added ldap section, added troubleshooting section
Marcin Kuzminski <marcin@python-works.com>
parents: 683
diff changeset
154 Port = 389 or 689 for ldaps #ldap server ports
1105531ae572 docs update, added ldap section, added troubleshooting section
Marcin Kuzminski <marcin@python-works.com>
parents: 683
diff changeset
155 Enable LDAPS = unchecked #enable disable ldaps
1105531ae572 docs update, added ldap section, added troubleshooting section
Marcin Kuzminski <marcin@python-works.com>
parents: 683
diff changeset
156 Account = <account> #access for ldap server(if required)
1105531ae572 docs update, added ldap section, added troubleshooting section
Marcin Kuzminski <marcin@python-works.com>
parents: 683
diff changeset
157 Password = <password> #password for ldap server(if required)
770
5f82a00b92b1 docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 744
diff changeset
158 Base DN = uid=%(user)s,CN=users,DC=host,DC=domain,DC=org
707
1105531ae572 docs update, added ldap section, added troubleshooting section
Marcin Kuzminski <marcin@python-works.com>
parents: 683
diff changeset
159
1105531ae572 docs update, added ldap section, added troubleshooting section
Marcin Kuzminski <marcin@python-works.com>
parents: 683
diff changeset
160
1105531ae572 docs update, added ldap section, added troubleshooting section
Marcin Kuzminski <marcin@python-works.com>
parents: 683
diff changeset
161 `Account` and `Password` are optional, and used for two-phase ldap
1089
fd4cd3c1d7e9 - First cut at some documentation corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
162 authentication so those are credentials to access your ldap, if it doesn't
775
aaf2fc59a39a fixes #77 and adds extendable base Dn with custom uid specification
Marcin Kuzminski <marcin@python-works.com>
parents: 770
diff changeset
163 support anonymous search/user lookups.
aaf2fc59a39a fixes #77 and adds extendable base Dn with custom uid specification
Marcin Kuzminski <marcin@python-works.com>
parents: 770
diff changeset
164
1089
fd4cd3c1d7e9 - First cut at some documentation corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
165 Base DN must have %(user)s template inside, it's a placer where your uid used
775
aaf2fc59a39a fixes #77 and adds extendable base Dn with custom uid specification
Marcin Kuzminski <marcin@python-works.com>
parents: 770
diff changeset
166 to login would go, it allows admins to specify not standard schema for uid
aaf2fc59a39a fixes #77 and adds extendable base Dn with custom uid specification
Marcin Kuzminski <marcin@python-works.com>
parents: 770
diff changeset
167 variable
707
1105531ae572 docs update, added ldap section, added troubleshooting section
Marcin Kuzminski <marcin@python-works.com>
parents: 683
diff changeset
168
733
ac701b421053 fixed docs, for python-ldap import
Marcin Kuzminski <marcin@python-works.com>
parents: 715
diff changeset
169 If all data are entered correctly, and `python-ldap` is properly installed
770
5f82a00b92b1 docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 744
diff changeset
170 Users should be granted to access RhodeCode wit ldap accounts. When
715
066af351c6d8 Fixed archivals by passing baseui to scm get method for hg.
Marcin Kuzminski <marcin@python-works.com>
parents: 707
diff changeset
171 logging at the first time an special ldap account is created inside RhodeCode,
1089
fd4cd3c1d7e9 - First cut at some documentation corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
172 so you can control over permissions even on ldap users. If such user exists
715
066af351c6d8 Fixed archivals by passing baseui to scm get method for hg.
Marcin Kuzminski <marcin@python-works.com>
parents: 707
diff changeset
173 already in RhodeCode database ldap user with the same username would be not
066af351c6d8 Fixed archivals by passing baseui to scm get method for hg.
Marcin Kuzminski <marcin@python-works.com>
parents: 707
diff changeset
174 able to access RhodeCode.
707
1105531ae572 docs update, added ldap section, added troubleshooting section
Marcin Kuzminski <marcin@python-works.com>
parents: 683
diff changeset
175
1089
fd4cd3c1d7e9 - First cut at some documentation corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
176 If you have problems with ldap access and believe you entered correct
715
066af351c6d8 Fixed archivals by passing baseui to scm get method for hg.
Marcin Kuzminski <marcin@python-works.com>
parents: 707
diff changeset
177 information check out the RhodeCode logs,any error messages sent from
707
1105531ae572 docs update, added ldap section, added troubleshooting section
Marcin Kuzminski <marcin@python-works.com>
parents: 683
diff changeset
178 ldap will be saved there.
1105531ae572 docs update, added ldap section, added troubleshooting section
Marcin Kuzminski <marcin@python-works.com>
parents: 683
diff changeset
179
1105531ae572 docs update, added ldap section, added troubleshooting section
Marcin Kuzminski <marcin@python-works.com>
parents: 683
diff changeset
180
777
aac24db58ce8 fixed cache problem,
Marcin Kuzminski <marcin@python-works.com>
parents: 775
diff changeset
181
aac24db58ce8 fixed cache problem,
Marcin Kuzminski <marcin@python-works.com>
parents: 775
diff changeset
182 Setting Up Celery
aac24db58ce8 fixed cache problem,
Marcin Kuzminski <marcin@python-works.com>
parents: 775
diff changeset
183 -----------------
aac24db58ce8 fixed cache problem,
Marcin Kuzminski <marcin@python-works.com>
parents: 775
diff changeset
184
aac24db58ce8 fixed cache problem,
Marcin Kuzminski <marcin@python-works.com>
parents: 775
diff changeset
185 Since version 1.1 celery is configured by the rhodecode ini configuration files
aac24db58ce8 fixed cache problem,
Marcin Kuzminski <marcin@python-works.com>
parents: 775
diff changeset
186 simply set use_celery=true in the ini file then add / change the configuration
aac24db58ce8 fixed cache problem,
Marcin Kuzminski <marcin@python-works.com>
parents: 775
diff changeset
187 variables inside the ini file.
aac24db58ce8 fixed cache problem,
Marcin Kuzminski <marcin@python-works.com>
parents: 775
diff changeset
188
aac24db58ce8 fixed cache problem,
Marcin Kuzminski <marcin@python-works.com>
parents: 775
diff changeset
189 Remember that the ini files uses format with '.' not with '_' like celery
aac24db58ce8 fixed cache problem,
Marcin Kuzminski <marcin@python-works.com>
parents: 775
diff changeset
190 so for example setting `BROKER_HOST` in celery means setting `broker.host` in
aac24db58ce8 fixed cache problem,
Marcin Kuzminski <marcin@python-works.com>
parents: 775
diff changeset
191 the config file.
aac24db58ce8 fixed cache problem,
Marcin Kuzminski <marcin@python-works.com>
parents: 775
diff changeset
192
aac24db58ce8 fixed cache problem,
Marcin Kuzminski <marcin@python-works.com>
parents: 775
diff changeset
193 In order to make start using celery run::
939
c165349fdd0e merged bugfixes for rhodecode 1.1.2 release
Marcin Kuzminski <marcin@python-works.com>
parents: 926
diff changeset
194
777
aac24db58ce8 fixed cache problem,
Marcin Kuzminski <marcin@python-works.com>
parents: 775
diff changeset
195 paster celeryd <configfile.ini>
aac24db58ce8 fixed cache problem,
Marcin Kuzminski <marcin@python-works.com>
parents: 775
diff changeset
196
1071
bdc438fb4fe4 Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents: 939
diff changeset
197
939
c165349fdd0e merged bugfixes for rhodecode 1.1.2 release
Marcin Kuzminski <marcin@python-works.com>
parents: 926
diff changeset
198 .. note::
1089
fd4cd3c1d7e9 - First cut at some documentation corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
199 Make sure you run this command from same virtualenv, and with the same user
939
c165349fdd0e merged bugfixes for rhodecode 1.1.2 release
Marcin Kuzminski <marcin@python-works.com>
parents: 926
diff changeset
200 that rhodecode runs.
c165349fdd0e merged bugfixes for rhodecode 1.1.2 release
Marcin Kuzminski <marcin@python-works.com>
parents: 926
diff changeset
201
921
136af52f374b merged found bugs and fixed for stable release:
Marcin Kuzminski <marcin@python-works.com>
parents: 857
diff changeset
202 HTTPS support
136af52f374b merged found bugs and fixed for stable release:
Marcin Kuzminski <marcin@python-works.com>
parents: 857
diff changeset
203 -------------
136af52f374b merged found bugs and fixed for stable release:
Marcin Kuzminski <marcin@python-works.com>
parents: 857
diff changeset
204
136af52f374b merged found bugs and fixed for stable release:
Marcin Kuzminski <marcin@python-works.com>
parents: 857
diff changeset
205 There are two ways to enable https, first is to set HTTP_X_URL_SCHEME in
1089
fd4cd3c1d7e9 - First cut at some documentation corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
206 your http server headers, than rhodecode will recognise this headers and make
921
136af52f374b merged found bugs and fixed for stable release:
Marcin Kuzminski <marcin@python-works.com>
parents: 857
diff changeset
207 proper https redirections, another way is to set `force_https = true`
136af52f374b merged found bugs and fixed for stable release:
Marcin Kuzminski <marcin@python-works.com>
parents: 857
diff changeset
208 in the ini cofiguration to force using https, no headers are needed than to
136af52f374b merged found bugs and fixed for stable release:
Marcin Kuzminski <marcin@python-works.com>
parents: 857
diff changeset
209 enable https
136af52f374b merged found bugs and fixed for stable release:
Marcin Kuzminski <marcin@python-works.com>
parents: 857
diff changeset
210
136af52f374b merged found bugs and fixed for stable release:
Marcin Kuzminski <marcin@python-works.com>
parents: 857
diff changeset
211
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 568
diff changeset
212 Nginx virtual host example
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 568
diff changeset
213 --------------------------
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 568
diff changeset
214
707
1105531ae572 docs update, added ldap section, added troubleshooting section
Marcin Kuzminski <marcin@python-works.com>
parents: 683
diff changeset
215 Sample config for nginx using proxy::
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 568
diff changeset
216
1071
bdc438fb4fe4 Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents: 939
diff changeset
217 server {
bdc438fb4fe4 Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents: 939
diff changeset
218 listen 80;
bdc438fb4fe4 Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents: 939
diff changeset
219 server_name hg.myserver.com;
bdc438fb4fe4 Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents: 939
diff changeset
220 access_log /var/log/nginx/rhodecode.access.log;
bdc438fb4fe4 Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents: 939
diff changeset
221 error_log /var/log/nginx/rhodecode.error.log;
bdc438fb4fe4 Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents: 939
diff changeset
222 location / {
bdc438fb4fe4 Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents: 939
diff changeset
223 root /var/www/rhodecode/rhodecode/public/;
bdc438fb4fe4 Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents: 939
diff changeset
224 if (!-f $request_filename){
bdc438fb4fe4 Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents: 939
diff changeset
225 proxy_pass http://127.0.0.1:5000;
bdc438fb4fe4 Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents: 939
diff changeset
226 }
1089
fd4cd3c1d7e9 - First cut at some documentation corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
227 #this is important if you want to use https !!!
1071
bdc438fb4fe4 Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents: 939
diff changeset
228 proxy_set_header X-Url-Scheme $scheme;
bdc438fb4fe4 Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents: 939
diff changeset
229 include /etc/nginx/proxy.conf;
bdc438fb4fe4 Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents: 939
diff changeset
230 }
bdc438fb4fe4 Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents: 939
diff changeset
231 }
568
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
232
592
0a48c1ec04fc #37 fixed json imports for python2.5
Marcin Kuzminski <marcin@python-works.com>
parents: 591
diff changeset
233 Here's the proxy.conf. It's tuned so it'll not timeout on long
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 568
diff changeset
234 pushes and also on large pushes::
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 568
diff changeset
235
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 568
diff changeset
236 proxy_redirect off;
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 568
diff changeset
237 proxy_set_header Host $host;
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 568
diff changeset
238 proxy_set_header X-Host $http_host;
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 568
diff changeset
239 proxy_set_header X-Real-IP $remote_addr;
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 568
diff changeset
240 proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 568
diff changeset
241 proxy_set_header Proxy-host $proxy_host;
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 568
diff changeset
242 client_max_body_size 400m;
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 568
diff changeset
243 client_body_buffer_size 128k;
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 568
diff changeset
244 proxy_buffering off;
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 568
diff changeset
245 proxy_connect_timeout 3600;
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 568
diff changeset
246 proxy_send_timeout 3600;
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 568
diff changeset
247 proxy_read_timeout 3600;
1071
bdc438fb4fe4 Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents: 939
diff changeset
248 proxy_buffer_size 16k;
bdc438fb4fe4 Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents: 939
diff changeset
249 proxy_buffers 4 16k;
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 568
diff changeset
250 proxy_busy_buffers_size 64k;
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 568
diff changeset
251 proxy_temp_file_write_size 64k;
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 568
diff changeset
252
1089
fd4cd3c1d7e9 - First cut at some documentation corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
253 Also when using root path with nginx you might set the static files to false
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 568
diff changeset
254 in production.ini file::
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 568
diff changeset
255
1071
bdc438fb4fe4 Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents: 939
diff changeset
256 [app:main]
bdc438fb4fe4 Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents: 939
diff changeset
257 use = egg:rhodecode
bdc438fb4fe4 Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents: 939
diff changeset
258 full_stack = true
bdc438fb4fe4 Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents: 939
diff changeset
259 static_files = false
bdc438fb4fe4 Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents: 939
diff changeset
260 lang=en
bdc438fb4fe4 Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents: 939
diff changeset
261 cache_dir = %(here)s/data
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 568
diff changeset
262
592
0a48c1ec04fc #37 fixed json imports for python2.5
Marcin Kuzminski <marcin@python-works.com>
parents: 591
diff changeset
263 To not have the statics served by the application. And improve speed.
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 568
diff changeset
264
921
136af52f374b merged found bugs and fixed for stable release:
Marcin Kuzminski <marcin@python-works.com>
parents: 857
diff changeset
265
136af52f374b merged found bugs and fixed for stable release:
Marcin Kuzminski <marcin@python-works.com>
parents: 857
diff changeset
266 Apache virtual host example
136af52f374b merged found bugs and fixed for stable release:
Marcin Kuzminski <marcin@python-works.com>
parents: 857
diff changeset
267 ---------------------------
136af52f374b merged found bugs and fixed for stable release:
Marcin Kuzminski <marcin@python-works.com>
parents: 857
diff changeset
268
136af52f374b merged found bugs and fixed for stable release:
Marcin Kuzminski <marcin@python-works.com>
parents: 857
diff changeset
269 Sample config for apache using proxy::
136af52f374b merged found bugs and fixed for stable release:
Marcin Kuzminski <marcin@python-works.com>
parents: 857
diff changeset
270
926
344f74851781 fixed docs
Marcin Kuzminski <marcin@python-works.com>
parents: 921
diff changeset
271 <VirtualHost *:80>
344f74851781 fixed docs
Marcin Kuzminski <marcin@python-works.com>
parents: 921
diff changeset
272 ServerName hg.myserver.com
344f74851781 fixed docs
Marcin Kuzminski <marcin@python-works.com>
parents: 921
diff changeset
273 ServerAlias hg.myserver.com
344f74851781 fixed docs
Marcin Kuzminski <marcin@python-works.com>
parents: 921
diff changeset
274
344f74851781 fixed docs
Marcin Kuzminski <marcin@python-works.com>
parents: 921
diff changeset
275 <Proxy *>
344f74851781 fixed docs
Marcin Kuzminski <marcin@python-works.com>
parents: 921
diff changeset
276 Order allow,deny
344f74851781 fixed docs
Marcin Kuzminski <marcin@python-works.com>
parents: 921
diff changeset
277 Allow from all
344f74851781 fixed docs
Marcin Kuzminski <marcin@python-works.com>
parents: 921
diff changeset
278 </Proxy>
344f74851781 fixed docs
Marcin Kuzminski <marcin@python-works.com>
parents: 921
diff changeset
279
344f74851781 fixed docs
Marcin Kuzminski <marcin@python-works.com>
parents: 921
diff changeset
280 #important !
344f74851781 fixed docs
Marcin Kuzminski <marcin@python-works.com>
parents: 921
diff changeset
281 #Directive to properly generate url (clone url) for pylons
344f74851781 fixed docs
Marcin Kuzminski <marcin@python-works.com>
parents: 921
diff changeset
282 ProxyPreserveHost On
344f74851781 fixed docs
Marcin Kuzminski <marcin@python-works.com>
parents: 921
diff changeset
283
344f74851781 fixed docs
Marcin Kuzminski <marcin@python-works.com>
parents: 921
diff changeset
284 #rhodecode instance
344f74851781 fixed docs
Marcin Kuzminski <marcin@python-works.com>
parents: 921
diff changeset
285 ProxyPass / http://127.0.0.1:5000/
344f74851781 fixed docs
Marcin Kuzminski <marcin@python-works.com>
parents: 921
diff changeset
286 ProxyPassReverse / http://127.0.0.1:5000/
344f74851781 fixed docs
Marcin Kuzminski <marcin@python-works.com>
parents: 921
diff changeset
287
344f74851781 fixed docs
Marcin Kuzminski <marcin@python-works.com>
parents: 921
diff changeset
288 #to enable https use line below
344f74851781 fixed docs
Marcin Kuzminski <marcin@python-works.com>
parents: 921
diff changeset
289 #SetEnvIf X-Url-Scheme https HTTPS=1
344f74851781 fixed docs
Marcin Kuzminski <marcin@python-works.com>
parents: 921
diff changeset
290
344f74851781 fixed docs
Marcin Kuzminski <marcin@python-works.com>
parents: 921
diff changeset
291 </VirtualHost>
921
136af52f374b merged found bugs and fixed for stable release:
Marcin Kuzminski <marcin@python-works.com>
parents: 857
diff changeset
292
136af52f374b merged found bugs and fixed for stable release:
Marcin Kuzminski <marcin@python-works.com>
parents: 857
diff changeset
293
136af52f374b merged found bugs and fixed for stable release:
Marcin Kuzminski <marcin@python-works.com>
parents: 857
diff changeset
294 Additional tutorial
744
3389f272ece1 docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 733
diff changeset
295 http://wiki.pylonshq.com/display/pylonscookbook/Apache+as+a+reverse+proxy+for+Pylons
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 568
diff changeset
296
707
1105531ae572 docs update, added ldap section, added troubleshooting section
Marcin Kuzminski <marcin@python-works.com>
parents: 683
diff changeset
297
1071
bdc438fb4fe4 Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents: 939
diff changeset
298 Apache as subdirectory
bdc438fb4fe4 Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents: 939
diff changeset
299 ----------------------
bdc438fb4fe4 Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents: 939
diff changeset
300
bdc438fb4fe4 Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents: 939
diff changeset
301
bdc438fb4fe4 Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents: 939
diff changeset
302 Apache subdirectory part::
bdc438fb4fe4 Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents: 939
diff changeset
303
bdc438fb4fe4 Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents: 939
diff changeset
304 <Location /rhodecode>
bdc438fb4fe4 Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents: 939
diff changeset
305 ProxyPass http://127.0.0.1:59542/rhodecode
bdc438fb4fe4 Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents: 939
diff changeset
306 ProxyPassReverse http://127.0.0.1:59542/rhodecode
bdc438fb4fe4 Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents: 939
diff changeset
307 SetEnvIf X-Url-Scheme https HTTPS=1
bdc438fb4fe4 Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents: 939
diff changeset
308 </Location>
bdc438fb4fe4 Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents: 939
diff changeset
309
1089
fd4cd3c1d7e9 - First cut at some documentation corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
310 Besides the regular apache setup you will need to add such part to .ini file::
1071
bdc438fb4fe4 Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents: 939
diff changeset
311
bdc438fb4fe4 Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents: 939
diff changeset
312 filter-with = proxy-prefix
bdc438fb4fe4 Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents: 939
diff changeset
313
bdc438fb4fe4 Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents: 939
diff changeset
314 Add the following at the end of the .ini file::
bdc438fb4fe4 Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents: 939
diff changeset
315
bdc438fb4fe4 Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents: 939
diff changeset
316 [filter:proxy-prefix]
bdc438fb4fe4 Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents: 939
diff changeset
317 use = egg:PasteDeploy#prefix
bdc438fb4fe4 Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents: 939
diff changeset
318 prefix = /<someprefix>
bdc438fb4fe4 Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents: 939
diff changeset
319
bdc438fb4fe4 Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents: 939
diff changeset
320
707
1105531ae572 docs update, added ldap section, added troubleshooting section
Marcin Kuzminski <marcin@python-works.com>
parents: 683
diff changeset
321 Apache's example FCGI config
1105531ae572 docs update, added ldap section, added troubleshooting section
Marcin Kuzminski <marcin@python-works.com>
parents: 683
diff changeset
322 ----------------------------
1105531ae572 docs update, added ldap section, added troubleshooting section
Marcin Kuzminski <marcin@python-works.com>
parents: 683
diff changeset
323
1105531ae572 docs update, added ldap section, added troubleshooting section
Marcin Kuzminski <marcin@python-works.com>
parents: 683
diff changeset
324 TODO !
1105531ae572 docs update, added ldap section, added troubleshooting section
Marcin Kuzminski <marcin@python-works.com>
parents: 683
diff changeset
325
591
1e2adb37cab6 docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 572
diff changeset
326 Other configuration files
1e2adb37cab6 docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 572
diff changeset
327 -------------------------
1e2adb37cab6 docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 572
diff changeset
328
939
c165349fdd0e merged bugfixes for rhodecode 1.1.2 release
Marcin Kuzminski <marcin@python-works.com>
parents: 926
diff changeset
329 Some example init.d script can be found here, for debian and gentoo:
591
1e2adb37cab6 docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 572
diff changeset
330
939
c165349fdd0e merged bugfixes for rhodecode 1.1.2 release
Marcin Kuzminski <marcin@python-works.com>
parents: 926
diff changeset
331 https://rhodeocode.org/rhodecode/files/tip/init.d
c165349fdd0e merged bugfixes for rhodecode 1.1.2 release
Marcin Kuzminski <marcin@python-works.com>
parents: 926
diff changeset
332
591
1e2adb37cab6 docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 572
diff changeset
333
707
1105531ae572 docs update, added ldap section, added troubleshooting section
Marcin Kuzminski <marcin@python-works.com>
parents: 683
diff changeset
334 Troubleshooting
1105531ae572 docs update, added ldap section, added troubleshooting section
Marcin Kuzminski <marcin@python-works.com>
parents: 683
diff changeset
335 ---------------
1105531ae572 docs update, added ldap section, added troubleshooting section
Marcin Kuzminski <marcin@python-works.com>
parents: 683
diff changeset
336
1105531ae572 docs update, added ldap section, added troubleshooting section
Marcin Kuzminski <marcin@python-works.com>
parents: 683
diff changeset
337 - missing static files ?
1105531ae572 docs update, added ldap section, added troubleshooting section
Marcin Kuzminski <marcin@python-works.com>
parents: 683
diff changeset
338
1105531ae572 docs update, added ldap section, added troubleshooting section
Marcin Kuzminski <marcin@python-works.com>
parents: 683
diff changeset
339 - make sure either to set the `static_files = true` in the .ini file or
1089
fd4cd3c1d7e9 - First cut at some documentation corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
340 double check the root path for your http setup. It should point to
707
1105531ae572 docs update, added ldap section, added troubleshooting section
Marcin Kuzminski <marcin@python-works.com>
parents: 683
diff changeset
341 for example:
1105531ae572 docs update, added ldap section, added troubleshooting section
Marcin Kuzminski <marcin@python-works.com>
parents: 683
diff changeset
342 /home/my-virtual-python/lib/python2.6/site-packages/rhodecode/public
1105531ae572 docs update, added ldap section, added troubleshooting section
Marcin Kuzminski <marcin@python-works.com>
parents: 683
diff changeset
343
1105531ae572 docs update, added ldap section, added troubleshooting section
Marcin Kuzminski <marcin@python-works.com>
parents: 683
diff changeset
344 - can't install celery/rabbitmq
1105531ae572 docs update, added ldap section, added troubleshooting section
Marcin Kuzminski <marcin@python-works.com>
parents: 683
diff changeset
345
1105531ae572 docs update, added ldap section, added troubleshooting section
Marcin Kuzminski <marcin@python-works.com>
parents: 683
diff changeset
346 - don't worry RhodeCode works without them too. No extra setup required
1105531ae572 docs update, added ldap section, added troubleshooting section
Marcin Kuzminski <marcin@python-works.com>
parents: 683
diff changeset
347
1105531ae572 docs update, added ldap section, added troubleshooting section
Marcin Kuzminski <marcin@python-works.com>
parents: 683
diff changeset
348 - long lasting push timeouts ?
1105531ae572 docs update, added ldap section, added troubleshooting section
Marcin Kuzminski <marcin@python-works.com>
parents: 683
diff changeset
349
1089
fd4cd3c1d7e9 - First cut at some documentation corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
350 - make sure you set a longer timeouts in your proxy/fcgi settings, timeouts
715
066af351c6d8 Fixed archivals by passing baseui to scm get method for hg.
Marcin Kuzminski <marcin@python-works.com>
parents: 707
diff changeset
351 are caused by https server and not RhodeCode
707
1105531ae572 docs update, added ldap section, added troubleshooting section
Marcin Kuzminski <marcin@python-works.com>
parents: 683
diff changeset
352
1105531ae572 docs update, added ldap section, added troubleshooting section
Marcin Kuzminski <marcin@python-works.com>
parents: 683
diff changeset
353 - large pushes timeouts ?
1105531ae572 docs update, added ldap section, added troubleshooting section
Marcin Kuzminski <marcin@python-works.com>
parents: 683
diff changeset
354
1089
fd4cd3c1d7e9 - First cut at some documentation corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
355 - make sure you set a proper max_body_size for the http server
707
1105531ae572 docs update, added ldap section, added troubleshooting section
Marcin Kuzminski <marcin@python-works.com>
parents: 683
diff changeset
356
1071
bdc438fb4fe4 Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents: 939
diff changeset
357 - Apache doesn't pass basicAuth on pull/push ?
591
1e2adb37cab6 docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 572
diff changeset
358
1089
fd4cd3c1d7e9 - First cut at some documentation corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
359 - Make sure you added `WSGIPassAuthorization true`
591
1e2adb37cab6 docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 572
diff changeset
360
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 568
diff changeset
361 .. _virtualenv: http://pypi.python.org/pypi/virtualenv
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 568
diff changeset
362 .. _python: http://www.python.org/
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 568
diff changeset
363 .. _mercurial: http://mercurial.selenic.com/
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 568
diff changeset
364 .. _celery: http://celeryproject.org/
1071
bdc438fb4fe4 Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents: 939
diff changeset
365 .. _rabbitmq: http://www.rabbitmq.com/
bdc438fb4fe4 Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents: 939
diff changeset
366 .. _python-ldap: http://www.python-ldap.org/