Mercurial > kallithea
annotate docs/setup.rst @ 1090:de86a0870874
- Further corrections to the setup page.
author | jfh <jason@jasonfharris.com> |
---|---|
date | Sat, 26 Feb 2011 19:55:40 +0100 |
parents | fd4cd3c1d7e9 |
children | e67786cb2afa |
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 | 17 email settings, usage of static files, cache, celery settings and logging. |
18 | |
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 | 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 | 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 |
1090
de86a0870874
- Further corrections to the setup page.
jfh <jason@jasonfharris.com>
parents:
1089
diff
changeset
|
60 the root. Test that you can browse your repository from within RhodeCode and then |
1089
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 |
1090
de86a0870874
- Further corrections to the setup page.
jfh <jason@jasonfharris.com>
parents:
1089
diff
changeset
|
70 RhodeCode currently only hosts repositories using http and https. (The addition of |
de86a0870874
- Further corrections to the setup page.
jfh <jason@jasonfharris.com>
parents:
1089
diff
changeset
|
71 ssh hosting is a planned future feature.) However you can easily use ssh in |
de86a0870874
- Further corrections to the setup page.
jfh <jason@jasonfharris.com>
parents:
1089
diff
changeset
|
72 parallel with RhodeCode. (Repository access via ssh is a standard "out of |
de86a0870874
- Further corrections to the setup page.
jfh <jason@jasonfharris.com>
parents:
1089
diff
changeset
|
73 the box" feature of mercurial_ and you can use this to access any of the |
de86a0870874
- Further corrections to the setup page.
jfh <jason@jasonfharris.com>
parents:
1089
diff
changeset
|
74 repositories that RhodeCode is hosting. See PublishingRepositories_) |
1071
bdc438fb4fe4
Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents:
939
diff
changeset
|
75 |
1090
de86a0870874
- Further corrections to the setup page.
jfh <jason@jasonfharris.com>
parents:
1089
diff
changeset
|
76 RhodeCode repository structures are kept in directories with the same name |
de86a0870874
- Further corrections to the setup page.
jfh <jason@jasonfharris.com>
parents:
1089
diff
changeset
|
77 as the project. When using repository groups, each group is a subdirectory. |
de86a0870874
- Further corrections to the setup page.
jfh <jason@jasonfharris.com>
parents:
1089
diff
changeset
|
78 This allows you to easily use ssh for accessing repositories. |
1071
bdc438fb4fe4
Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents:
939
diff
changeset
|
79 |
1090
de86a0870874
- Further corrections to the setup page.
jfh <jason@jasonfharris.com>
parents:
1089
diff
changeset
|
80 In order to use ssh you need to make sure that your web-server and the users login |
de86a0870874
- Further corrections to the setup page.
jfh <jason@jasonfharris.com>
parents:
1089
diff
changeset
|
81 accounts have the correct permissions set on the appropriate directories. (Note |
de86a0870874
- Further corrections to the setup page.
jfh <jason@jasonfharris.com>
parents:
1089
diff
changeset
|
82 that these permissions are independent of any permissions you have set up using |
de86a0870874
- Further corrections to the setup page.
jfh <jason@jasonfharris.com>
parents:
1089
diff
changeset
|
83 the RhodeCode web interface.) |
1071
bdc438fb4fe4
Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents:
939
diff
changeset
|
84 |
1089
fd4cd3c1d7e9
- First cut at some documentation corrections.
jfh <jason@jasonfharris.com>
parents:
1071
diff
changeset
|
85 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
|
86 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
|
87 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
|
88 |
bdc438fb4fe4
Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents:
939
diff
changeset
|
89 hg clone ssh://user@server.com/home/hg/rhodecode |
1090
de86a0870874
- Further corrections to the setup page.
jfh <jason@jasonfharris.com>
parents:
1089
diff
changeset
|
90 |
de86a0870874
- Further corrections to the setup page.
jfh <jason@jasonfharris.com>
parents:
1089
diff
changeset
|
91 Using other external tools such as mercurial-server_ or using ssh key based |
1089
fd4cd3c1d7e9
- First cut at some documentation corrections.
jfh <jason@jasonfharris.com>
parents:
1071
diff
changeset
|
92 authentication is fully supported. |
1090
de86a0870874
- Further corrections to the setup page.
jfh <jason@jasonfharris.com>
parents:
1089
diff
changeset
|
93 |
de86a0870874
- Further corrections to the setup page.
jfh <jason@jasonfharris.com>
parents:
1089
diff
changeset
|
94 Note: In an advanced setup, in order for your ssh access to use the same |
de86a0870874
- Further corrections to the setup page.
jfh <jason@jasonfharris.com>
parents:
1089
diff
changeset
|
95 permissions as set up via the RhodeCode web interface, you can create an |
de86a0870874
- Further corrections to the setup page.
jfh <jason@jasonfharris.com>
parents:
1089
diff
changeset
|
96 authentication hook to connect to the rhodecode db and runs check functions for |
de86a0870874
- Further corrections to the setup page.
jfh <jason@jasonfharris.com>
parents:
1089
diff
changeset
|
97 permissions against that. |
de86a0870874
- Further corrections to the setup page.
jfh <jason@jasonfharris.com>
parents:
1089
diff
changeset
|
98 |
de86a0870874
- Further corrections to the setup page.
jfh <jason@jasonfharris.com>
parents:
1089
diff
changeset
|
99 |
592
0a48c1ec04fc
#37 fixed json imports for python2.5
Marcin Kuzminski <marcin@python-works.com>
parents:
591
diff
changeset
|
100 |
683
341beaa9edba
Implemented whoosh index building as paster command.
Marcin Kuzminski <marcin@python-works.com>
parents:
597
diff
changeset
|
101 Setting up Whoosh full text search |
341beaa9edba
Implemented whoosh index building as paster command.
Marcin Kuzminski <marcin@python-works.com>
parents:
597
diff
changeset
|
102 ---------------------------------- |
341beaa9edba
Implemented whoosh index building as paster command.
Marcin Kuzminski <marcin@python-works.com>
parents:
597
diff
changeset
|
103 |
1089
fd4cd3c1d7e9
- First cut at some documentation corrections.
jfh <jason@jasonfharris.com>
parents:
1071
diff
changeset
|
104 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
|
105 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
|
106 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
|
107 (`--repo-location`). |
1071
bdc438fb4fe4
Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents:
939
diff
changeset
|
108 |
1089
fd4cd3c1d7e9
- First cut at some documentation corrections.
jfh <jason@jasonfharris.com>
parents:
1071
diff
changeset
|
109 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
|
110 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
|
111 |
1089
fd4cd3c1d7e9
- First cut at some documentation corrections.
jfh <jason@jasonfharris.com>
parents:
1071
diff
changeset
|
112 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
|
113 |
1071
bdc438fb4fe4
Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents:
939
diff
changeset
|
114 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
|
115 |
1089
fd4cd3c1d7e9
- First cut at some documentation corrections.
jfh <jason@jasonfharris.com>
parents:
1071
diff
changeset
|
116 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
|
117 |
1071
bdc438fb4fe4
Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents:
939
diff
changeset
|
118 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
|
119 |
1089
fd4cd3c1d7e9
- First cut at some documentation corrections.
jfh <jason@jasonfharris.com>
parents:
1071
diff
changeset
|
120 - 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
|
121 |
1089
fd4cd3c1d7e9
- First cut at some documentation corrections.
jfh <jason@jasonfharris.com>
parents:
1071
diff
changeset
|
122 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
|
123 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
|
124 An example entry might look like this:: |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
568
diff
changeset
|
125 |
845 | 126 /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
|
127 |
1089
fd4cd3c1d7e9
- First cut at some documentation corrections.
jfh <jason@jasonfharris.com>
parents:
1071
diff
changeset
|
128 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
|
129 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
|
130 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
|
131 from index. |
683
341beaa9edba
Implemented whoosh index building as paster command.
Marcin Kuzminski <marcin@python-works.com>
parents:
597
diff
changeset
|
132 |
1089
fd4cd3c1d7e9
- First cut at some documentation corrections.
jfh <jason@jasonfharris.com>
parents:
1071
diff
changeset
|
133 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
|
134 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
|
135 |
707
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 Setting up LDAP support |
1105531ae572
docs update, added ldap section, added troubleshooting section
Marcin Kuzminski <marcin@python-works.com>
parents:
683
diff
changeset
|
138 ----------------------- |
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 RhodeCode starting from version 1.1 supports ldap authentication. In order |
1090
de86a0870874
- Further corrections to the setup page.
jfh <jason@jasonfharris.com>
parents:
1089
diff
changeset
|
141 to use LDAP, you have to install the python-ldap_ package. This package is available |
1089
fd4cd3c1d7e9
- First cut at some documentation corrections.
jfh <jason@jasonfharris.com>
parents:
1071
diff
changeset
|
142 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
|
143 |
1105531ae572
docs update, added ldap section, added troubleshooting section
Marcin Kuzminski <marcin@python-works.com>
parents:
683
diff
changeset
|
144 :: |
1105531ae572
docs update, added ldap section, added troubleshooting section
Marcin Kuzminski <marcin@python-works.com>
parents:
683
diff
changeset
|
145 |
733
ac701b421053
fixed docs, for python-ldap import
Marcin Kuzminski <marcin@python-works.com>
parents:
715
diff
changeset
|
146 easy_install python-ldap |
707
1105531ae572
docs update, added ldap section, added troubleshooting section
Marcin Kuzminski <marcin@python-works.com>
parents:
683
diff
changeset
|
147 |
1105531ae572
docs update, added ldap section, added troubleshooting section
Marcin Kuzminski <marcin@python-works.com>
parents:
683
diff
changeset
|
148 :: |
1105531ae572
docs update, added ldap section, added troubleshooting section
Marcin Kuzminski <marcin@python-works.com>
parents:
683
diff
changeset
|
149 |
733
ac701b421053
fixed docs, for python-ldap import
Marcin Kuzminski <marcin@python-works.com>
parents:
715
diff
changeset
|
150 pip install python-ldap |
707
1105531ae572
docs update, added ldap section, added troubleshooting section
Marcin Kuzminski <marcin@python-works.com>
parents:
683
diff
changeset
|
151 |
770 | 152 .. note:: |
1089
fd4cd3c1d7e9
- First cut at some documentation corrections.
jfh <jason@jasonfharris.com>
parents:
1071
diff
changeset
|
153 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
|
154 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
|
155 |
770 | 156 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
|
157 |
1105531ae572
docs update, added ldap section, added troubleshooting section
Marcin Kuzminski <marcin@python-works.com>
parents:
683
diff
changeset
|
158 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
|
159 |
770 | 160 Enable ldap = checked #controls if ldap access is enabled |
161 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
|
162 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
|
163 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
|
164 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
|
165 Password = <password> #password for ldap server(if required) |
770 | 166 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
|
167 |
1105531ae572
docs update, added ldap section, added troubleshooting section
Marcin Kuzminski <marcin@python-works.com>
parents:
683
diff
changeset
|
168 |
1105531ae572
docs update, added ldap section, added troubleshooting section
Marcin Kuzminski <marcin@python-works.com>
parents:
683
diff
changeset
|
169 `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
|
170 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
|
171 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
|
172 |
1090
de86a0870874
- Further corrections to the setup page.
jfh <jason@jasonfharris.com>
parents:
1089
diff
changeset
|
173 Base DN must have the %(user)s template inside, it's a place holder where your uid |
de86a0870874
- Further corrections to the setup page.
jfh <jason@jasonfharris.com>
parents:
1089
diff
changeset
|
174 used to login would go. It allows admins to specify non-standard schema for the |
de86a0870874
- Further corrections to the setup page.
jfh <jason@jasonfharris.com>
parents:
1089
diff
changeset
|
175 uid variable. |
707
1105531ae572
docs update, added ldap section, added troubleshooting section
Marcin Kuzminski <marcin@python-works.com>
parents:
683
diff
changeset
|
176 |
1090
de86a0870874
- Further corrections to the setup page.
jfh <jason@jasonfharris.com>
parents:
1089
diff
changeset
|
177 If all of the data is correctly entered, and `python-ldap` is properly |
de86a0870874
- Further corrections to the setup page.
jfh <jason@jasonfharris.com>
parents:
1089
diff
changeset
|
178 installed, then users should be granted access to RhodeCode with ldap accounts. |
de86a0870874
- Further corrections to the setup page.
jfh <jason@jasonfharris.com>
parents:
1089
diff
changeset
|
179 When logging in the first time a special ldap account is created inside |
de86a0870874
- Further corrections to the setup page.
jfh <jason@jasonfharris.com>
parents:
1089
diff
changeset
|
180 RhodeCode, so you can control the permissions even on ldap users. If such users |
de86a0870874
- Further corrections to the setup page.
jfh <jason@jasonfharris.com>
parents:
1089
diff
changeset
|
181 already exist in the RhodeCode database, then the ldap user with the same |
de86a0870874
- Further corrections to the setup page.
jfh <jason@jasonfharris.com>
parents:
1089
diff
changeset
|
182 username would be not be able to access RhodeCode. |
707
1105531ae572
docs update, added ldap section, added troubleshooting section
Marcin Kuzminski <marcin@python-works.com>
parents:
683
diff
changeset
|
183 |
1090
de86a0870874
- Further corrections to the setup page.
jfh <jason@jasonfharris.com>
parents:
1089
diff
changeset
|
184 If you have problems with ldap access and believe you have correctly entered the |
de86a0870874
- Further corrections to the setup page.
jfh <jason@jasonfharris.com>
parents:
1089
diff
changeset
|
185 required information then proceed by investigating the RhodeCode logs. Any |
de86a0870874
- Further corrections to the setup page.
jfh <jason@jasonfharris.com>
parents:
1089
diff
changeset
|
186 error messages sent from ldap will be saved there. |
707
1105531ae572
docs update, added ldap section, added troubleshooting section
Marcin Kuzminski <marcin@python-works.com>
parents:
683
diff
changeset
|
187 |
1105531ae572
docs update, added ldap section, added troubleshooting section
Marcin Kuzminski <marcin@python-works.com>
parents:
683
diff
changeset
|
188 |
777
aac24db58ce8
fixed cache problem,
Marcin Kuzminski <marcin@python-works.com>
parents:
775
diff
changeset
|
189 |
aac24db58ce8
fixed cache problem,
Marcin Kuzminski <marcin@python-works.com>
parents:
775
diff
changeset
|
190 Setting Up Celery |
aac24db58ce8
fixed cache problem,
Marcin Kuzminski <marcin@python-works.com>
parents:
775
diff
changeset
|
191 ----------------- |
aac24db58ce8
fixed cache problem,
Marcin Kuzminski <marcin@python-works.com>
parents:
775
diff
changeset
|
192 |
1090
de86a0870874
- Further corrections to the setup page.
jfh <jason@jasonfharris.com>
parents:
1089
diff
changeset
|
193 Since version 1.1 celery is configured by the rhodecode ini configuration files. |
de86a0870874
- Further corrections to the setup page.
jfh <jason@jasonfharris.com>
parents:
1089
diff
changeset
|
194 Simply set use_celery=true in the ini file then add / change the configuration |
777
aac24db58ce8
fixed cache problem,
Marcin Kuzminski <marcin@python-works.com>
parents:
775
diff
changeset
|
195 variables inside the ini file. |
aac24db58ce8
fixed cache problem,
Marcin Kuzminski <marcin@python-works.com>
parents:
775
diff
changeset
|
196 |
1090
de86a0870874
- Further corrections to the setup page.
jfh <jason@jasonfharris.com>
parents:
1089
diff
changeset
|
197 Remember that the ini files use the format with '.' not with '_' like celery. |
de86a0870874
- Further corrections to the setup page.
jfh <jason@jasonfharris.com>
parents:
1089
diff
changeset
|
198 So for example setting `BROKER_HOST` in celery means setting `broker.host` in |
777
aac24db58ce8
fixed cache problem,
Marcin Kuzminski <marcin@python-works.com>
parents:
775
diff
changeset
|
199 the config file. |
aac24db58ce8
fixed cache problem,
Marcin Kuzminski <marcin@python-works.com>
parents:
775
diff
changeset
|
200 |
1090
de86a0870874
- Further corrections to the setup page.
jfh <jason@jasonfharris.com>
parents:
1089
diff
changeset
|
201 In order to start using celery run:: |
939
c165349fdd0e
merged bugfixes for rhodecode 1.1.2 release
Marcin Kuzminski <marcin@python-works.com>
parents:
926
diff
changeset
|
202 |
777
aac24db58ce8
fixed cache problem,
Marcin Kuzminski <marcin@python-works.com>
parents:
775
diff
changeset
|
203 paster celeryd <configfile.ini> |
aac24db58ce8
fixed cache problem,
Marcin Kuzminski <marcin@python-works.com>
parents:
775
diff
changeset
|
204 |
1071
bdc438fb4fe4
Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents:
939
diff
changeset
|
205 |
939
c165349fdd0e
merged bugfixes for rhodecode 1.1.2 release
Marcin Kuzminski <marcin@python-works.com>
parents:
926
diff
changeset
|
206 .. note:: |
1090
de86a0870874
- Further corrections to the setup page.
jfh <jason@jasonfharris.com>
parents:
1089
diff
changeset
|
207 Make sure you run this command from the 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
|
208 that rhodecode runs. |
c165349fdd0e
merged bugfixes for rhodecode 1.1.2 release
Marcin Kuzminski <marcin@python-works.com>
parents:
926
diff
changeset
|
209 |
921
136af52f374b
merged found bugs and fixed for stable release:
Marcin Kuzminski <marcin@python-works.com>
parents:
857
diff
changeset
|
210 HTTPS support |
136af52f374b
merged found bugs and fixed for stable release:
Marcin Kuzminski <marcin@python-works.com>
parents:
857
diff
changeset
|
211 ------------- |
136af52f374b
merged found bugs and fixed for stable release:
Marcin Kuzminski <marcin@python-works.com>
parents:
857
diff
changeset
|
212 |
1090
de86a0870874
- Further corrections to the setup page.
jfh <jason@jasonfharris.com>
parents:
1089
diff
changeset
|
213 There are two ways to enable https: |
de86a0870874
- Further corrections to the setup page.
jfh <jason@jasonfharris.com>
parents:
1089
diff
changeset
|
214 |
de86a0870874
- Further corrections to the setup page.
jfh <jason@jasonfharris.com>
parents:
1089
diff
changeset
|
215 - Set HTTP_X_URL_SCHEME in your http server headers, than rhodecode will |
de86a0870874
- Further corrections to the setup page.
jfh <jason@jasonfharris.com>
parents:
1089
diff
changeset
|
216 recognize this headers and make proper https redirections |
de86a0870874
- Further corrections to the setup page.
jfh <jason@jasonfharris.com>
parents:
1089
diff
changeset
|
217 - Alternatively, set `force_https = true` in the ini configuration to force using |
de86a0870874
- Further corrections to the setup page.
jfh <jason@jasonfharris.com>
parents:
1089
diff
changeset
|
218 https, no headers are needed than to enable https |
921
136af52f374b
merged found bugs and fixed for stable release:
Marcin Kuzminski <marcin@python-works.com>
parents:
857
diff
changeset
|
219 |
136af52f374b
merged found bugs and fixed for stable release:
Marcin Kuzminski <marcin@python-works.com>
parents:
857
diff
changeset
|
220 |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
568
diff
changeset
|
221 Nginx virtual host example |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
568
diff
changeset
|
222 -------------------------- |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
568
diff
changeset
|
223 |
707
1105531ae572
docs update, added ldap section, added troubleshooting section
Marcin Kuzminski <marcin@python-works.com>
parents:
683
diff
changeset
|
224 Sample config for nginx using proxy:: |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
568
diff
changeset
|
225 |
1071
bdc438fb4fe4
Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents:
939
diff
changeset
|
226 server { |
bdc438fb4fe4
Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents:
939
diff
changeset
|
227 listen 80; |
bdc438fb4fe4
Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents:
939
diff
changeset
|
228 server_name hg.myserver.com; |
bdc438fb4fe4
Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents:
939
diff
changeset
|
229 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
|
230 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
|
231 location / { |
bdc438fb4fe4
Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents:
939
diff
changeset
|
232 root /var/www/rhodecode/rhodecode/public/; |
bdc438fb4fe4
Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents:
939
diff
changeset
|
233 if (!-f $request_filename){ |
bdc438fb4fe4
Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents:
939
diff
changeset
|
234 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
|
235 } |
1089
fd4cd3c1d7e9
- First cut at some documentation corrections.
jfh <jason@jasonfharris.com>
parents:
1071
diff
changeset
|
236 #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
|
237 proxy_set_header X-Url-Scheme $scheme; |
bdc438fb4fe4
Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents:
939
diff
changeset
|
238 include /etc/nginx/proxy.conf; |
bdc438fb4fe4
Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents:
939
diff
changeset
|
239 } |
bdc438fb4fe4
Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents:
939
diff
changeset
|
240 } |
568
5f481e4e888b
updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents:
diff
changeset
|
241 |
1090
de86a0870874
- Further corrections to the setup page.
jfh <jason@jasonfharris.com>
parents:
1089
diff
changeset
|
242 Here's the proxy.conf. It's tuned so it will not timeout on long |
de86a0870874
- Further corrections to the setup page.
jfh <jason@jasonfharris.com>
parents:
1089
diff
changeset
|
243 pushes or large pushes:: |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
568
diff
changeset
|
244 |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
568
diff
changeset
|
245 proxy_redirect off; |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
568
diff
changeset
|
246 proxy_set_header Host $host; |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
568
diff
changeset
|
247 proxy_set_header X-Host $http_host; |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
568
diff
changeset
|
248 proxy_set_header X-Real-IP $remote_addr; |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
568
diff
changeset
|
249 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
|
250 proxy_set_header Proxy-host $proxy_host; |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
568
diff
changeset
|
251 client_max_body_size 400m; |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
568
diff
changeset
|
252 client_body_buffer_size 128k; |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
568
diff
changeset
|
253 proxy_buffering off; |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
568
diff
changeset
|
254 proxy_connect_timeout 3600; |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
568
diff
changeset
|
255 proxy_send_timeout 3600; |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
568
diff
changeset
|
256 proxy_read_timeout 3600; |
1071
bdc438fb4fe4
Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents:
939
diff
changeset
|
257 proxy_buffer_size 16k; |
bdc438fb4fe4
Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents:
939
diff
changeset
|
258 proxy_buffers 4 16k; |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
568
diff
changeset
|
259 proxy_busy_buffers_size 64k; |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
568
diff
changeset
|
260 proxy_temp_file_write_size 64k; |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
568
diff
changeset
|
261 |
1090
de86a0870874
- Further corrections to the setup page.
jfh <jason@jasonfharris.com>
parents:
1089
diff
changeset
|
262 Also, when using root path with nginx you might set the static files to false |
de86a0870874
- Further corrections to the setup page.
jfh <jason@jasonfharris.com>
parents:
1089
diff
changeset
|
263 in the production.ini file:: |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
568
diff
changeset
|
264 |
1071
bdc438fb4fe4
Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents:
939
diff
changeset
|
265 [app:main] |
bdc438fb4fe4
Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents:
939
diff
changeset
|
266 use = egg:rhodecode |
bdc438fb4fe4
Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents:
939
diff
changeset
|
267 full_stack = true |
bdc438fb4fe4
Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents:
939
diff
changeset
|
268 static_files = false |
bdc438fb4fe4
Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents:
939
diff
changeset
|
269 lang=en |
bdc438fb4fe4
Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents:
939
diff
changeset
|
270 cache_dir = %(here)s/data |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
568
diff
changeset
|
271 |
1090
de86a0870874
- Further corrections to the setup page.
jfh <jason@jasonfharris.com>
parents:
1089
diff
changeset
|
272 In order to not have the statics served by the application. This improves speed. |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
568
diff
changeset
|
273 |
921
136af52f374b
merged found bugs and fixed for stable release:
Marcin Kuzminski <marcin@python-works.com>
parents:
857
diff
changeset
|
274 |
136af52f374b
merged found bugs and fixed for stable release:
Marcin Kuzminski <marcin@python-works.com>
parents:
857
diff
changeset
|
275 Apache virtual host example |
136af52f374b
merged found bugs and fixed for stable release:
Marcin Kuzminski <marcin@python-works.com>
parents:
857
diff
changeset
|
276 --------------------------- |
136af52f374b
merged found bugs and fixed for stable release:
Marcin Kuzminski <marcin@python-works.com>
parents:
857
diff
changeset
|
277 |
1090
de86a0870874
- Further corrections to the setup page.
jfh <jason@jasonfharris.com>
parents:
1089
diff
changeset
|
278 Here is a sample configuration file for apache using proxy:: |
921
136af52f374b
merged found bugs and fixed for stable release:
Marcin Kuzminski <marcin@python-works.com>
parents:
857
diff
changeset
|
279 |
926 | 280 <VirtualHost *:80> |
281 ServerName hg.myserver.com | |
282 ServerAlias hg.myserver.com | |
283 | |
284 <Proxy *> | |
285 Order allow,deny | |
286 Allow from all | |
287 </Proxy> | |
288 | |
289 #important ! | |
290 #Directive to properly generate url (clone url) for pylons | |
291 ProxyPreserveHost On | |
292 | |
293 #rhodecode instance | |
294 ProxyPass / http://127.0.0.1:5000/ | |
295 ProxyPassReverse / http://127.0.0.1:5000/ | |
296 | |
297 #to enable https use line below | |
298 #SetEnvIf X-Url-Scheme https HTTPS=1 | |
299 | |
300 </VirtualHost> | |
921
136af52f374b
merged found bugs and fixed for stable release:
Marcin Kuzminski <marcin@python-works.com>
parents:
857
diff
changeset
|
301 |
136af52f374b
merged found bugs and fixed for stable release:
Marcin Kuzminski <marcin@python-works.com>
parents:
857
diff
changeset
|
302 |
136af52f374b
merged found bugs and fixed for stable release:
Marcin Kuzminski <marcin@python-works.com>
parents:
857
diff
changeset
|
303 Additional tutorial |
744 | 304 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
|
305 |
707
1105531ae572
docs update, added ldap section, added troubleshooting section
Marcin Kuzminski <marcin@python-works.com>
parents:
683
diff
changeset
|
306 |
1071
bdc438fb4fe4
Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents:
939
diff
changeset
|
307 Apache as subdirectory |
bdc438fb4fe4
Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents:
939
diff
changeset
|
308 ---------------------- |
bdc438fb4fe4
Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents:
939
diff
changeset
|
309 |
bdc438fb4fe4
Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents:
939
diff
changeset
|
310 |
bdc438fb4fe4
Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents:
939
diff
changeset
|
311 Apache subdirectory part:: |
bdc438fb4fe4
Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents:
939
diff
changeset
|
312 |
bdc438fb4fe4
Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents:
939
diff
changeset
|
313 <Location /rhodecode> |
bdc438fb4fe4
Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents:
939
diff
changeset
|
314 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
|
315 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
|
316 SetEnvIf X-Url-Scheme https HTTPS=1 |
bdc438fb4fe4
Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents:
939
diff
changeset
|
317 </Location> |
bdc438fb4fe4
Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents:
939
diff
changeset
|
318 |
1090
de86a0870874
- Further corrections to the setup page.
jfh <jason@jasonfharris.com>
parents:
1089
diff
changeset
|
319 Besides the regular apache setup you will need to add the following to your .ini file:: |
1071
bdc438fb4fe4
Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents:
939
diff
changeset
|
320 |
bdc438fb4fe4
Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents:
939
diff
changeset
|
321 filter-with = proxy-prefix |
bdc438fb4fe4
Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents:
939
diff
changeset
|
322 |
bdc438fb4fe4
Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents:
939
diff
changeset
|
323 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
|
324 |
bdc438fb4fe4
Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents:
939
diff
changeset
|
325 [filter:proxy-prefix] |
bdc438fb4fe4
Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents:
939
diff
changeset
|
326 use = egg:PasteDeploy#prefix |
bdc438fb4fe4
Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents:
939
diff
changeset
|
327 prefix = /<someprefix> |
bdc438fb4fe4
Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents:
939
diff
changeset
|
328 |
bdc438fb4fe4
Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents:
939
diff
changeset
|
329 |
707
1105531ae572
docs update, added ldap section, added troubleshooting section
Marcin Kuzminski <marcin@python-works.com>
parents:
683
diff
changeset
|
330 Apache's example FCGI config |
1105531ae572
docs update, added ldap section, added troubleshooting section
Marcin Kuzminski <marcin@python-works.com>
parents:
683
diff
changeset
|
331 ---------------------------- |
1105531ae572
docs update, added ldap section, added troubleshooting section
Marcin Kuzminski <marcin@python-works.com>
parents:
683
diff
changeset
|
332 |
1105531ae572
docs update, added ldap section, added troubleshooting section
Marcin Kuzminski <marcin@python-works.com>
parents:
683
diff
changeset
|
333 TODO ! |
1105531ae572
docs update, added ldap section, added troubleshooting section
Marcin Kuzminski <marcin@python-works.com>
parents:
683
diff
changeset
|
334 |
591 | 335 Other configuration files |
336 ------------------------- | |
337 | |
1090
de86a0870874
- Further corrections to the setup page.
jfh <jason@jasonfharris.com>
parents:
1089
diff
changeset
|
338 Some example init.d scripts can be found here, for debian and gentoo: |
591 | 339 |
939
c165349fdd0e
merged bugfixes for rhodecode 1.1.2 release
Marcin Kuzminski <marcin@python-works.com>
parents:
926
diff
changeset
|
340 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
|
341 |
591 | 342 |
707
1105531ae572
docs update, added ldap section, added troubleshooting section
Marcin Kuzminski <marcin@python-works.com>
parents:
683
diff
changeset
|
343 Troubleshooting |
1105531ae572
docs update, added ldap section, added troubleshooting section
Marcin Kuzminski <marcin@python-works.com>
parents:
683
diff
changeset
|
344 --------------- |
1105531ae572
docs update, added ldap section, added troubleshooting section
Marcin Kuzminski <marcin@python-works.com>
parents:
683
diff
changeset
|
345 |
1090
de86a0870874
- Further corrections to the setup page.
jfh <jason@jasonfharris.com>
parents:
1089
diff
changeset
|
346 :Q: **Missing static files?** |
de86a0870874
- Further corrections to the setup page.
jfh <jason@jasonfharris.com>
parents:
1089
diff
changeset
|
347 :A: 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
|
348 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
|
349 for example: |
1105531ae572
docs update, added ldap section, added troubleshooting section
Marcin Kuzminski <marcin@python-works.com>
parents:
683
diff
changeset
|
350 /home/my-virtual-python/lib/python2.6/site-packages/rhodecode/public |
1090
de86a0870874
- Further corrections to the setup page.
jfh <jason@jasonfharris.com>
parents:
1089
diff
changeset
|
351 |
de86a0870874
- Further corrections to the setup page.
jfh <jason@jasonfharris.com>
parents:
1089
diff
changeset
|
352 | |
de86a0870874
- Further corrections to the setup page.
jfh <jason@jasonfharris.com>
parents:
1089
diff
changeset
|
353 :Q: **Can't install celery/rabbitmq** |
de86a0870874
- Further corrections to the setup page.
jfh <jason@jasonfharris.com>
parents:
1089
diff
changeset
|
354 :A: Don't worry RhodeCode works without them too. No extra setup is required. |
707
1105531ae572
docs update, added ldap section, added troubleshooting section
Marcin Kuzminski <marcin@python-works.com>
parents:
683
diff
changeset
|
355 |
1090
de86a0870874
- Further corrections to the setup page.
jfh <jason@jasonfharris.com>
parents:
1089
diff
changeset
|
356 | |
de86a0870874
- Further corrections to the setup page.
jfh <jason@jasonfharris.com>
parents:
1089
diff
changeset
|
357 :Q: **Long lasting push timeouts?** |
de86a0870874
- Further corrections to the setup page.
jfh <jason@jasonfharris.com>
parents:
1089
diff
changeset
|
358 :A: Make sure you set a longer timeouts in your proxy/fcgi settings, timeouts |
de86a0870874
- Further corrections to the setup page.
jfh <jason@jasonfharris.com>
parents:
1089
diff
changeset
|
359 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
|
360 |
1090
de86a0870874
- Further corrections to the setup page.
jfh <jason@jasonfharris.com>
parents:
1089
diff
changeset
|
361 | |
de86a0870874
- Further corrections to the setup page.
jfh <jason@jasonfharris.com>
parents:
1089
diff
changeset
|
362 :Q: **Large pushes timeouts?** |
de86a0870874
- Further corrections to the setup page.
jfh <jason@jasonfharris.com>
parents:
1089
diff
changeset
|
363 :A: 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
|
364 |
1090
de86a0870874
- Further corrections to the setup page.
jfh <jason@jasonfharris.com>
parents:
1089
diff
changeset
|
365 | |
de86a0870874
- Further corrections to the setup page.
jfh <jason@jasonfharris.com>
parents:
1089
diff
changeset
|
366 :Q: **Apache doesn't pass basicAuth on pull/push?** |
de86a0870874
- Further corrections to the setup page.
jfh <jason@jasonfharris.com>
parents:
1089
diff
changeset
|
367 :A: Make sure you added `WSGIPassAuthorization true`. |
707
1105531ae572
docs update, added ldap section, added troubleshooting section
Marcin Kuzminski <marcin@python-works.com>
parents:
683
diff
changeset
|
368 |
1090
de86a0870874
- Further corrections to the setup page.
jfh <jason@jasonfharris.com>
parents:
1089
diff
changeset
|
369 For further questions search the `Issues tracker`_, or post a message in the `google group rhodecode`_ |
591 | 370 |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
568
diff
changeset
|
371 .. _virtualenv: http://pypi.python.org/pypi/virtualenv |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
568
diff
changeset
|
372 .. _python: http://www.python.org/ |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
568
diff
changeset
|
373 .. _mercurial: http://mercurial.selenic.com/ |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
568
diff
changeset
|
374 .. _celery: http://celeryproject.org/ |
1071
bdc438fb4fe4
Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents:
939
diff
changeset
|
375 .. _rabbitmq: http://www.rabbitmq.com/ |
bdc438fb4fe4
Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents:
939
diff
changeset
|
376 .. _python-ldap: http://www.python-ldap.org/ |
1090
de86a0870874
- Further corrections to the setup page.
jfh <jason@jasonfharris.com>
parents:
1089
diff
changeset
|
377 .. _mercurial-server: http://www.lshift.net/mercurial-server.html |
de86a0870874
- Further corrections to the setup page.
jfh <jason@jasonfharris.com>
parents:
1089
diff
changeset
|
378 .. _PublishingRepositories: http://mercurial.selenic.com/wiki/PublishingRepositories |
de86a0870874
- Further corrections to the setup page.
jfh <jason@jasonfharris.com>
parents:
1089
diff
changeset
|
379 .. _Issues tracker: https://bitbucket.org/marcinkuzminski/rhodecode/issues |
de86a0870874
- Further corrections to the setup page.
jfh <jason@jasonfharris.com>
parents:
1089
diff
changeset
|
380 .. _google group rhodecode: http://groups.google.com/group/rhodecode |