Show More
@@ -1,712 +1,715 b'' | |||||
1 | .. _setup: |
|
1 | .. _setup: | |
2 |
|
2 | |||
3 | ===== |
|
3 | ===== | |
4 | Setup |
|
4 | Setup | |
5 | ===== |
|
5 | ===== | |
6 |
|
6 | |||
7 |
|
7 | |||
8 | Setting up RhodeCode |
|
8 | Setting up RhodeCode | |
9 | -------------------- |
|
9 | -------------------- | |
10 |
|
10 | |||
11 | First, you will need to create a RhodeCode configuration file. Run the |
|
11 | First, you will need to create a RhodeCode configuration file. Run the | |
12 | following command to do this:: |
|
12 | following command to do this:: | |
13 |
|
13 | |||
14 | paster make-config RhodeCode production.ini |
|
14 | paster make-config RhodeCode production.ini | |
15 |
|
15 | |||
16 | - This will create the file `production.ini` in the current directory. This |
|
16 | - This will create the file `production.ini` in the current directory. This | |
17 | configuration file contains the various settings for RhodeCode, e.g proxy |
|
17 | configuration file contains the various settings for RhodeCode, e.g proxy | |
18 | port, email settings, usage of static files, cache, celery settings and |
|
18 | port, email settings, usage of static files, cache, celery settings and | |
19 | logging. |
|
19 | logging. | |
20 |
|
20 | |||
21 |
|
21 | |||
22 | Next, you need to create the databases used by RhodeCode. I recommend that you |
|
22 | Next, you need to create the databases used by RhodeCode. I recommend that you | |
23 | use postgresql or sqlite (default). If you choose a database other than the |
|
23 | use postgresql or sqlite (default). If you choose a database other than the | |
24 | default ensure you properly adjust the db url in your production.ini |
|
24 | default ensure you properly adjust the db url in your production.ini | |
25 | configuration file to use this other database. RhodeCode currently supports |
|
25 | configuration file to use this other database. RhodeCode currently supports | |
26 | postgresql, sqlite and mysql databases. Create the database by running |
|
26 | postgresql, sqlite and mysql databases. Create the database by running | |
27 | the following command:: |
|
27 | the following command:: | |
28 |
|
28 | |||
29 | paster setup-rhodecode production.ini |
|
29 | paster setup-rhodecode production.ini | |
30 |
|
30 | |||
31 | This will prompt you for a "root" path. This "root" path is the location where |
|
31 | This will prompt you for a "root" path. This "root" path is the location where | |
32 | RhodeCode will store all of its repositories on the current machine. After |
|
32 | RhodeCode will store all of its repositories on the current machine. After | |
33 | entering this "root" path ``setup-rhodecode`` will also prompt you for a username |
|
33 | entering this "root" path ``setup-rhodecode`` will also prompt you for a username | |
34 | and password for the initial admin account which ``setup-rhodecode`` sets |
|
34 | and password for the initial admin account which ``setup-rhodecode`` sets | |
35 | up for you. |
|
35 | up for you. | |
36 |
|
36 | |||
37 | setup process can be fully automated, example for lazy:: |
|
37 | setup process can be fully automated, example for lazy:: | |
38 |
|
38 | |||
39 | paster setup-rhodecode production.ini --user=marcink --password=secret --email=marcin@rhodecode.org --repos=/home/marcink/my_repos |
|
39 | paster setup-rhodecode production.ini --user=marcink --password=secret --email=marcin@rhodecode.org --repos=/home/marcink/my_repos | |
40 |
|
40 | |||
41 |
|
41 | |||
42 | - The ``setup-rhodecode`` command will create all of the needed tables and an |
|
42 | - The ``setup-rhodecode`` command will create all of the needed tables and an | |
43 | admin account. When choosing a root path you can either use a new empty |
|
43 | admin account. When choosing a root path you can either use a new empty | |
44 | location, or a location which already contains existing repositories. If you |
|
44 | location, or a location which already contains existing repositories. If you | |
45 | choose a location which contains existing repositories RhodeCode will simply |
|
45 | choose a location which contains existing repositories RhodeCode will simply | |
46 | add all of the repositories at the chosen location to it's database. |
|
46 | add all of the repositories at the chosen location to it's database. | |
47 | (Note: make sure you specify the correct path to the root). |
|
47 | (Note: make sure you specify the correct path to the root). | |
48 | - Note: the given path for mercurial_ repositories **must** be write accessible |
|
48 | - Note: the given path for mercurial_ repositories **must** be write accessible | |
49 | for the application. It's very important since the RhodeCode web interface |
|
49 | for the application. It's very important since the RhodeCode web interface | |
50 | will work without write access, but when trying to do a push it will |
|
50 | will work without write access, but when trying to do a push it will | |
51 | eventually fail with permission denied errors unless it has write access. |
|
51 | eventually fail with permission denied errors unless it has write access. | |
52 |
|
52 | |||
53 | You are now ready to use RhodeCode, to run it simply execute:: |
|
53 | You are now ready to use RhodeCode, to run it simply execute:: | |
54 |
|
54 | |||
55 | paster serve production.ini |
|
55 | paster serve production.ini | |
56 |
|
56 | |||
57 | - This command runs the RhodeCode server. The web app should be available at the |
|
57 | - This command runs the RhodeCode server. The web app should be available at the | |
58 | 127.0.0.1:5000. This ip and port is configurable via the production.ini |
|
58 | 127.0.0.1:5000. This ip and port is configurable via the production.ini | |
59 | file created in previous step |
|
59 | file created in previous step | |
60 | - Use the admin account you created above when running ``setup-rhodecode`` |
|
60 | - Use the admin account you created above when running ``setup-rhodecode`` | |
61 | to login to the web app. |
|
61 | to login to the web app. | |
62 | - The default permissions on each repository is read, and the owner is admin. |
|
62 | - The default permissions on each repository is read, and the owner is admin. | |
63 | Remember to update these if needed. |
|
63 | Remember to update these if needed. | |
64 | - In the admin panel you can toggle ldap, anonymous, permissions settings. As |
|
64 | - In the admin panel you can toggle ldap, anonymous, permissions settings. As | |
65 | well as edit more advanced options on users and repositories |
|
65 | well as edit more advanced options on users and repositories | |
66 |
|
66 | |||
67 | Optionally users can create `rcextensions` package that extends RhodeCode |
|
67 | Optionally users can create `rcextensions` package that extends RhodeCode | |
68 | functionality. To do this simply execute:: |
|
68 | functionality. To do this simply execute:: | |
69 |
|
69 | |||
70 | paster make-rcext production.ini |
|
70 | paster make-rcext production.ini | |
71 |
|
71 | |||
72 | This will create `rcextensions` package in the same place that your `ini` file |
|
72 | This will create `rcextensions` package in the same place that your `ini` file | |
73 | lives. With `rcextensions` it's possible to add additional mapping for whoosh, |
|
73 | lives. With `rcextensions` it's possible to add additional mapping for whoosh, | |
74 | stats and add additional code into the push/pull/create repo hooks. For example |
|
74 | stats and add additional code into the push/pull/create repo hooks. For example | |
75 | for sending signals to build-bots such as jenkins. |
|
75 | for sending signals to build-bots such as jenkins. | |
76 | Please see the `__init__.py` file inside `rcextensions` package |
|
76 | Please see the `__init__.py` file inside `rcextensions` package | |
77 | for more details. |
|
77 | for more details. | |
78 |
|
78 | |||
79 |
|
79 | |||
80 | Using RhodeCode with SSH |
|
80 | Using RhodeCode with SSH | |
81 | ------------------------ |
|
81 | ------------------------ | |
82 |
|
82 | |||
83 | RhodeCode currently only hosts repositories using http and https. (The addition |
|
83 | RhodeCode currently only hosts repositories using http and https. (The addition | |
84 | of ssh hosting is a planned future feature.) However you can easily use ssh in |
|
84 | of ssh hosting is a planned future feature.) However you can easily use ssh in | |
85 | parallel with RhodeCode. (Repository access via ssh is a standard "out of |
|
85 | parallel with RhodeCode. (Repository access via ssh is a standard "out of | |
86 | the box" feature of mercurial_ and you can use this to access any of the |
|
86 | the box" feature of mercurial_ and you can use this to access any of the | |
87 | repositories that RhodeCode is hosting. See PublishingRepositories_) |
|
87 | repositories that RhodeCode is hosting. See PublishingRepositories_) | |
88 |
|
88 | |||
89 | RhodeCode repository structures are kept in directories with the same name |
|
89 | RhodeCode repository structures are kept in directories with the same name | |
90 | as the project. When using repository groups, each group is a subdirectory. |
|
90 | as the project. When using repository groups, each group is a subdirectory. | |
91 | This allows you to easily use ssh for accessing repositories. |
|
91 | This allows you to easily use ssh for accessing repositories. | |
92 |
|
92 | |||
93 | In order to use ssh you need to make sure that your web-server and the users |
|
93 | In order to use ssh you need to make sure that your web-server and the users | |
94 | login accounts have the correct permissions set on the appropriate directories. |
|
94 | login accounts have the correct permissions set on the appropriate directories. | |
95 | (Note that these permissions are independent of any permissions you have set up |
|
95 | (Note that these permissions are independent of any permissions you have set up | |
96 | using the RhodeCode web interface.) |
|
96 | using the RhodeCode web interface.) | |
97 |
|
97 | |||
98 | If your main directory (the same as set in RhodeCode settings) is for example |
|
98 | If your main directory (the same as set in RhodeCode settings) is for example | |
99 | set to **/home/hg** and the repository you are using is named `rhodecode`, then |
|
99 | set to **/home/hg** and the repository you are using is named `rhodecode`, then | |
100 | to clone via ssh you should run:: |
|
100 | to clone via ssh you should run:: | |
101 |
|
101 | |||
102 | hg clone ssh://user@server.com/home/hg/rhodecode |
|
102 | hg clone ssh://user@server.com/home/hg/rhodecode | |
103 |
|
103 | |||
104 | Using other external tools such as mercurial-server_ or using ssh key based |
|
104 | Using other external tools such as mercurial-server_ or using ssh key based | |
105 | authentication is fully supported. |
|
105 | authentication is fully supported. | |
106 |
|
106 | |||
107 | Note: In an advanced setup, in order for your ssh access to use the same |
|
107 | Note: In an advanced setup, in order for your ssh access to use the same | |
108 | permissions as set up via the RhodeCode web interface, you can create an |
|
108 | permissions as set up via the RhodeCode web interface, you can create an | |
109 | authentication hook to connect to the rhodecode db and runs check functions for |
|
109 | authentication hook to connect to the rhodecode db and runs check functions for | |
110 | permissions against that. |
|
110 | permissions against that. | |
111 |
|
111 | |||
112 | Setting up Whoosh full text search |
|
112 | Setting up Whoosh full text search | |
113 | ---------------------------------- |
|
113 | ---------------------------------- | |
114 |
|
114 | |||
115 | Starting from version 1.1 the whoosh index can be build by using the paster |
|
115 | Starting from version 1.1 the whoosh index can be build by using the paster | |
116 | command ``make-index``. To use ``make-index`` you must specify the configuration |
|
116 | command ``make-index``. To use ``make-index`` you must specify the configuration | |
117 | file that stores the location of the index. You may specify the location of the |
|
117 | file that stores the location of the index. You may specify the location of the | |
118 | repositories (`--repo-location`). If not specified, this value is retrieved |
|
118 | repositories (`--repo-location`). If not specified, this value is retrieved | |
119 | from the RhodeCode database. This was required prior to 1.2. Starting from |
|
119 | from the RhodeCode database. This was required prior to 1.2. Starting from | |
120 | version 1.2 it is also possible to specify a comma separated list of |
|
120 | version 1.2 it is also possible to specify a comma separated list of | |
121 | repositories (`--index-only`) to build index only on chooses repositories |
|
121 | repositories (`--index-only`) to build index only on chooses repositories | |
122 | skipping any other found in repos location |
|
122 | skipping any other found in repos location | |
123 |
|
123 | |||
124 | You may optionally pass the option `-f` to enable a full index rebuild. Without |
|
124 | You may optionally pass the option `-f` to enable a full index rebuild. Without | |
125 | the `-f` option, indexing will run always in "incremental" mode. |
|
125 | the `-f` option, indexing will run always in "incremental" mode. | |
126 |
|
126 | |||
127 | For an incremental index build use:: |
|
127 | For an incremental index build use:: | |
128 |
|
128 | |||
129 | paster make-index production.ini |
|
129 | paster make-index production.ini | |
130 |
|
130 | |||
131 | For a full index rebuild use:: |
|
131 | For a full index rebuild use:: | |
132 |
|
132 | |||
133 | paster make-index production.ini -f |
|
133 | paster make-index production.ini -f | |
134 |
|
134 | |||
135 |
|
135 | |||
136 | building index just for chosen repositories is possible with such command:: |
|
136 | building index just for chosen repositories is possible with such command:: | |
137 |
|
137 | |||
138 | paster make-index production.ini --index-only=vcs,rhodecode |
|
138 | paster make-index production.ini --index-only=vcs,rhodecode | |
139 |
|
139 | |||
140 |
|
140 | |||
141 | In order to do periodical index builds and keep your index always up to date. |
|
141 | In order to do periodical index builds and keep your index always up to date. | |
142 | It's recommended to do a crontab entry for incremental indexing. |
|
142 | It's recommended to do a crontab entry for incremental indexing. | |
143 | An example entry might look like this:: |
|
143 | An example entry might look like this:: | |
144 |
|
144 | |||
145 | /path/to/python/bin/paster make-index /path/to/rhodecode/production.ini |
|
145 | /path/to/python/bin/paster make-index /path/to/rhodecode/production.ini | |
146 |
|
146 | |||
147 | When using incremental mode (the default) whoosh will check the last |
|
147 | When using incremental mode (the default) whoosh will check the last | |
148 | modification date of each file and add it to be reindexed if a newer file is |
|
148 | modification date of each file and add it to be reindexed if a newer file is | |
149 | available. The indexing daemon checks for any removed files and removes them |
|
149 | available. The indexing daemon checks for any removed files and removes them | |
150 | from index. |
|
150 | from index. | |
151 |
|
151 | |||
152 | If you want to rebuild index from scratch, you can use the `-f` flag as above, |
|
152 | If you want to rebuild index from scratch, you can use the `-f` flag as above, | |
153 | or in the admin panel you can check `build from scratch` flag. |
|
153 | or in the admin panel you can check `build from scratch` flag. | |
154 |
|
154 | |||
155 |
|
155 | |||
156 | Setting up LDAP support |
|
156 | Setting up LDAP support | |
157 | ----------------------- |
|
157 | ----------------------- | |
158 |
|
158 | |||
159 | RhodeCode starting from version 1.1 supports ldap authentication. In order |
|
159 | RhodeCode starting from version 1.1 supports ldap authentication. In order | |
160 | to use LDAP, you have to install the python-ldap_ package. This package is |
|
160 | to use LDAP, you have to install the python-ldap_ package. This package is | |
161 | available via pypi, so you can install it by running |
|
161 | available via pypi, so you can install it by running | |
162 |
|
162 | |||
163 | using easy_install:: |
|
163 | using easy_install:: | |
164 |
|
164 | |||
165 | easy_install python-ldap |
|
165 | easy_install python-ldap | |
166 |
|
166 | |||
167 | using pip:: |
|
167 | using pip:: | |
168 |
|
168 | |||
169 | pip install python-ldap |
|
169 | pip install python-ldap | |
170 |
|
170 | |||
171 | .. note:: |
|
171 | .. note:: | |
172 | python-ldap requires some certain libs on your system, so before installing |
|
172 | python-ldap requires some certain libs on your system, so before installing | |
173 | it check that you have at least `openldap`, and `sasl` libraries. |
|
173 | it check that you have at least `openldap`, and `sasl` libraries. | |
174 |
|
174 | |||
175 | LDAP settings are located in admin->ldap section, |
|
175 | LDAP settings are located in admin->ldap section, | |
176 |
|
176 | |||
177 | Here's a typical ldap setup:: |
|
177 | Here's a typical ldap setup:: | |
178 |
|
178 | |||
179 | Connection settings |
|
179 | Connection settings | |
180 | Enable LDAP = checked |
|
180 | Enable LDAP = checked | |
181 | Host = host.example.org |
|
181 | Host = host.example.org | |
182 | Port = 389 |
|
182 | Port = 389 | |
183 | Account = <account> |
|
183 | Account = <account> | |
184 | Password = <password> |
|
184 | Password = <password> | |
185 | Connection Security = LDAPS connection |
|
185 | Connection Security = LDAPS connection | |
186 | Certificate Checks = DEMAND |
|
186 | Certificate Checks = DEMAND | |
187 |
|
187 | |||
188 | Search settings |
|
188 | Search settings | |
189 | Base DN = CN=users,DC=host,DC=example,DC=org |
|
189 | Base DN = CN=users,DC=host,DC=example,DC=org | |
190 | LDAP Filter = (&(objectClass=user)(!(objectClass=computer))) |
|
190 | LDAP Filter = (&(objectClass=user)(!(objectClass=computer))) | |
191 | LDAP Search Scope = SUBTREE |
|
191 | LDAP Search Scope = SUBTREE | |
192 |
|
192 | |||
193 | Attribute mappings |
|
193 | Attribute mappings | |
194 | Login Attribute = uid |
|
194 | Login Attribute = uid | |
195 | First Name Attribute = firstName |
|
195 | First Name Attribute = firstName | |
196 | Last Name Attribute = lastName |
|
196 | Last Name Attribute = lastName | |
197 | E-mail Attribute = mail |
|
197 | E-mail Attribute = mail | |
198 |
|
198 | |||
199 | .. _enable_ldap: |
|
199 | .. _enable_ldap: | |
200 |
|
200 | |||
201 | Enable LDAP : required |
|
201 | Enable LDAP : required | |
202 | Whether to use LDAP for authenticating users. |
|
202 | Whether to use LDAP for authenticating users. | |
203 |
|
203 | |||
204 | .. _ldap_host: |
|
204 | .. _ldap_host: | |
205 |
|
205 | |||
206 | Host : required |
|
206 | Host : required | |
207 | LDAP server hostname or IP address. |
|
207 | LDAP server hostname or IP address. | |
208 |
|
208 | |||
209 | .. _Port: |
|
209 | .. _Port: | |
210 |
|
210 | |||
211 | Port : required |
|
211 | Port : required | |
212 | 389 for un-encrypted LDAP, 636 for SSL-encrypted LDAP. |
|
212 | 389 for un-encrypted LDAP, 636 for SSL-encrypted LDAP. | |
213 |
|
213 | |||
214 | .. _ldap_account: |
|
214 | .. _ldap_account: | |
215 |
|
215 | |||
216 | Account : optional |
|
216 | Account : optional | |
217 | Only required if the LDAP server does not allow anonymous browsing of |
|
217 | Only required if the LDAP server does not allow anonymous browsing of | |
218 | records. This should be a special account for record browsing. This |
|
218 | records. This should be a special account for record browsing. This | |
219 | will require `LDAP Password`_ below. |
|
219 | will require `LDAP Password`_ below. | |
220 |
|
220 | |||
221 | .. _LDAP Password: |
|
221 | .. _LDAP Password: | |
222 |
|
222 | |||
223 | Password : optional |
|
223 | Password : optional | |
224 | Only required if the LDAP server does not allow anonymous browsing of |
|
224 | Only required if the LDAP server does not allow anonymous browsing of | |
225 | records. |
|
225 | records. | |
226 |
|
226 | |||
227 | .. _Enable LDAPS: |
|
227 | .. _Enable LDAPS: | |
228 |
|
228 | |||
229 | Connection Security : required |
|
229 | Connection Security : required | |
230 | Defines the connection to LDAP server |
|
230 | Defines the connection to LDAP server | |
231 |
|
231 | |||
232 | No encryption |
|
232 | No encryption | |
233 | Plain non encrypted connection |
|
233 | Plain non encrypted connection | |
234 |
|
234 | |||
235 | LDAPS connection |
|
235 | LDAPS connection | |
236 | Enable ldaps connection. It will likely require `Port`_ to be set to |
|
236 | Enable ldaps connection. It will likely require `Port`_ to be set to | |
237 | a different value (standard LDAPS port is 636). When LDAPS is enabled |
|
237 | a different value (standard LDAPS port is 636). When LDAPS is enabled | |
238 | then `Certificate Checks`_ is required. |
|
238 | then `Certificate Checks`_ is required. | |
239 |
|
239 | |||
240 | START_TLS on LDAP connection |
|
240 | START_TLS on LDAP connection | |
241 | START TLS connection |
|
241 | START TLS connection | |
242 |
|
242 | |||
243 | .. _Certificate Checks: |
|
243 | .. _Certificate Checks: | |
244 |
|
244 | |||
245 | Certificate Checks : optional |
|
245 | Certificate Checks : optional | |
246 | How SSL certificates verification is handled - this is only useful when |
|
246 | How SSL certificates verification is handled - this is only useful when | |
247 | `Enable LDAPS`_ is enabled. Only DEMAND or HARD offer full SSL security |
|
247 | `Enable LDAPS`_ is enabled. Only DEMAND or HARD offer full SSL security | |
248 | while the other options are susceptible to man-in-the-middle attacks. SSL |
|
248 | while the other options are susceptible to man-in-the-middle attacks. SSL | |
249 | certificates can be installed to /etc/openldap/cacerts so that the |
|
249 | certificates can be installed to /etc/openldap/cacerts so that the | |
250 | DEMAND or HARD options can be used with self-signed certificates or |
|
250 | DEMAND or HARD options can be used with self-signed certificates or | |
251 | certificates that do not have traceable certificates of authority. |
|
251 | certificates that do not have traceable certificates of authority. | |
252 |
|
252 | |||
253 | NEVER |
|
253 | NEVER | |
254 | A serve certificate will never be requested or checked. |
|
254 | A serve certificate will never be requested or checked. | |
255 |
|
255 | |||
256 | ALLOW |
|
256 | ALLOW | |
257 | A server certificate is requested. Failure to provide a |
|
257 | A server certificate is requested. Failure to provide a | |
258 | certificate or providing a bad certificate will not terminate the |
|
258 | certificate or providing a bad certificate will not terminate the | |
259 | session. |
|
259 | session. | |
260 |
|
260 | |||
261 | TRY |
|
261 | TRY | |
262 | A server certificate is requested. Failure to provide a |
|
262 | A server certificate is requested. Failure to provide a | |
263 | certificate does not halt the session; providing a bad certificate |
|
263 | certificate does not halt the session; providing a bad certificate | |
264 | halts the session. |
|
264 | halts the session. | |
265 |
|
265 | |||
266 | DEMAND |
|
266 | DEMAND | |
267 | A server certificate is requested and must be provided and |
|
267 | A server certificate is requested and must be provided and | |
268 | authenticated for the session to proceed. |
|
268 | authenticated for the session to proceed. | |
269 |
|
269 | |||
270 | HARD |
|
270 | HARD | |
271 | The same as DEMAND. |
|
271 | The same as DEMAND. | |
272 |
|
272 | |||
273 | .. _Base DN: |
|
273 | .. _Base DN: | |
274 |
|
274 | |||
275 | Base DN : required |
|
275 | Base DN : required | |
276 | The Distinguished Name (DN) where searches for users will be performed. |
|
276 | The Distinguished Name (DN) where searches for users will be performed. | |
277 | Searches can be controlled by `LDAP Filter`_ and `LDAP Search Scope`_. |
|
277 | Searches can be controlled by `LDAP Filter`_ and `LDAP Search Scope`_. | |
278 |
|
278 | |||
279 | .. _LDAP Filter: |
|
279 | .. _LDAP Filter: | |
280 |
|
280 | |||
281 | LDAP Filter : optional |
|
281 | LDAP Filter : optional | |
282 | A LDAP filter defined by RFC 2254. This is more useful when `LDAP |
|
282 | A LDAP filter defined by RFC 2254. This is more useful when `LDAP | |
283 | Search Scope`_ is set to SUBTREE. The filter is useful for limiting |
|
283 | Search Scope`_ is set to SUBTREE. The filter is useful for limiting | |
284 | which LDAP objects are identified as representing Users for |
|
284 | which LDAP objects are identified as representing Users for | |
285 | authentication. The filter is augmented by `Login Attribute`_ below. |
|
285 | authentication. The filter is augmented by `Login Attribute`_ below. | |
286 | This can commonly be left blank. |
|
286 | This can commonly be left blank. | |
287 |
|
287 | |||
288 | .. _LDAP Search Scope: |
|
288 | .. _LDAP Search Scope: | |
289 |
|
289 | |||
290 | LDAP Search Scope : required |
|
290 | LDAP Search Scope : required | |
291 | This limits how far LDAP will search for a matching object. |
|
291 | This limits how far LDAP will search for a matching object. | |
292 |
|
292 | |||
293 | BASE |
|
293 | BASE | |
294 | Only allows searching of `Base DN`_ and is usually not what you |
|
294 | Only allows searching of `Base DN`_ and is usually not what you | |
295 | want. |
|
295 | want. | |
296 |
|
296 | |||
297 | ONELEVEL |
|
297 | ONELEVEL | |
298 | Searches all entries under `Base DN`_, but not Base DN itself. |
|
298 | Searches all entries under `Base DN`_, but not Base DN itself. | |
299 |
|
299 | |||
300 | SUBTREE |
|
300 | SUBTREE | |
301 | Searches all entries below `Base DN`_, but not Base DN itself. |
|
301 | Searches all entries below `Base DN`_, but not Base DN itself. | |
302 | When using SUBTREE `LDAP Filter`_ is useful to limit object |
|
302 | When using SUBTREE `LDAP Filter`_ is useful to limit object | |
303 | location. |
|
303 | location. | |
304 |
|
304 | |||
305 | .. _Login Attribute: |
|
305 | .. _Login Attribute: | |
306 |
|
306 | |||
307 | Login Attribute : required |
|
307 | Login Attribute : required | |
308 | The LDAP record attribute that will be matched as the USERNAME or |
|
308 | The LDAP record attribute that will be matched as the USERNAME or | |
309 | ACCOUNT used to connect to RhodeCode. This will be added to `LDAP |
|
309 | ACCOUNT used to connect to RhodeCode. This will be added to `LDAP | |
310 | Filter`_ for locating the User object. If `LDAP Filter`_ is specified as |
|
310 | Filter`_ for locating the User object. If `LDAP Filter`_ is specified as | |
311 | "LDAPFILTER", `Login Attribute`_ is specified as "uid" and the user has |
|
311 | "LDAPFILTER", `Login Attribute`_ is specified as "uid" and the user has | |
312 | connected as "jsmith" then the `LDAP Filter`_ will be augmented as below |
|
312 | connected as "jsmith" then the `LDAP Filter`_ will be augmented as below | |
313 | :: |
|
313 | :: | |
314 |
|
314 | |||
315 | (&(LDAPFILTER)(uid=jsmith)) |
|
315 | (&(LDAPFILTER)(uid=jsmith)) | |
316 |
|
316 | |||
317 | .. _ldap_attr_firstname: |
|
317 | .. _ldap_attr_firstname: | |
318 |
|
318 | |||
319 | First Name Attribute : required |
|
319 | First Name Attribute : required | |
320 | The LDAP record attribute which represents the user's first name. |
|
320 | The LDAP record attribute which represents the user's first name. | |
321 |
|
321 | |||
322 | .. _ldap_attr_lastname: |
|
322 | .. _ldap_attr_lastname: | |
323 |
|
323 | |||
324 | Last Name Attribute : required |
|
324 | Last Name Attribute : required | |
325 | The LDAP record attribute which represents the user's last name. |
|
325 | The LDAP record attribute which represents the user's last name. | |
326 |
|
326 | |||
327 | .. _ldap_attr_email: |
|
327 | .. _ldap_attr_email: | |
328 |
|
328 | |||
329 | Email Attribute : required |
|
329 | Email Attribute : required | |
330 | The LDAP record attribute which represents the user's email address. |
|
330 | The LDAP record attribute which represents the user's email address. | |
331 |
|
331 | |||
332 | If all data are entered correctly, and python-ldap_ is properly installed |
|
332 | If all data are entered correctly, and python-ldap_ is properly installed | |
333 | users should be granted access to RhodeCode with ldap accounts. At this |
|
333 | users should be granted access to RhodeCode with ldap accounts. At this | |
334 | time user information is copied from LDAP into the RhodeCode user database. |
|
334 | time user information is copied from LDAP into the RhodeCode user database. | |
335 | This means that updates of an LDAP user object may not be reflected as a |
|
335 | This means that updates of an LDAP user object may not be reflected as a | |
336 | user update in RhodeCode. |
|
336 | user update in RhodeCode. | |
337 |
|
337 | |||
338 | If You have problems with LDAP access and believe You entered correct |
|
338 | If You have problems with LDAP access and believe You entered correct | |
339 | information check out the RhodeCode logs, any error messages sent from LDAP |
|
339 | information check out the RhodeCode logs, any error messages sent from LDAP | |
340 | will be saved there. |
|
340 | will be saved there. | |
341 |
|
341 | |||
342 | Active Directory |
|
342 | Active Directory | |
343 | '''''''''''''''' |
|
343 | '''''''''''''''' | |
344 |
|
344 | |||
345 | RhodeCode can use Microsoft Active Directory for user authentication. This |
|
345 | RhodeCode can use Microsoft Active Directory for user authentication. This | |
346 | is done through an LDAP or LDAPS connection to Active Directory. The |
|
346 | is done through an LDAP or LDAPS connection to Active Directory. The | |
347 | following LDAP configuration settings are typical for using Active |
|
347 | following LDAP configuration settings are typical for using Active | |
348 | Directory :: |
|
348 | Directory :: | |
349 |
|
349 | |||
350 | Base DN = OU=SBSUsers,OU=Users,OU=MyBusiness,DC=v3sys,DC=local |
|
350 | Base DN = OU=SBSUsers,OU=Users,OU=MyBusiness,DC=v3sys,DC=local | |
351 | Login Attribute = sAMAccountName |
|
351 | Login Attribute = sAMAccountName | |
352 | First Name Attribute = givenName |
|
352 | First Name Attribute = givenName | |
353 | Last Name Attribute = sn |
|
353 | Last Name Attribute = sn | |
354 | E-mail Attribute = mail |
|
354 | E-mail Attribute = mail | |
355 |
|
355 | |||
356 | All other LDAP settings will likely be site-specific and should be |
|
356 | All other LDAP settings will likely be site-specific and should be | |
357 | appropriately configured. |
|
357 | appropriately configured. | |
358 |
|
358 | |||
359 |
|
359 | |||
360 | Authentication by container or reverse-proxy |
|
360 | Authentication by container or reverse-proxy | |
361 | -------------------------------------------- |
|
361 | -------------------------------------------- | |
362 |
|
362 | |||
363 | Starting with version 1.3, RhodeCode supports delegating the authentication |
|
363 | Starting with version 1.3, RhodeCode supports delegating the authentication | |
364 | of users to its WSGI container, or to a reverse-proxy server through which all |
|
364 | of users to its WSGI container, or to a reverse-proxy server through which all | |
365 | clients access the application. |
|
365 | clients access the application. | |
366 |
|
366 | |||
367 | When these authentication methods are enabled in RhodeCode, it uses the |
|
367 | When these authentication methods are enabled in RhodeCode, it uses the | |
368 | username that the container/proxy (Apache/Nginx/etc) authenticated and doesn't |
|
368 | username that the container/proxy (Apache/Nginx/etc) authenticated and doesn't | |
369 | perform the authentication itself. The authorization, however, is still done by |
|
369 | perform the authentication itself. The authorization, however, is still done by | |
370 | RhodeCode according to its settings. |
|
370 | RhodeCode according to its settings. | |
371 |
|
371 | |||
372 | When a user logs in for the first time using these authentication methods, |
|
372 | When a user logs in for the first time using these authentication methods, | |
373 | a matching user account is created in RhodeCode with default permissions. An |
|
373 | a matching user account is created in RhodeCode with default permissions. An | |
374 | administrator can then modify it using RhodeCode's admin interface. |
|
374 | administrator can then modify it using RhodeCode's admin interface. | |
375 | It's also possible for an administrator to create accounts and configure their |
|
375 | It's also possible for an administrator to create accounts and configure their | |
376 | permissions before the user logs in for the first time. |
|
376 | permissions before the user logs in for the first time. | |
377 |
|
377 | |||
378 | Container-based authentication |
|
378 | Container-based authentication | |
379 | '''''''''''''''''''''''''''''' |
|
379 | '''''''''''''''''''''''''''''' | |
380 |
|
380 | |||
381 | In a container-based authentication setup, RhodeCode reads the user name from |
|
381 | In a container-based authentication setup, RhodeCode reads the user name from | |
382 | the ``REMOTE_USER`` server variable provided by the WSGI container. |
|
382 | the ``REMOTE_USER`` server variable provided by the WSGI container. | |
383 |
|
383 | |||
384 | After setting up your container (see `Apache's WSGI config`_), you'd need |
|
384 | After setting up your container (see `Apache's WSGI config`_), you'd need | |
385 | to configure it to require authentication on the location configured for |
|
385 | to configure it to require authentication on the location configured for | |
386 | RhodeCode. |
|
386 | RhodeCode. | |
387 |
|
387 | |||
388 | In order for RhodeCode to start using the provided username, you should set the |
|
388 | In order for RhodeCode to start using the provided username, you should set the | |
389 | following in the [app:main] section of your .ini file:: |
|
389 | following in the [app:main] section of your .ini file:: | |
390 |
|
390 | |||
391 | container_auth_enabled = true |
|
391 | container_auth_enabled = true | |
392 |
|
392 | |||
393 |
|
393 | |||
394 | Proxy pass-through authentication |
|
394 | Proxy pass-through authentication | |
395 | ''''''''''''''''''''''''''''''''' |
|
395 | ''''''''''''''''''''''''''''''''' | |
396 |
|
396 | |||
397 | In a proxy pass-through authentication setup, RhodeCode reads the user name |
|
397 | In a proxy pass-through authentication setup, RhodeCode reads the user name | |
398 | from the ``X-Forwarded-User`` request header, which should be configured to be |
|
398 | from the ``X-Forwarded-User`` request header, which should be configured to be | |
399 | sent by the reverse-proxy server. |
|
399 | sent by the reverse-proxy server. | |
400 |
|
400 | |||
401 | After setting up your proxy solution (see `Apache virtual host reverse proxy example`_, |
|
401 | After setting up your proxy solution (see `Apache virtual host reverse proxy example`_, | |
402 | `Apache as subdirectory`_ or `Nginx virtual host example`_), you'd need to |
|
402 | `Apache as subdirectory`_ or `Nginx virtual host example`_), you'd need to | |
403 | configure the authentication and add the username in a request header named |
|
403 | configure the authentication and add the username in a request header named | |
404 | ``X-Forwarded-User``. |
|
404 | ``X-Forwarded-User``. | |
405 |
|
405 | |||
406 | For example, the following config section for Apache sets a subdirectory in a |
|
406 | For example, the following config section for Apache sets a subdirectory in a | |
407 | reverse-proxy setup with basic auth:: |
|
407 | reverse-proxy setup with basic auth:: | |
408 |
|
408 | |||
409 | <Location /<someprefix> > |
|
409 | <Location /<someprefix> > | |
410 | ProxyPass http://127.0.0.1:5000/<someprefix> |
|
410 | ProxyPass http://127.0.0.1:5000/<someprefix> | |
411 | ProxyPassReverse http://127.0.0.1:5000/<someprefix> |
|
411 | ProxyPassReverse http://127.0.0.1:5000/<someprefix> | |
412 | SetEnvIf X-Url-Scheme https HTTPS=1 |
|
412 | SetEnvIf X-Url-Scheme https HTTPS=1 | |
413 |
|
413 | |||
414 | AuthType Basic |
|
414 | AuthType Basic | |
415 | AuthName "RhodeCode authentication" |
|
415 | AuthName "RhodeCode authentication" | |
416 | AuthUserFile /home/web/rhodecode/.htpasswd |
|
416 | AuthUserFile /home/web/rhodecode/.htpasswd | |
417 | require valid-user |
|
417 | require valid-user | |
418 |
|
418 | |||
419 | RequestHeader unset X-Forwarded-User |
|
419 | RequestHeader unset X-Forwarded-User | |
420 |
|
420 | |||
421 | RewriteEngine On |
|
421 | RewriteEngine On | |
422 | RewriteCond %{LA-U:REMOTE_USER} (.+) |
|
422 | RewriteCond %{LA-U:REMOTE_USER} (.+) | |
423 | RewriteRule .* - [E=RU:%1] |
|
423 | RewriteRule .* - [E=RU:%1] | |
424 | RequestHeader set X-Forwarded-User %{RU}e |
|
424 | RequestHeader set X-Forwarded-User %{RU}e | |
425 | </Location> |
|
425 | </Location> | |
426 |
|
426 | |||
427 | In order for RhodeCode to start using the forwarded username, you should set |
|
427 | In order for RhodeCode to start using the forwarded username, you should set | |
428 | the following in the [app:main] section of your .ini file:: |
|
428 | the following in the [app:main] section of your .ini file:: | |
429 |
|
429 | |||
430 | proxypass_auth_enabled = true |
|
430 | proxypass_auth_enabled = true | |
431 |
|
431 | |||
432 | .. note:: |
|
432 | .. note:: | |
433 | If you enable proxy pass-through authentication, make sure your server is |
|
433 | If you enable proxy pass-through authentication, make sure your server is | |
434 | only accessible through the proxy. Otherwise, any client would be able to |
|
434 | only accessible through the proxy. Otherwise, any client would be able to | |
435 | forge the authentication header and could effectively become authenticated |
|
435 | forge the authentication header and could effectively become authenticated | |
436 | using any account of their liking. |
|
436 | using any account of their liking. | |
437 |
|
437 | |||
438 | Integration with Issue trackers |
|
438 | Integration with Issue trackers | |
439 | ------------------------------- |
|
439 | ------------------------------- | |
440 |
|
440 | |||
441 | RhodeCode provides a simple integration with issue trackers. It's possible |
|
441 | RhodeCode provides a simple integration with issue trackers. It's possible | |
442 | to define a regular expression that will fetch issue id stored in commit |
|
442 | to define a regular expression that will fetch issue id stored in commit | |
443 | messages and replace that with an url to this issue. To enable this simply |
|
443 | messages and replace that with an url to this issue. To enable this simply | |
444 | uncomment following variables in the ini file:: |
|
444 | uncomment following variables in the ini file:: | |
445 |
|
445 | |||
446 | url_pat = (?:^#|\s#)(\w+) |
|
446 | url_pat = (?:^#|\s#)(\w+) | |
447 | issue_server_link = https://myissueserver.com/{repo}/issue/{id} |
|
447 | issue_server_link = https://myissueserver.com/{repo}/issue/{id} | |
448 | issue_prefix = # |
|
448 | issue_prefix = # | |
449 |
|
449 | |||
450 | `url_pat` is the regular expression that will fetch issues from commit messages. |
|
450 | `url_pat` is the regular expression that will fetch issues from commit messages. | |
451 | Default regex will match issues in format of #<number> eg. #300. |
|
451 | Default regex will match issues in format of #<number> eg. #300. | |
452 |
|
452 | |||
453 | Matched issues will be replace with the link specified as `issue_server_link` |
|
453 | Matched issues will be replace with the link specified as `issue_server_link` | |
454 | {id} will be replaced with issue id, and {repo} with repository name. |
|
454 | {id} will be replaced with issue id, and {repo} with repository name. | |
455 | Since the # is striped `issue_prefix` is added as a prefix to url. |
|
455 | Since the # is striped `issue_prefix` is added as a prefix to url. | |
456 | `issue_prefix` can be something different than # if you pass |
|
456 | `issue_prefix` can be something different than # if you pass | |
457 | ISSUE- as issue prefix this will generate an url in format:: |
|
457 | ISSUE- as issue prefix this will generate an url in format:: | |
458 |
|
458 | |||
459 | <a href="https://myissueserver.com/example_repo/issue/300">ISSUE-300</a> |
|
459 | <a href="https://myissueserver.com/example_repo/issue/300">ISSUE-300</a> | |
460 |
|
460 | |||
461 | Hook management |
|
461 | Hook management | |
462 | --------------- |
|
462 | --------------- | |
463 |
|
463 | |||
464 | Hooks can be managed in similar way to this used in .hgrc files. |
|
464 | Hooks can be managed in similar way to this used in .hgrc files. | |
465 | To access hooks setting click `advanced setup` on Hooks section of Mercurial |
|
465 | To access hooks setting click `advanced setup` on Hooks section of Mercurial | |
466 | Settings in Admin. |
|
466 | Settings in Admin. | |
467 |
|
467 | |||
468 | There are 4 built in hooks that cannot be changed (only enable/disable by |
|
468 | There are 4 built in hooks that cannot be changed (only enable/disable by | |
469 | checkboxes on previos section). |
|
469 | checkboxes on previos section). | |
470 | To add another custom hook simply fill in first section with |
|
470 | To add another custom hook simply fill in first section with | |
471 | <name>.<hook_type> and the second one with hook path. Example hooks |
|
471 | <name>.<hook_type> and the second one with hook path. Example hooks | |
472 | can be found at *rhodecode.lib.hooks*. |
|
472 | can be found at *rhodecode.lib.hooks*. | |
473 |
|
473 | |||
474 |
|
474 | |||
475 | Changing default encoding |
|
475 | Changing default encoding | |
476 | ------------------------- |
|
476 | ------------------------- | |
477 |
|
477 | |||
478 | By default RhodeCode uses utf8 encoding, starting from 1.3 series this |
|
478 | By default RhodeCode uses utf8 encoding, starting from 1.3 series this | |
479 | can be changed, simply edit default_encoding in .ini file to desired one. |
|
479 | can be changed, simply edit default_encoding in .ini file to desired one. | |
480 | This affects many parts in rhodecode including commiters names, filenames, |
|
480 | This affects many parts in rhodecode including commiters names, filenames, | |
481 | encoding of commit messages. In addition RhodeCode can detect if `chardet` |
|
481 | encoding of commit messages. In addition RhodeCode can detect if `chardet` | |
482 | library is installed. If `chardet` is detected RhodeCode will fallback to it |
|
482 | library is installed. If `chardet` is detected RhodeCode will fallback to it | |
483 | when there are encode/decode errors. |
|
483 | when there are encode/decode errors. | |
484 |
|
484 | |||
485 |
|
485 | |||
486 | Setting Up Celery |
|
486 | Setting Up Celery | |
487 | ----------------- |
|
487 | ----------------- | |
488 |
|
488 | |||
489 | Since version 1.1 celery is configured by the rhodecode ini configuration files. |
|
489 | Since version 1.1 celery is configured by the rhodecode ini configuration files. | |
490 | Simply set use_celery=true in the ini file then add / change the configuration |
|
490 | Simply set use_celery=true in the ini file then add / change the configuration | |
491 | variables inside the ini file. |
|
491 | variables inside the ini file. | |
492 |
|
492 | |||
493 | Remember that the ini files use the format with '.' not with '_' like celery. |
|
493 | Remember that the ini files use the format with '.' not with '_' like celery. | |
494 | So for example setting `BROKER_HOST` in celery means setting `broker.host` in |
|
494 | So for example setting `BROKER_HOST` in celery means setting `broker.host` in | |
495 | the config file. |
|
495 | the config file. | |
496 |
|
496 | |||
497 | In order to start using celery run:: |
|
497 | In order to start using celery run:: | |
498 |
|
498 | |||
499 | paster celeryd <configfile.ini> |
|
499 | paster celeryd <configfile.ini> | |
500 |
|
500 | |||
501 |
|
501 | |||
502 | .. note:: |
|
502 | .. note:: | |
503 | Make sure you run this command from the same virtualenv, and with the same |
|
503 | Make sure you run this command from the same virtualenv, and with the same | |
504 | user that rhodecode runs. |
|
504 | user that rhodecode runs. | |
505 |
|
505 | |||
506 | HTTPS support |
|
506 | HTTPS support | |
507 | ------------- |
|
507 | ------------- | |
508 |
|
508 | |||
509 | There are two ways to enable https: |
|
509 | There are two ways to enable https: | |
510 |
|
510 | |||
511 | - Set HTTP_X_URL_SCHEME in your http server headers, than rhodecode will |
|
511 | - Set HTTP_X_URL_SCHEME in your http server headers, than rhodecode will | |
512 | recognize this headers and make proper https redirections |
|
512 | recognize this headers and make proper https redirections | |
513 | - Alternatively, change the `force_https = true` flag in the ini configuration |
|
513 | - Alternatively, change the `force_https = true` flag in the ini configuration | |
514 | to force using https, no headers are needed than to enable https |
|
514 | to force using https, no headers are needed than to enable https | |
515 |
|
515 | |||
516 |
|
516 | |||
517 | Nginx virtual host example |
|
517 | Nginx virtual host example | |
518 | -------------------------- |
|
518 | -------------------------- | |
519 |
|
519 | |||
520 | Sample config for nginx using proxy:: |
|
520 | Sample config for nginx using proxy:: | |
521 |
|
521 | |||
522 | upstream rc { |
|
522 | upstream rc { | |
523 | server 127.0.0.1:5000; |
|
523 | server 127.0.0.1:5000; | |
524 | # add more instances for load balancing |
|
524 | # add more instances for load balancing | |
525 | #server 127.0.0.1:5001; |
|
525 | #server 127.0.0.1:5001; | |
526 | #server 127.0.0.1:5002; |
|
526 | #server 127.0.0.1:5002; | |
527 | } |
|
527 | } | |
528 |
|
528 | |||
529 | server { |
|
529 | server { | |
530 | listen 80; |
|
530 | listen 80; | |
531 | server_name hg.myserver.com; |
|
531 | server_name hg.myserver.com; | |
532 | access_log /var/log/nginx/rhodecode.access.log; |
|
532 | access_log /var/log/nginx/rhodecode.access.log; | |
533 | error_log /var/log/nginx/rhodecode.error.log; |
|
533 | error_log /var/log/nginx/rhodecode.error.log; | |
534 |
|
534 | |||
535 | # uncomment if you have nginx with chunking module compiled |
|
535 | # uncomment if you have nginx with chunking module compiled | |
536 | # fixes the issues of having to put postBuffer data for large git |
|
536 | # fixes the issues of having to put postBuffer data for large git | |
537 | # pushes |
|
537 | # pushes | |
538 | #chunkin on; |
|
538 | #chunkin on; | |
539 | #error_page 411 = @my_411_error; |
|
539 | #error_page 411 = @my_411_error; | |
540 | #location @my_411_error { |
|
540 | #location @my_411_error { | |
541 | # chunkin_resume; |
|
541 | # chunkin_resume; | |
542 | #} |
|
542 | #} | |
543 |
|
543 | |||
|
544 | # uncomment if you want to serve static files by nginx | |||
|
545 | #root /path/to/installation/rhodecode/public; | |||
|
546 | ||||
544 | location / { |
|
547 | location / { | |
545 | try_files $uri @rhode; |
|
548 | try_files $uri @rhode; | |
546 | } |
|
549 | } | |
547 |
|
550 | |||
548 | location @rhode { |
|
551 | location @rhode { | |
549 | proxy_pass http://rc; |
|
552 | proxy_pass http://rc; | |
550 | include /etc/nginx/proxy.conf; |
|
553 | include /etc/nginx/proxy.conf; | |
551 | } |
|
554 | } | |
552 |
|
555 | |||
553 | } |
|
556 | } | |
554 |
|
557 | |||
555 | Here's the proxy.conf. It's tuned so it will not timeout on long |
|
558 | Here's the proxy.conf. It's tuned so it will not timeout on long | |
556 | pushes or large pushes:: |
|
559 | pushes or large pushes:: | |
557 |
|
560 | |||
558 | proxy_redirect off; |
|
561 | proxy_redirect off; | |
559 | proxy_set_header Host $host; |
|
562 | proxy_set_header Host $host; | |
560 | proxy_set_header X-Url-Scheme $scheme; |
|
563 | proxy_set_header X-Url-Scheme $scheme; | |
561 | proxy_set_header X-Host $http_host; |
|
564 | proxy_set_header X-Host $http_host; | |
562 | proxy_set_header X-Real-IP $remote_addr; |
|
565 | proxy_set_header X-Real-IP $remote_addr; | |
563 | proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; |
|
566 | proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; | |
564 | proxy_set_header Proxy-host $proxy_host; |
|
567 | proxy_set_header Proxy-host $proxy_host; | |
565 | client_max_body_size 400m; |
|
568 | client_max_body_size 400m; | |
566 | client_body_buffer_size 128k; |
|
569 | client_body_buffer_size 128k; | |
567 | proxy_buffering off; |
|
570 | proxy_buffering off; | |
568 | proxy_connect_timeout 7200; |
|
571 | proxy_connect_timeout 7200; | |
569 | proxy_send_timeout 7200; |
|
572 | proxy_send_timeout 7200; | |
570 | proxy_read_timeout 7200; |
|
573 | proxy_read_timeout 7200; | |
571 | proxy_buffers 8 32k; |
|
574 | proxy_buffers 8 32k; | |
572 |
|
575 | |||
573 | Also, when using root path with nginx you might set the static files to false |
|
576 | Also, when using root path with nginx you might set the static files to false | |
574 | in the production.ini file:: |
|
577 | in the production.ini file:: | |
575 |
|
578 | |||
576 | [app:main] |
|
579 | [app:main] | |
577 | use = egg:rhodecode |
|
580 | use = egg:rhodecode | |
578 | full_stack = true |
|
581 | full_stack = true | |
579 | static_files = false |
|
582 | static_files = false | |
580 | lang=en |
|
583 | lang=en | |
581 | cache_dir = %(here)s/data |
|
584 | cache_dir = %(here)s/data | |
582 |
|
585 | |||
583 | In order to not have the statics served by the application. This improves speed. |
|
586 | In order to not have the statics served by the application. This improves speed. | |
584 |
|
587 | |||
585 |
|
588 | |||
586 | Apache virtual host reverse proxy example |
|
589 | Apache virtual host reverse proxy example | |
587 | ----------------------------------------- |
|
590 | ----------------------------------------- | |
588 |
|
591 | |||
589 | Here is a sample configuration file for apache using proxy:: |
|
592 | Here is a sample configuration file for apache using proxy:: | |
590 |
|
593 | |||
591 | <VirtualHost *:80> |
|
594 | <VirtualHost *:80> | |
592 | ServerName hg.myserver.com |
|
595 | ServerName hg.myserver.com | |
593 | ServerAlias hg.myserver.com |
|
596 | ServerAlias hg.myserver.com | |
594 |
|
597 | |||
595 | <Proxy *> |
|
598 | <Proxy *> | |
596 | Order allow,deny |
|
599 | Order allow,deny | |
597 | Allow from all |
|
600 | Allow from all | |
598 | </Proxy> |
|
601 | </Proxy> | |
599 |
|
602 | |||
600 | #important ! |
|
603 | #important ! | |
601 | #Directive to properly generate url (clone url) for pylons |
|
604 | #Directive to properly generate url (clone url) for pylons | |
602 | ProxyPreserveHost On |
|
605 | ProxyPreserveHost On | |
603 |
|
606 | |||
604 | #rhodecode instance |
|
607 | #rhodecode instance | |
605 | ProxyPass / http://127.0.0.1:5000/ |
|
608 | ProxyPass / http://127.0.0.1:5000/ | |
606 | ProxyPassReverse / http://127.0.0.1:5000/ |
|
609 | ProxyPassReverse / http://127.0.0.1:5000/ | |
607 |
|
610 | |||
608 | #to enable https use line below |
|
611 | #to enable https use line below | |
609 | #SetEnvIf X-Url-Scheme https HTTPS=1 |
|
612 | #SetEnvIf X-Url-Scheme https HTTPS=1 | |
610 |
|
613 | |||
611 | </VirtualHost> |
|
614 | </VirtualHost> | |
612 |
|
615 | |||
613 |
|
616 | |||
614 | Additional tutorial |
|
617 | Additional tutorial | |
615 | http://wiki.pylonshq.com/display/pylonscookbook/Apache+as+a+reverse+proxy+for+Pylons |
|
618 | http://wiki.pylonshq.com/display/pylonscookbook/Apache+as+a+reverse+proxy+for+Pylons | |
616 |
|
619 | |||
617 |
|
620 | |||
618 | Apache as subdirectory |
|
621 | Apache as subdirectory | |
619 | ---------------------- |
|
622 | ---------------------- | |
620 |
|
623 | |||
621 | Apache subdirectory part:: |
|
624 | Apache subdirectory part:: | |
622 |
|
625 | |||
623 | <Location /<someprefix> > |
|
626 | <Location /<someprefix> > | |
624 | ProxyPass http://127.0.0.1:5000/<someprefix> |
|
627 | ProxyPass http://127.0.0.1:5000/<someprefix> | |
625 | ProxyPassReverse http://127.0.0.1:5000/<someprefix> |
|
628 | ProxyPassReverse http://127.0.0.1:5000/<someprefix> | |
626 | SetEnvIf X-Url-Scheme https HTTPS=1 |
|
629 | SetEnvIf X-Url-Scheme https HTTPS=1 | |
627 | </Location> |
|
630 | </Location> | |
628 |
|
631 | |||
629 | Besides the regular apache setup you will need to add the following line |
|
632 | Besides the regular apache setup you will need to add the following line | |
630 | into [app:main] section of your .ini file:: |
|
633 | into [app:main] section of your .ini file:: | |
631 |
|
634 | |||
632 | filter-with = proxy-prefix |
|
635 | filter-with = proxy-prefix | |
633 |
|
636 | |||
634 | Add the following at the end of the .ini file:: |
|
637 | Add the following at the end of the .ini file:: | |
635 |
|
638 | |||
636 | [filter:proxy-prefix] |
|
639 | [filter:proxy-prefix] | |
637 | use = egg:PasteDeploy#prefix |
|
640 | use = egg:PasteDeploy#prefix | |
638 | prefix = /<someprefix> |
|
641 | prefix = /<someprefix> | |
639 |
|
642 | |||
640 |
|
643 | |||
641 | then change <someprefix> into your choosen prefix |
|
644 | then change <someprefix> into your choosen prefix | |
642 |
|
645 | |||
643 | Apache's WSGI config |
|
646 | Apache's WSGI config | |
644 | -------------------- |
|
647 | -------------------- | |
645 |
|
648 | |||
646 | Alternatively, RhodeCode can be set up with Apache under mod_wsgi. For |
|
649 | Alternatively, RhodeCode can be set up with Apache under mod_wsgi. For | |
647 | that, you'll need to: |
|
650 | that, you'll need to: | |
648 |
|
651 | |||
649 | - Install mod_wsgi. If using a Debian-based distro, you can install |
|
652 | - Install mod_wsgi. If using a Debian-based distro, you can install | |
650 | the package libapache2-mod-wsgi:: |
|
653 | the package libapache2-mod-wsgi:: | |
651 |
|
654 | |||
652 | aptitude install libapache2-mod-wsgi |
|
655 | aptitude install libapache2-mod-wsgi | |
653 |
|
656 | |||
654 | - Enable mod_wsgi:: |
|
657 | - Enable mod_wsgi:: | |
655 |
|
658 | |||
656 | a2enmod wsgi |
|
659 | a2enmod wsgi | |
657 |
|
660 | |||
658 | - Create a wsgi dispatch script, like the one below. Make sure you |
|
661 | - Create a wsgi dispatch script, like the one below. Make sure you | |
659 | check the paths correctly point to where you installed RhodeCode |
|
662 | check the paths correctly point to where you installed RhodeCode | |
660 | and its Python Virtual Environment. |
|
663 | and its Python Virtual Environment. | |
661 | - Enable the WSGIScriptAlias directive for the wsgi dispatch script, |
|
664 | - Enable the WSGIScriptAlias directive for the wsgi dispatch script, | |
662 | as in the following example. Once again, check the paths are |
|
665 | as in the following example. Once again, check the paths are | |
663 | correctly specified. |
|
666 | correctly specified. | |
664 |
|
667 | |||
665 | Here is a sample excerpt from an Apache Virtual Host configuration file:: |
|
668 | Here is a sample excerpt from an Apache Virtual Host configuration file:: | |
666 |
|
669 | |||
667 | WSGIDaemonProcess pylons user=www-data group=www-data processes=1 \ |
|
670 | WSGIDaemonProcess pylons user=www-data group=www-data processes=1 \ | |
668 | threads=4 \ |
|
671 | threads=4 \ | |
669 | python-path=/home/web/rhodecode/pyenv/lib/python2.6/site-packages |
|
672 | python-path=/home/web/rhodecode/pyenv/lib/python2.6/site-packages | |
670 | WSGIScriptAlias / /home/web/rhodecode/dispatch.wsgi |
|
673 | WSGIScriptAlias / /home/web/rhodecode/dispatch.wsgi | |
671 | WSGIPassAuthorization On |
|
674 | WSGIPassAuthorization On | |
672 |
|
675 | |||
673 | Example wsgi dispatch script:: |
|
676 | Example wsgi dispatch script:: | |
674 |
|
677 | |||
675 | import os |
|
678 | import os | |
676 | os.environ["HGENCODING"] = "UTF-8" |
|
679 | os.environ["HGENCODING"] = "UTF-8" | |
677 | os.environ['PYTHON_EGG_CACHE'] = '/home/web/rhodecode/.egg-cache' |
|
680 | os.environ['PYTHON_EGG_CACHE'] = '/home/web/rhodecode/.egg-cache' | |
678 |
|
681 | |||
679 | # sometimes it's needed to set the curent dir |
|
682 | # sometimes it's needed to set the curent dir | |
680 | os.chdir('/home/web/rhodecode/') |
|
683 | os.chdir('/home/web/rhodecode/') | |
681 |
|
684 | |||
682 | import site |
|
685 | import site | |
683 | site.addsitedir("/home/web/rhodecode/pyenv/lib/python2.6/site-packages") |
|
686 | site.addsitedir("/home/web/rhodecode/pyenv/lib/python2.6/site-packages") | |
684 |
|
687 | |||
685 | from paste.deploy import loadapp |
|
688 | from paste.deploy import loadapp | |
686 | from paste.script.util.logging_config import fileConfig |
|
689 | from paste.script.util.logging_config import fileConfig | |
687 |
|
690 | |||
688 | fileConfig('/home/web/rhodecode/production.ini') |
|
691 | fileConfig('/home/web/rhodecode/production.ini') | |
689 | application = loadapp('config:/home/web/rhodecode/production.ini') |
|
692 | application = loadapp('config:/home/web/rhodecode/production.ini') | |
690 |
|
693 | |||
691 | Note: when using mod_wsgi you'll need to install the same version of |
|
694 | Note: when using mod_wsgi you'll need to install the same version of | |
692 | Mercurial that's inside RhodeCode's virtualenv also on the system's Python |
|
695 | Mercurial that's inside RhodeCode's virtualenv also on the system's Python | |
693 | environment. |
|
696 | environment. | |
694 |
|
697 | |||
695 |
|
698 | |||
696 | Other configuration files |
|
699 | Other configuration files | |
697 | ------------------------- |
|
700 | ------------------------- | |
698 |
|
701 | |||
699 | Some example init.d scripts can be found in init.d directory:: |
|
702 | Some example init.d scripts can be found in init.d directory:: | |
700 |
|
703 | |||
701 | https://secure.rhodecode.org/rhodecode/files/beta/init.d |
|
704 | https://secure.rhodecode.org/rhodecode/files/beta/init.d | |
702 |
|
705 | |||
703 | .. _virtualenv: http://pypi.python.org/pypi/virtualenv |
|
706 | .. _virtualenv: http://pypi.python.org/pypi/virtualenv | |
704 | .. _python: http://www.python.org/ |
|
707 | .. _python: http://www.python.org/ | |
705 | .. _mercurial: http://mercurial.selenic.com/ |
|
708 | .. _mercurial: http://mercurial.selenic.com/ | |
706 | .. _celery: http://celeryproject.org/ |
|
709 | .. _celery: http://celeryproject.org/ | |
707 | .. _rabbitmq: http://www.rabbitmq.com/ |
|
710 | .. _rabbitmq: http://www.rabbitmq.com/ | |
708 | .. _python-ldap: http://www.python-ldap.org/ |
|
711 | .. _python-ldap: http://www.python-ldap.org/ | |
709 | .. _mercurial-server: http://www.lshift.net/mercurial-server.html |
|
712 | .. _mercurial-server: http://www.lshift.net/mercurial-server.html | |
710 | .. _PublishingRepositories: http://mercurial.selenic.com/wiki/PublishingRepositories |
|
713 | .. _PublishingRepositories: http://mercurial.selenic.com/wiki/PublishingRepositories | |
711 | .. _Issues tracker: https://bitbucket.org/marcinkuzminski/rhodecode/issues |
|
714 | .. _Issues tracker: https://bitbucket.org/marcinkuzminski/rhodecode/issues | |
712 | .. _google group rhodecode: http://groups.google.com/group/rhodecode No newline at end of file |
|
715 | .. _google group rhodecode: http://groups.google.com/group/rhodecode |
General Comments 0
You need to be logged in to leave comments.
Login now