kallithea: docs/setup.rst annotate

annotate docs/setup.rst @ 5425:5ae8e644aa88

docs: spelling, grammar, content and typography

author	Søren Løvborg <sorenl@unity3d.com>
date	Tue, 18 Aug 2015 11:47:19 +0200
parents	22a3fa3c4254
children	66f1b9745905

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
2095 17c9393e9645 docs Marcin Kuzminski <marcin@python-works.com> parents: 2076 diff changeset	3 =====
568 5f481e4e888b updated docs, added sphinx build Marcin Kuzminski <marcin@python-works.com> parents: diff changeset	4 Setup
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
5f481e4e888b updated docs, added sphinx build Marcin Kuzminski <marcin@python-works.com> parents: diff changeset	7
4192 e73a69cb98dc Rename some strings examples and commands in documentation Bradley M. Kuhn <bkuhn@sfconservancy.org> parents: 4186 diff changeset	8 Setting up Kallithea
1448 b05eb16ea105 fixes #206 Marcin Kuzminski <marcin@python-works.com> parents: 1420 diff changeset	9 --------------------
572 a60cd29ba7e2 more docs update Marcin Kuzminski <marcin@python-works.com> parents: 568 diff changeset	10
4192 e73a69cb98dc Rename some strings examples and commands in documentation Bradley M. Kuhn <bkuhn@sfconservancy.org> parents: 4186 diff changeset	11 First, you will need to create a Kallithea configuration file. Run the
4955 4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4925 diff changeset	12 following command to do so::
3224 8b8edfc25856 whitespace cleanup Marcin Kuzminski <marcin@python-works.com> parents: 2916 diff changeset	13
4902 03bbd33bc084 docs: rework stuff Mads Kiilerich <madski@unity3d.com> parents: 4848 diff changeset	14 paster make-config Kallithea my.ini
572 a60cd29ba7e2 more docs update Marcin Kuzminski <marcin@python-works.com> parents: 568 diff changeset	15
4955 4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4925 diff changeset	16 This will create the file ``my.ini`` in the current directory. This
5425 5ae8e644aa88 docs: spelling, grammar, content and typography Søren Løvborg <sorenl@unity3d.com> parents: 5413 diff changeset	17 configuration file contains the various settings for Kallithea, e.g.
4955 4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4925 diff changeset	18 proxy port, email settings, usage of static files, cache, Celery
4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4925 diff changeset	19 settings, and logging.
845 a040597b070b docs update Marcin Kuzminski <marcin@python-works.com> parents: 777 diff changeset	20
a040597b070b docs update Marcin Kuzminski <marcin@python-works.com> parents: 777 diff changeset	21
4902 03bbd33bc084 docs: rework stuff Mads Kiilerich <madski@unity3d.com> parents: 4848 diff changeset	22 Next, you need to create the databases used by Kallithea. It is recommended to
4914 95fe05b1e5f8 docs: better capitalisation Andrew Shadura <andrew@shadura.me> parents: 4902 diff changeset	23 use PostgreSQL or SQLite (default). If you choose a database other than the
4955 4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4925 diff changeset	24 default, ensure you properly adjust the database URL in your ``my.ini``
4192 e73a69cb98dc Rename some strings examples and commands in documentation Bradley M. Kuhn <bkuhn@sfconservancy.org> parents: 4186 diff changeset	25 configuration file to use this other database. Kallithea currently supports
4914 95fe05b1e5f8 docs: better capitalisation Andrew Shadura <andrew@shadura.me> parents: 4902 diff changeset	26 PostgreSQL, SQLite and MySQL databases. Create the database by running
1092 8af52e1224ff merge docs in beta with those corrected by Jason Harris Marcin Kuzminski <marcin@python-works.com> parents: 1062 diff changeset	27 the following command::
572 a60cd29ba7e2 more docs update Marcin Kuzminski <marcin@python-works.com> parents: 568 diff changeset	28
4902 03bbd33bc084 docs: rework stuff Mads Kiilerich <madski@unity3d.com> parents: 4848 diff changeset	29 paster setup-db my.ini
572 a60cd29ba7e2 more docs update Marcin Kuzminski <marcin@python-works.com> parents: 568 diff changeset	30
1092 8af52e1224ff merge docs in beta with those corrected by Jason Harris Marcin Kuzminski <marcin@python-works.com> parents: 1062 diff changeset	31 This will prompt you for a "root" path. This "root" path is the location where
4192 e73a69cb98dc Rename some strings examples and commands in documentation Bradley M. Kuhn <bkuhn@sfconservancy.org> parents: 4186 diff changeset	32 Kallithea will store all of its repositories on the current machine. After
4185 aaa7c3331186 Rename paster command setup-rhodecode to setup-db Bradley M. Kuhn <bkuhn@sfconservancy.org> parents: 4182 diff changeset	33 entering this "root" path ``setup-db`` will also prompt you for a username
aaa7c3331186 Rename paster command setup-rhodecode to setup-db Bradley M. Kuhn <bkuhn@sfconservancy.org> parents: 4182 diff changeset	34 and password for the initial admin account which ``setup-db`` sets
2284 e285aa097a81 new setup-rhodecode command with optional defaults Marcin Kuzminski <marcin@python-works.com> parents: 2105 diff changeset	35 up for you.
845 a040597b070b docs update Marcin Kuzminski <marcin@python-works.com> parents: 777 diff changeset	36
5425 5ae8e644aa88 docs: spelling, grammar, content and typography Søren Løvborg <sorenl@unity3d.com> parents: 5413 diff changeset	37 The ``setup-db`` values can also be given on the command line.
5ae8e644aa88 docs: spelling, grammar, content and typography Søren Løvborg <sorenl@unity3d.com> parents: 5413 diff changeset	38 Example::
2358 69df04ee1e2b added detailed step-by-step installation instruction for windows Marcin Kuzminski <marcin@python-works.com> parents: 2284 diff changeset	39
5425 5ae8e644aa88 docs: spelling, grammar, content and typography Søren Løvborg <sorenl@unity3d.com> parents: 5413 diff changeset	40 paster setup-db my.ini --user=nn --password=secret --email=nn@example.org --repos=/srv/repos
3224 8b8edfc25856 whitespace cleanup Marcin Kuzminski <marcin@python-works.com> parents: 2916 diff changeset	41
2358 69df04ee1e2b added detailed step-by-step installation instruction for windows Marcin Kuzminski <marcin@python-works.com> parents: 2284 diff changeset	42
5425 5ae8e644aa88 docs: spelling, grammar, content and typography Søren Løvborg <sorenl@unity3d.com> parents: 5413 diff changeset	43 The ``setup-db`` command will create all needed tables and an
4955 4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4925 diff changeset	44 admin account. When choosing a root path you can either use a new
4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4925 diff changeset	45 empty location, or a location which already contains existing
4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4925 diff changeset	46 repositories. If you choose a location which contains existing
4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4925 diff changeset	47 repositories Kallithea will add all of the repositories at the chosen
4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4925 diff changeset	48 location to its database. (Note: make sure you specify the correct
4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4925 diff changeset	49 path to the root).
572 a60cd29ba7e2 more docs update Marcin Kuzminski <marcin@python-works.com> parents: 568 diff changeset	50
4955 4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4925 diff changeset	51 .. note:: the given path for Mercurial_ repositories must be write
4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4925 diff changeset	52 accessible for the application. It's very important since
4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4925 diff changeset	53 the Kallithea web interface will work without write access,
4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4925 diff changeset	54 but when trying to do a push it will fail with permission
4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4925 diff changeset	55 denied errors unless it has write access.
4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4925 diff changeset	56
4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4925 diff changeset	57 You are now ready to use Kallithea. To run it simply execute::
3224 8b8edfc25856 whitespace cleanup Marcin Kuzminski <marcin@python-works.com> parents: 2916 diff changeset	58
4902 03bbd33bc084 docs: rework stuff Mads Kiilerich <madski@unity3d.com> parents: 4848 diff changeset	59 paster serve my.ini
3224 8b8edfc25856 whitespace cleanup Marcin Kuzminski <marcin@python-works.com> parents: 2916 diff changeset	60
4955 4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4925 diff changeset	61 - This command runs the Kallithea server. The web app should be available at
5425 5ae8e644aa88 docs: spelling, grammar, content and typography Søren Løvborg <sorenl@unity3d.com> parents: 5413 diff changeset	62 http://127.0.0.1:5000. The IP address and port is configurable via the
5ae8e644aa88 docs: spelling, grammar, content and typography Søren Løvborg <sorenl@unity3d.com> parents: 5413 diff changeset	63 configuration file created in the previous step.
5ae8e644aa88 docs: spelling, grammar, content and typography Søren Løvborg <sorenl@unity3d.com> parents: 5413 diff changeset	64 - Log in to Kallithea using the admin account created when running ``setup-db``.
3224 8b8edfc25856 whitespace cleanup Marcin Kuzminski <marcin@python-works.com> parents: 2916 diff changeset	65 - The default permissions on each repository is read, and the owner is admin.
1092 8af52e1224ff merge docs in beta with those corrected by Jason Harris Marcin Kuzminski <marcin@python-works.com> parents: 1062 diff changeset	66 Remember to update these if needed.
4955 4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4925 diff changeset	67 - In the admin panel you can toggle LDAP, anonymous, and permissions
4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4925 diff changeset	68 settings, as well as edit more advanced options on users and
5425 5ae8e644aa88 docs: spelling, grammar, content and typography Søren Løvborg <sorenl@unity3d.com> parents: 5413 diff changeset	69 repositories.
1092 8af52e1224ff merge docs in beta with those corrected by Jason Harris Marcin Kuzminski <marcin@python-works.com> parents: 1062 diff changeset	70
5077 faf943716616 rcextensions: cleanup of code and documentation Mads Kiilerich <madski@unity3d.com> parents: 4955 diff changeset	71
faf943716616 rcextensions: cleanup of code and documentation Mads Kiilerich <madski@unity3d.com> parents: 4955 diff changeset	72 Extensions
faf943716616 rcextensions: cleanup of code and documentation Mads Kiilerich <madski@unity3d.com> parents: 4955 diff changeset	73 ----------
faf943716616 rcextensions: cleanup of code and documentation Mads Kiilerich <madski@unity3d.com> parents: 4955 diff changeset	74
5425 5ae8e644aa88 docs: spelling, grammar, content and typography Søren Løvborg <sorenl@unity3d.com> parents: 5413 diff changeset	75 Optionally one can create an ``rcextensions`` package that extends Kallithea
5ae8e644aa88 docs: spelling, grammar, content and typography Søren Løvborg <sorenl@unity3d.com> parents: 5413 diff changeset	76 functionality.
5ae8e644aa88 docs: spelling, grammar, content and typography Søren Løvborg <sorenl@unity3d.com> parents: 5413 diff changeset	77 To generate a skeleton extensions package, run::
2105 926f55b038bc added initial rc-extension module Marcin Kuzminski <marcin@python-works.com> parents: 2095 diff changeset	78
4902 03bbd33bc084 docs: rework stuff Mads Kiilerich <madski@unity3d.com> parents: 4848 diff changeset	79 paster make-rcext my.ini
1092 8af52e1224ff merge docs in beta with those corrected by Jason Harris Marcin Kuzminski <marcin@python-works.com> parents: 1062 diff changeset	80
5077 faf943716616 rcextensions: cleanup of code and documentation Mads Kiilerich <madski@unity3d.com> parents: 4955 diff changeset	81 This will create an ``rcextensions`` package next to the specified ``ini`` file.
faf943716616 rcextensions: cleanup of code and documentation Mads Kiilerich <madski@unity3d.com> parents: 4955 diff changeset	82 With ``rcextensions`` it's possible to add additional mapping for whoosh,
4955 4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4925 diff changeset	83 stats and add additional code into the push/pull/create/delete repo hooks,
5077 faf943716616 rcextensions: cleanup of code and documentation Mads Kiilerich <madski@unity3d.com> parents: 4955 diff changeset	84 for example for sending signals to build-bots such as Jenkins.
faf943716616 rcextensions: cleanup of code and documentation Mads Kiilerich <madski@unity3d.com> parents: 4955 diff changeset	85
faf943716616 rcextensions: cleanup of code and documentation Mads Kiilerich <madski@unity3d.com> parents: 4955 diff changeset	86 See the ``__init__.py`` file inside the generated ``rcextensions`` package
2105 926f55b038bc added initial rc-extension module Marcin Kuzminski <marcin@python-works.com> parents: 2095 diff changeset	87 for more details.
1092 8af52e1224ff merge docs in beta with those corrected by Jason Harris Marcin Kuzminski <marcin@python-works.com> parents: 1062 diff changeset	88
8af52e1224ff merge docs in beta with those corrected by Jason Harris Marcin Kuzminski <marcin@python-works.com> parents: 1062 diff changeset	89
4192 e73a69cb98dc Rename some strings examples and commands in documentation Bradley M. Kuhn <bkuhn@sfconservancy.org> parents: 4186 diff changeset	90 Using Kallithea with SSH
912 8378122aa408 docs: changelog + setup update Marcin Kuzminski <marcin@python-works.com> parents: 894 diff changeset	91 ------------------------
8378122aa408 docs: changelog + setup update Marcin Kuzminski <marcin@python-works.com> parents: 894 diff changeset	92
4192 e73a69cb98dc Rename some strings examples and commands in documentation Bradley M. Kuhn <bkuhn@sfconservancy.org> parents: 4186 diff changeset	93 Kallithea currently only hosts repositories using http and https. (The addition
1309 61a6a7bf2cbd small docs updates Marcin Kuzminski <marcin@python-works.com> parents: 1292 diff changeset	94 of ssh hosting is a planned future feature.) However you can easily use ssh in
4192 e73a69cb98dc Rename some strings examples and commands in documentation Bradley M. Kuhn <bkuhn@sfconservancy.org> parents: 4186 diff changeset	95 parallel with Kallithea. (Repository access via ssh is a standard "out of
4914 95fe05b1e5f8 docs: better capitalisation Andrew Shadura <andrew@shadura.me> parents: 4902 diff changeset	96 the box" feature of Mercurial_ and you can use this to access any of the
4192 e73a69cb98dc Rename some strings examples and commands in documentation Bradley M. Kuhn <bkuhn@sfconservancy.org> parents: 4186 diff changeset	97 repositories that Kallithea is hosting. See PublishingRepositories_)
1092 8af52e1224ff merge docs in beta with those corrected by Jason Harris Marcin Kuzminski <marcin@python-works.com> parents: 1062 diff changeset	98
4192 e73a69cb98dc Rename some strings examples and commands in documentation Bradley M. Kuhn <bkuhn@sfconservancy.org> parents: 4186 diff changeset	99 Kallithea repository structures are kept in directories with the same name
1092 8af52e1224ff merge docs in beta with those corrected by Jason Harris Marcin Kuzminski <marcin@python-works.com> parents: 1062 diff changeset	100 as the project. When using repository groups, each group is a subdirectory.
8af52e1224ff merge docs in beta with those corrected by Jason Harris Marcin Kuzminski <marcin@python-works.com> parents: 1062 diff changeset	101 This allows you to easily use ssh for accessing repositories.
912 8378122aa408 docs: changelog + setup update Marcin Kuzminski <marcin@python-works.com> parents: 894 diff changeset	102
4955 4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4925 diff changeset	103 In order to use ssh you need to make sure that your web server and the users'
1309 61a6a7bf2cbd small docs updates Marcin Kuzminski <marcin@python-works.com> parents: 1292 diff changeset	104 login accounts have the correct permissions set on the appropriate directories.
4955 4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4925 diff changeset	105
4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4925 diff changeset	106 .. note:: These permissions are independent of any permissions you
4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4925 diff changeset	107 have set up using the Kallithea web interface.
912 8378122aa408 docs: changelog + setup update Marcin Kuzminski <marcin@python-works.com> parents: 894 diff changeset	108
4955 4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4925 diff changeset	109 If your main directory (the same as set in Kallithea settings) is for
4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4925 diff changeset	110 example set to ``/srv/repos`` and the repository you are using is
4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4925 diff changeset	111 named ``kallithea``, then to clone via ssh you should run::
912 8378122aa408 docs: changelog + setup update Marcin Kuzminski <marcin@python-works.com> parents: 894 diff changeset	112
4902 03bbd33bc084 docs: rework stuff Mads Kiilerich <madski@unity3d.com> parents: 4848 diff changeset	113 hg clone ssh://user@server.com//srv/repos/kallithea
1092 8af52e1224ff merge docs in beta with those corrected by Jason Harris Marcin Kuzminski <marcin@python-works.com> parents: 1062 diff changeset	114
4955 4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4925 diff changeset	115 Using other external tools such as mercurial-server_ or using ssh key-based
1092 8af52e1224ff merge docs in beta with those corrected by Jason Harris Marcin Kuzminski <marcin@python-works.com> parents: 1062 diff changeset	116 authentication is fully supported.
912 8378122aa408 docs: changelog + setup update Marcin Kuzminski <marcin@python-works.com> parents: 894 diff changeset	117
4955 4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4925 diff changeset	118 .. note:: In an advanced setup, in order for your ssh access to use
4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4925 diff changeset	119 the same permissions as set up via the Kallithea web
4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4925 diff changeset	120 interface, you can create an authentication hook to connect
4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4925 diff changeset	121 to the Kallithea db and run check functions for permissions
4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4925 diff changeset	122 against that.
3224 8b8edfc25856 whitespace cleanup Marcin Kuzminski <marcin@python-works.com> parents: 2916 diff changeset	123
683 341beaa9edba Implemented whoosh index building as paster command. Marcin Kuzminski <marcin@python-works.com> parents: 597 diff changeset	124 Setting up Whoosh full text search
341beaa9edba Implemented whoosh index building as paster command. Marcin Kuzminski <marcin@python-works.com> parents: 597 diff changeset	125 ----------------------------------
341beaa9edba Implemented whoosh index building as paster command. Marcin Kuzminski <marcin@python-works.com> parents: 597 diff changeset	126
5425 5ae8e644aa88 docs: spelling, grammar, content and typography Søren Løvborg <sorenl@unity3d.com> parents: 5413 diff changeset	127 Kallithea provides full text search of repositories using `Whoosh`__.
894 1fed3c9161bb fixes #90 + docs update Marcin Kuzminski <marcin@python-works.com> parents: 881 diff changeset	128
5425 5ae8e644aa88 docs: spelling, grammar, content and typography Søren Løvborg <sorenl@unity3d.com> parents: 5413 diff changeset	129 .. __: https://pythonhosted.org/Whoosh/
683 341beaa9edba Implemented whoosh index building as paster command. Marcin Kuzminski <marcin@python-works.com> parents: 597 diff changeset	130
5425 5ae8e644aa88 docs: spelling, grammar, content and typography Søren Løvborg <sorenl@unity3d.com> parents: 5413 diff changeset	131 For an incremental index build, run::
707 1105531ae572 docs update, added ldap section, added troubleshooting section Marcin Kuzminski <marcin@python-works.com> parents: 683 diff changeset	132
4902 03bbd33bc084 docs: rework stuff Mads Kiilerich <madski@unity3d.com> parents: 4848 diff changeset	133 paster make-index my.ini
683 341beaa9edba Implemented whoosh index building as paster command. Marcin Kuzminski <marcin@python-works.com> parents: 597 diff changeset	134
5425 5ae8e644aa88 docs: spelling, grammar, content and typography Søren Løvborg <sorenl@unity3d.com> parents: 5413 diff changeset	135 For a full index rebuild, run::
707 1105531ae572 docs update, added ldap section, added troubleshooting section Marcin Kuzminski <marcin@python-works.com> parents: 683 diff changeset	136
4902 03bbd33bc084 docs: rework stuff Mads Kiilerich <madski@unity3d.com> parents: 4848 diff changeset	137 paster make-index my.ini -f
572 a60cd29ba7e2 more docs update Marcin Kuzminski <marcin@python-works.com> parents: 568 diff changeset	138
5425 5ae8e644aa88 docs: spelling, grammar, content and typography Søren Løvborg <sorenl@unity3d.com> parents: 5413 diff changeset	139 The ``--repo-location`` option allows the location of the repositories to be overriden;
5ae8e644aa88 docs: spelling, grammar, content and typography Søren Løvborg <sorenl@unity3d.com> parents: 5413 diff changeset	140 usually, the location is retrieved from the Kallithea database.
894 1fed3c9161bb fixes #90 + docs update Marcin Kuzminski <marcin@python-works.com> parents: 881 diff changeset	141
5425 5ae8e644aa88 docs: spelling, grammar, content and typography Søren Løvborg <sorenl@unity3d.com> parents: 5413 diff changeset	142 The ``--index-only`` option can be used to limit the indexed repositories to a comma-separated list::
3224 8b8edfc25856 whitespace cleanup Marcin Kuzminski <marcin@python-works.com> parents: 2916 diff changeset	143
4902 03bbd33bc084 docs: rework stuff Mads Kiilerich <madski@unity3d.com> parents: 4848 diff changeset	144 paster make-index my.ini --index-only=vcs,kallithea
572 a60cd29ba7e2 more docs update Marcin Kuzminski <marcin@python-works.com> parents: 568 diff changeset	145
894 1fed3c9161bb fixes #90 + docs update Marcin Kuzminski <marcin@python-works.com> parents: 881 diff changeset	146
5425 5ae8e644aa88 docs: spelling, grammar, content and typography Søren Løvborg <sorenl@unity3d.com> parents: 5413 diff changeset	147 To keep your index up-to-date it is necessary to do periodic index builds;
5ae8e644aa88 docs: spelling, grammar, content and typography Søren Løvborg <sorenl@unity3d.com> parents: 5413 diff changeset	148 for this, it is recommended to use a crontab entry. Example::
3224 8b8edfc25856 whitespace cleanup Marcin Kuzminski <marcin@python-works.com> parents: 2916 diff changeset	149
5425 5ae8e644aa88 docs: spelling, grammar, content and typography Søren Løvborg <sorenl@unity3d.com> parents: 5413 diff changeset	150 0 3 * * * /path/to/virtualenv/bin/paster make-index /path/to/kallithea/my.ini
3224 8b8edfc25856 whitespace cleanup Marcin Kuzminski <marcin@python-works.com> parents: 2916 diff changeset	151
5425 5ae8e644aa88 docs: spelling, grammar, content and typography Søren Løvborg <sorenl@unity3d.com> parents: 5413 diff changeset	152 When using incremental mode (the default), Whoosh will check the last
1092 8af52e1224ff merge docs in beta with those corrected by Jason Harris Marcin Kuzminski <marcin@python-works.com> parents: 1062 diff changeset	153 modification date of each file and add it to be reindexed if a newer file is
8af52e1224ff merge docs in beta with those corrected by Jason Harris Marcin Kuzminski <marcin@python-works.com> parents: 1062 diff changeset	154 available. The indexing daemon checks for any removed files and removes them
8af52e1224ff merge docs in beta with those corrected by Jason Harris Marcin Kuzminski <marcin@python-works.com> parents: 1062 diff changeset	155 from index.
683 341beaa9edba Implemented whoosh index building as paster command. Marcin Kuzminski <marcin@python-works.com> parents: 597 diff changeset	156
4955 4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4925 diff changeset	157 If you want to rebuild the index from scratch, you can use the ``-f`` flag as above,
5425 5ae8e644aa88 docs: spelling, grammar, content and typography Søren Løvborg <sorenl@unity3d.com> parents: 5413 diff changeset	158 or in the admin panel you can check the "build from scratch" checkbox.
572 a60cd29ba7e2 more docs update Marcin Kuzminski <marcin@python-works.com> parents: 568 diff changeset	159
707 1105531ae572 docs update, added ldap section, added troubleshooting section Marcin Kuzminski <marcin@python-works.com> parents: 683 diff changeset	160
1105531ae572 docs update, added ldap section, added troubleshooting section Marcin Kuzminski <marcin@python-works.com> parents: 683 diff changeset	161 Setting up LDAP support
1105531ae572 docs update, added ldap section, added troubleshooting section Marcin Kuzminski <marcin@python-works.com> parents: 683 diff changeset	162 -----------------------
1105531ae572 docs update, added ldap section, added troubleshooting section Marcin Kuzminski <marcin@python-works.com> parents: 683 diff changeset	163
4902 03bbd33bc084 docs: rework stuff Mads Kiilerich <madski@unity3d.com> parents: 4848 diff changeset	164 Kallithea supports LDAP authentication. In order
3224 8b8edfc25856 whitespace cleanup Marcin Kuzminski <marcin@python-works.com> parents: 2916 diff changeset	165 to use LDAP, you have to install the python-ldap_ package. This package is
5425 5ae8e644aa88 docs: spelling, grammar, content and typography Søren Løvborg <sorenl@unity3d.com> parents: 5413 diff changeset	166 available 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	167
1123 9472a0150bf0 docs update Marcin Kuzminski <marcin@python-works.com> parents: 1092 diff changeset	168 pip install python-ldap
707 1105531ae572 docs update, added ldap section, added troubleshooting section Marcin Kuzminski <marcin@python-works.com> parents: 683 diff changeset	169
4955 4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4925 diff changeset	170 .. note:: ``python-ldap`` requires some libraries to be installed on
4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4925 diff changeset	171 your system, so before installing it check that you have at
4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4925 diff changeset	172 least the ``openldap`` and ``sasl`` libraries.
707 1105531ae572 docs update, added ldap section, added troubleshooting section Marcin Kuzminski <marcin@python-works.com> parents: 683 diff changeset	173
4955 4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4925 diff changeset	174 LDAP settings are located in the Admin->LDAP section.
992 c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	175
4902 03bbd33bc084 docs: rework stuff Mads Kiilerich <madski@unity3d.com> parents: 4848 diff changeset	176 Here's a typical LDAP setup::
992 c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	177
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	178 Connection settings
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	179 Enable LDAP = checked
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	180 Host = host.example.org
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	181 Port = 389
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	182 Account = <account>
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	183 Password = <password>
1292 c0335c1dee36 added some fixes to LDAP form re-submition, new simples ldap-settings getter. Marcin Kuzminski <marcin@python-works.com> parents: 1284 diff changeset	184 Connection Security = LDAPS connection
992 c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	185 Certificate Checks = DEMAND
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	186
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	187 Search settings
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	188 Base DN = CN=users,DC=host,DC=example,DC=org
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	189 LDAP Filter = (&(objectClass=user)(!(objectClass=computer)))
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	190 LDAP Search Scope = SUBTREE
707 1105531ae572 docs update, added ldap section, added troubleshooting section Marcin Kuzminski <marcin@python-works.com> parents: 683 diff changeset	191
992 c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	192 Attribute mappings
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	193 Login Attribute = uid
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	194 First Name Attribute = firstName
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	195 Last Name Attribute = lastName
5412 2079e864ce51 spelling: use "email" consistently Søren Løvborg <sorenl@unity3d.com> parents: 5077 diff changeset	196 Email Attribute = mail
992 c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	197
4955 4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4925 diff changeset	198 If your user groups are placed in an Organisation Unit (OU) structure, the Search Settings configuration differs::
3801 6bad83d27fc1 Documentation: How to setup LDAP Filter when using Organisational Units. Magnus Ericmats <magnus.ericmats@gmail.com> parents: 3622 diff changeset	199
6bad83d27fc1 Documentation: How to setup LDAP Filter when using Organisational Units. Magnus Ericmats <magnus.ericmats@gmail.com> parents: 3622 diff changeset	200 Search settings
6bad83d27fc1 Documentation: How to setup LDAP Filter when using Organisational Units. Magnus Ericmats <magnus.ericmats@gmail.com> parents: 3622 diff changeset	201 Base DN = DC=host,DC=example,DC=org
6bad83d27fc1 Documentation: How to setup LDAP Filter when using Organisational Units. Magnus Ericmats <magnus.ericmats@gmail.com> parents: 3622 diff changeset	202 LDAP Filter = (&(memberOf=CN=your user group,OU=subunit,OU=unit,DC=host,DC=example,DC=org)(objectClass=user))
6bad83d27fc1 Documentation: How to setup LDAP Filter when using Organisational Units. Magnus Ericmats <magnus.ericmats@gmail.com> parents: 3622 diff changeset	203 LDAP Search Scope = SUBTREE
6bad83d27fc1 Documentation: How to setup LDAP Filter when using Organisational Units. Magnus Ericmats <magnus.ericmats@gmail.com> parents: 3622 diff changeset	204
992 c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	205 .. _enable_ldap:
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	206
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	207 Enable LDAP : required
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	208 Whether to use LDAP for authenticating users.
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	209
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	210 .. _ldap_host:
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	211
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	212 Host : required
2916 f6685a62e455 Updated docs about LDAP failover server list option Marcin Kuzminski <marcin@python-works.com> parents: 2906 diff changeset	213 LDAP server hostname or IP address. Can be also a comma separated
f6685a62e455 Updated docs about LDAP failover server list option Marcin Kuzminski <marcin@python-works.com> parents: 2906 diff changeset	214 list of servers to support LDAP fail-over.
992 c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	215
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	216 .. _Port:
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	217
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	218 Port : required
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	219 389 for un-encrypted LDAP, 636 for SSL-encrypted LDAP.
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	220
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	221 .. _ldap_account:
707 1105531ae572 docs update, added ldap section, added troubleshooting section Marcin Kuzminski <marcin@python-works.com> parents: 683 diff changeset	222
992 c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	223 Account : optional
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	224 Only required if the LDAP server does not allow anonymous browsing of
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	225 records. This should be a special account for record browsing. This
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	226 will require `LDAP Password`_ below.
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	227
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	228 .. _LDAP Password:
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	229
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	230 Password : optional
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	231 Only required if the LDAP server does not allow anonymous browsing of
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	232 records.
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	233
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	234 .. _Enable LDAPS:
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	235
1292 c0335c1dee36 added some fixes to LDAP form re-submition, new simples ldap-settings getter. Marcin Kuzminski <marcin@python-works.com> parents: 1284 diff changeset	236 Connection Security : required
c0335c1dee36 added some fixes to LDAP form re-submition, new simples ldap-settings getter. Marcin Kuzminski <marcin@python-works.com> parents: 1284 diff changeset	237 Defines the connection to LDAP server
c0335c1dee36 added some fixes to LDAP form re-submition, new simples ldap-settings getter. Marcin Kuzminski <marcin@python-works.com> parents: 1284 diff changeset	238
c0335c1dee36 added some fixes to LDAP form re-submition, new simples ldap-settings getter. Marcin Kuzminski <marcin@python-works.com> parents: 1284 diff changeset	239 No encryption
c0335c1dee36 added some fixes to LDAP form re-submition, new simples ldap-settings getter. Marcin Kuzminski <marcin@python-works.com> parents: 1284 diff changeset	240 Plain non encrypted connection
3224 8b8edfc25856 whitespace cleanup Marcin Kuzminski <marcin@python-works.com> parents: 2916 diff changeset	241
1292 c0335c1dee36 added some fixes to LDAP form re-submition, new simples ldap-settings getter. Marcin Kuzminski <marcin@python-works.com> parents: 1284 diff changeset	242 LDAPS connection
4902 03bbd33bc084 docs: rework stuff Mads Kiilerich <madski@unity3d.com> parents: 4848 diff changeset	243 Enable LDAPS connections. It will likely require `Port`_ to be set to
3224 8b8edfc25856 whitespace cleanup Marcin Kuzminski <marcin@python-works.com> parents: 2916 diff changeset	244 a different value (standard LDAPS port is 636). When LDAPS is enabled
1292 c0335c1dee36 added some fixes to LDAP form re-submition, new simples ldap-settings getter. Marcin Kuzminski <marcin@python-works.com> parents: 1284 diff changeset	245 then `Certificate Checks`_ is required.
3224 8b8edfc25856 whitespace cleanup Marcin Kuzminski <marcin@python-works.com> parents: 2916 diff changeset	246
1292 c0335c1dee36 added some fixes to LDAP form re-submition, new simples ldap-settings getter. Marcin Kuzminski <marcin@python-works.com> parents: 1284 diff changeset	247 START_TLS on LDAP connection
c0335c1dee36 added some fixes to LDAP form re-submition, new simples ldap-settings getter. Marcin Kuzminski <marcin@python-works.com> parents: 1284 diff changeset	248 START TLS connection
992 c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	249
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	250 .. _Certificate Checks:
707 1105531ae572 docs update, added ldap section, added troubleshooting section Marcin Kuzminski <marcin@python-works.com> parents: 683 diff changeset	251
992 c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	252 Certificate Checks : optional
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	253 How SSL certificates verification is handled - this is only useful when
3224 8b8edfc25856 whitespace cleanup Marcin Kuzminski <marcin@python-works.com> parents: 2916 diff changeset	254 `Enable LDAPS`_ is enabled. Only DEMAND or HARD offer full SSL security
1309 61a6a7bf2cbd small docs updates Marcin Kuzminski <marcin@python-works.com> parents: 1292 diff changeset	255 while the other options are susceptible to man-in-the-middle attacks. SSL
992 c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	256 certificates can be installed to /etc/openldap/cacerts so that the
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	257 DEMAND or HARD options can be used with self-signed certificates or
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	258 certificates that do not have traceable certificates of authority.
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	259
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	260 NEVER
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	261 A serve certificate will never be requested or checked.
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	262
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	263 ALLOW
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	264 A server certificate is requested. Failure to provide a
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	265 certificate or providing a bad certificate will not terminate the
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	266 session.
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	267
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	268 TRY
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	269 A server certificate is requested. Failure to provide a
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	270 certificate does not halt the session; providing a bad certificate
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	271 halts the session.
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	272
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	273 DEMAND
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	274 A server certificate is requested and must be provided and
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	275 authenticated for the session to proceed.
775 aaf2fc59a39a fixes #77 and adds extendable base Dn with custom uid specification Marcin Kuzminski <marcin@python-works.com> parents: 770 diff changeset	276
992 c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	277 HARD
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	278 The same as DEMAND.
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	279
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	280 .. _Base DN:
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	281
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	282 Base DN : required
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	283 The Distinguished Name (DN) where searches for users will be performed.
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	284 Searches can be controlled by `LDAP Filter`_ and `LDAP Search Scope`_.
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	285
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	286 .. _LDAP Filter:
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	287
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	288 LDAP Filter : optional
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	289 A LDAP filter defined by RFC 2254. This is more useful when `LDAP
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	290 Search Scope`_ is set to SUBTREE. The filter is useful for limiting
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	291 which LDAP objects are identified as representing Users for
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	292 authentication. The filter is augmented by `Login Attribute`_ below.
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	293 This can commonly be left blank.
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	294
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	295 .. _LDAP Search Scope:
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	296
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	297 LDAP Search Scope : required
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	298 This limits how far LDAP will search for a matching object.
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	299
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	300 BASE
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	301 Only allows searching of `Base DN`_ and is usually not what you
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	302 want.
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	303
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	304 ONELEVEL
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	305 Searches all entries under `Base DN`_, but not Base DN itself.
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	306
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	307 SUBTREE
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	308 Searches all entries below `Base DN`_, but not Base DN itself.
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	309 When using SUBTREE `LDAP Filter`_ is useful to limit object
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	310 location.
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	311
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	312 .. _Login Attribute:
707 1105531ae572 docs update, added ldap section, added troubleshooting section Marcin Kuzminski <marcin@python-works.com> parents: 683 diff changeset	313
3224 8b8edfc25856 whitespace cleanup Marcin Kuzminski <marcin@python-works.com> parents: 2916 diff changeset	314 Login Attribute : required
992 c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	315 The LDAP record attribute that will be matched as the USERNAME or
4192 e73a69cb98dc Rename some strings examples and commands in documentation Bradley M. Kuhn <bkuhn@sfconservancy.org> parents: 4186 diff changeset	316 ACCOUNT used to connect to Kallithea. This will be added to `LDAP
992 c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	317 Filter`_ for locating the User object. If `LDAP Filter`_ is specified as
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	318 "LDAPFILTER", `Login Attribute`_ is specified as "uid" and the user has
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	319 connected as "jsmith" then the `LDAP Filter`_ will be augmented as below
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	320 ::
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	321
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	322 (&(LDAPFILTER)(uid=jsmith))
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	323
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	324 .. _ldap_attr_firstname:
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	325
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	326 First Name Attribute : required
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	327 The LDAP record attribute which represents the user's first name.
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	328
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	329 .. _ldap_attr_lastname:
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	330
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	331 Last Name Attribute : required
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	332 The LDAP record attribute which represents the user's last name.
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	333
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	334 .. _ldap_attr_email:
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	335
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	336 Email Attribute : required
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	337 The LDAP record attribute which represents the user's email address.
707 1105531ae572 docs update, added ldap section, added troubleshooting section Marcin Kuzminski <marcin@python-works.com> parents: 683 diff changeset	338
992 c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	339 If all data are entered correctly, and python-ldap_ is properly installed
4902 03bbd33bc084 docs: rework stuff Mads Kiilerich <madski@unity3d.com> parents: 4848 diff changeset	340 users should be granted access to Kallithea with LDAP accounts. At this
4192 e73a69cb98dc Rename some strings examples and commands in documentation Bradley M. Kuhn <bkuhn@sfconservancy.org> parents: 4186 diff changeset	341 time user information is copied from LDAP into the Kallithea user database.
992 c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	342 This means that updates of an LDAP user object may not be reflected as a
4192 e73a69cb98dc Rename some strings examples and commands in documentation Bradley M. Kuhn <bkuhn@sfconservancy.org> parents: 4186 diff changeset	343 user update in Kallithea.
992 c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	344
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	345 If You have problems with LDAP access and believe You entered correct
4192 e73a69cb98dc Rename some strings examples and commands in documentation Bradley M. Kuhn <bkuhn@sfconservancy.org> parents: 4186 diff changeset	346 information check out the Kallithea logs, any error messages sent from LDAP
992 c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	347 will be saved there.
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	348
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	349 Active Directory
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	350 ''''''''''''''''
707 1105531ae572 docs update, added ldap section, added troubleshooting section Marcin Kuzminski <marcin@python-works.com> parents: 683 diff changeset	351
4192 e73a69cb98dc Rename some strings examples and commands in documentation Bradley M. Kuhn <bkuhn@sfconservancy.org> parents: 4186 diff changeset	352 Kallithea can use Microsoft Active Directory for user authentication. This
992 c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	353 is done through an LDAP or LDAPS connection to Active Directory. The
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	354 following LDAP configuration settings are typical for using Active
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	355 Directory ::
707 1105531ae572 docs update, added ldap section, added troubleshooting section Marcin Kuzminski <marcin@python-works.com> parents: 683 diff changeset	356
992 c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	357 Base DN = OU=SBSUsers,OU=Users,OU=MyBusiness,DC=v3sys,DC=local
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	358 Login Attribute = sAMAccountName
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	359 First Name Attribute = givenName
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	360 Last Name Attribute = sn
5412 2079e864ce51 spelling: use "email" consistently Søren Løvborg <sorenl@unity3d.com> parents: 5077 diff changeset	361 Email Attribute = mail
992 c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	362
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	363 All other LDAP settings will likely be site-specific and should be
c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	364 appropriately configured.
777 aac24db58ce8 fixed cache problem, Marcin Kuzminski <marcin@python-works.com> parents: 775 diff changeset	365
1467 da60cdb41969 doc update - hooks Marcin Kuzminski <marcin@python-works.com> parents: 1448 diff changeset	366
1657 d2a108366f8f Added documentation for container-based and proxy pass-through authentication Liad Shani <liadff@gmail.com> parents: 1559 diff changeset	367 Authentication by container or reverse-proxy
d2a108366f8f Added documentation for container-based and proxy pass-through authentication Liad Shani <liadff@gmail.com> parents: 1559 diff changeset	368 --------------------------------------------
d2a108366f8f Added documentation for container-based and proxy pass-through authentication Liad Shani <liadff@gmail.com> parents: 1559 diff changeset	369
4501 a68fc4abeda3 issue #7 remove obsolete configuration domruf <dominikruf@gmail.com> parents: 4448 diff changeset	370 Kallithea supports delegating the authentication
1657 d2a108366f8f Added documentation for container-based and proxy pass-through authentication Liad Shani <liadff@gmail.com> parents: 1559 diff changeset	371 of users to its WSGI container, or to a reverse-proxy server through which all
d2a108366f8f Added documentation for container-based and proxy pass-through authentication Liad Shani <liadff@gmail.com> parents: 1559 diff changeset	372 clients access the application.
d2a108366f8f Added documentation for container-based and proxy pass-through authentication Liad Shani <liadff@gmail.com> parents: 1559 diff changeset	373
4192 e73a69cb98dc Rename some strings examples and commands in documentation Bradley M. Kuhn <bkuhn@sfconservancy.org> parents: 4186 diff changeset	374 When these authentication methods are enabled in Kallithea, it uses the
5425 5ae8e644aa88 docs: spelling, grammar, content and typography Søren Løvborg <sorenl@unity3d.com> parents: 5413 diff changeset	375 username that the container/proxy (Apache or Nginx, etc.) provides and doesn't
1657 d2a108366f8f Added documentation for container-based and proxy pass-through authentication Liad Shani <liadff@gmail.com> parents: 1559 diff changeset	376 perform the authentication itself. The authorization, however, is still done by
4192 e73a69cb98dc Rename some strings examples and commands in documentation Bradley M. Kuhn <bkuhn@sfconservancy.org> parents: 4186 diff changeset	377 Kallithea according to its settings.
1657 d2a108366f8f Added documentation for container-based and proxy pass-through authentication Liad Shani <liadff@gmail.com> parents: 1559 diff changeset	378
d2a108366f8f Added documentation for container-based and proxy pass-through authentication Liad Shani <liadff@gmail.com> parents: 1559 diff changeset	379 When a user logs in for the first time using these authentication methods,
4192 e73a69cb98dc Rename some strings examples and commands in documentation Bradley M. Kuhn <bkuhn@sfconservancy.org> parents: 4186 diff changeset	380 a matching user account is created in Kallithea with default permissions. An
e73a69cb98dc Rename some strings examples and commands in documentation Bradley M. Kuhn <bkuhn@sfconservancy.org> parents: 4186 diff changeset	381 administrator can then modify it using Kallithea's admin interface.
5425 5ae8e644aa88 docs: spelling, grammar, content and typography Søren Løvborg <sorenl@unity3d.com> parents: 5413 diff changeset	382
1657 d2a108366f8f Added documentation for container-based and proxy pass-through authentication Liad Shani <liadff@gmail.com> parents: 1559 diff changeset	383 It's also possible for an administrator to create accounts and configure their
5425 5ae8e644aa88 docs: spelling, grammar, content and typography Søren Løvborg <sorenl@unity3d.com> parents: 5413 diff changeset	384 permissions before the user logs in for the first time, using the :ref:`create-user` API.
1657 d2a108366f8f Added documentation for container-based and proxy pass-through authentication Liad Shani <liadff@gmail.com> parents: 1559 diff changeset	385
4501 a68fc4abeda3 issue #7 remove obsolete configuration domruf <dominikruf@gmail.com> parents: 4448 diff changeset	386
1657 d2a108366f8f Added documentation for container-based and proxy pass-through authentication Liad Shani <liadff@gmail.com> parents: 1559 diff changeset	387 Container-based authentication
d2a108366f8f Added documentation for container-based and proxy pass-through authentication Liad Shani <liadff@gmail.com> parents: 1559 diff changeset	388 ''''''''''''''''''''''''''''''
d2a108366f8f Added documentation for container-based and proxy pass-through authentication Liad Shani <liadff@gmail.com> parents: 1559 diff changeset	389
4192 e73a69cb98dc Rename some strings examples and commands in documentation Bradley M. Kuhn <bkuhn@sfconservancy.org> parents: 4186 diff changeset	390 In a container-based authentication setup, Kallithea reads the user name from
1657 d2a108366f8f Added documentation for container-based and proxy pass-through authentication Liad Shani <liadff@gmail.com> parents: 1559 diff changeset	391 the ``REMOTE_USER`` server variable provided by the WSGI container.
d2a108366f8f Added documentation for container-based and proxy pass-through authentication Liad Shani <liadff@gmail.com> parents: 1559 diff changeset	392
5425 5ae8e644aa88 docs: spelling, grammar, content and typography Søren Løvborg <sorenl@unity3d.com> parents: 5413 diff changeset	393 After setting up your container (see `Apache with mod_wsgi`_), you'll need
1657 d2a108366f8f Added documentation for container-based and proxy pass-through authentication Liad Shani <liadff@gmail.com> parents: 1559 diff changeset	394 to configure it to require authentication on the location configured for
4192 e73a69cb98dc Rename some strings examples and commands in documentation Bradley M. Kuhn <bkuhn@sfconservancy.org> parents: 4186 diff changeset	395 Kallithea.
1657 d2a108366f8f Added documentation for container-based and proxy pass-through authentication Liad Shani <liadff@gmail.com> parents: 1559 diff changeset	396
d2a108366f8f Added documentation for container-based and proxy pass-through authentication Liad Shani <liadff@gmail.com> parents: 1559 diff changeset	397
d2a108366f8f Added documentation for container-based and proxy pass-through authentication Liad Shani <liadff@gmail.com> parents: 1559 diff changeset	398 Proxy pass-through authentication
d2a108366f8f Added documentation for container-based and proxy pass-through authentication Liad Shani <liadff@gmail.com> parents: 1559 diff changeset	399 '''''''''''''''''''''''''''''''''
d2a108366f8f Added documentation for container-based and proxy pass-through authentication Liad Shani <liadff@gmail.com> parents: 1559 diff changeset	400
4192 e73a69cb98dc Rename some strings examples and commands in documentation Bradley M. Kuhn <bkuhn@sfconservancy.org> parents: 4186 diff changeset	401 In a proxy pass-through authentication setup, Kallithea reads the user name
1657 d2a108366f8f Added documentation for container-based and proxy pass-through authentication Liad Shani <liadff@gmail.com> parents: 1559 diff changeset	402 from the ``X-Forwarded-User`` request header, which should be configured to be
d2a108366f8f Added documentation for container-based and proxy pass-through authentication Liad Shani <liadff@gmail.com> parents: 1559 diff changeset	403 sent by the reverse-proxy server.
d2a108366f8f Added documentation for container-based and proxy pass-through authentication Liad Shani <liadff@gmail.com> parents: 1559 diff changeset	404
d2a108366f8f Added documentation for container-based and proxy pass-through authentication Liad Shani <liadff@gmail.com> parents: 1559 diff changeset	405 After setting up your proxy solution (see `Apache virtual host reverse proxy example`_,
5425 5ae8e644aa88 docs: spelling, grammar, content and typography Søren Løvborg <sorenl@unity3d.com> parents: 5413 diff changeset	406 `Apache as subdirectory`_ or `Nginx virtual host example`_), you'll need to
1657 d2a108366f8f Added documentation for container-based and proxy pass-through authentication Liad Shani <liadff@gmail.com> parents: 1559 diff changeset	407 configure the authentication and add the username in a request header named
d2a108366f8f Added documentation for container-based and proxy pass-through authentication Liad Shani <liadff@gmail.com> parents: 1559 diff changeset	408 ``X-Forwarded-User``.
d2a108366f8f Added documentation for container-based and proxy pass-through authentication Liad Shani <liadff@gmail.com> parents: 1559 diff changeset	409
d2a108366f8f Added documentation for container-based and proxy pass-through authentication Liad Shani <liadff@gmail.com> parents: 1559 diff changeset	410 For example, the following config section for Apache sets a subdirectory in a
5425 5ae8e644aa88 docs: spelling, grammar, content and typography Søren Løvborg <sorenl@unity3d.com> parents: 5413 diff changeset	411 reverse-proxy setup with basic auth:
5ae8e644aa88 docs: spelling, grammar, content and typography Søren Løvborg <sorenl@unity3d.com> parents: 5413 diff changeset	412
5ae8e644aa88 docs: spelling, grammar, content and typography Søren Løvborg <sorenl@unity3d.com> parents: 5413 diff changeset	413 .. code-block:: apache
1657 d2a108366f8f Added documentation for container-based and proxy pass-through authentication Liad Shani <liadff@gmail.com> parents: 1559 diff changeset	414
5425 5ae8e644aa88 docs: spelling, grammar, content and typography Søren Løvborg <sorenl@unity3d.com> parents: 5413 diff changeset	415 <Location /someprefix>
5ae8e644aa88 docs: spelling, grammar, content and typography Søren Løvborg <sorenl@unity3d.com> parents: 5413 diff changeset	416 ProxyPass http://127.0.0.1:5000/someprefix
5ae8e644aa88 docs: spelling, grammar, content and typography Søren Løvborg <sorenl@unity3d.com> parents: 5413 diff changeset	417 ProxyPassReverse http://127.0.0.1:5000/someprefix
1657 d2a108366f8f Added documentation for container-based and proxy pass-through authentication Liad Shani <liadff@gmail.com> parents: 1559 diff changeset	418 SetEnvIf X-Url-Scheme https HTTPS=1
d2a108366f8f Added documentation for container-based and proxy pass-through authentication Liad Shani <liadff@gmail.com> parents: 1559 diff changeset	419
d2a108366f8f Added documentation for container-based and proxy pass-through authentication Liad Shani <liadff@gmail.com> parents: 1559 diff changeset	420 AuthType Basic
4192 e73a69cb98dc Rename some strings examples and commands in documentation Bradley M. Kuhn <bkuhn@sfconservancy.org> parents: 4186 diff changeset	421 AuthName "Kallithea authentication"
4902 03bbd33bc084 docs: rework stuff Mads Kiilerich <madski@unity3d.com> parents: 4848 diff changeset	422 AuthUserFile /srv/kallithea/.htpasswd
5425 5ae8e644aa88 docs: spelling, grammar, content and typography Søren Løvborg <sorenl@unity3d.com> parents: 5413 diff changeset	423 Require valid-user
1657 d2a108366f8f Added documentation for container-based and proxy pass-through authentication Liad Shani <liadff@gmail.com> parents: 1559 diff changeset	424
d2a108366f8f Added documentation for container-based and proxy pass-through authentication Liad Shani <liadff@gmail.com> parents: 1559 diff changeset	425 RequestHeader unset X-Forwarded-User
d2a108366f8f Added documentation for container-based and proxy pass-through authentication Liad Shani <liadff@gmail.com> parents: 1559 diff changeset	426
d2a108366f8f Added documentation for container-based and proxy pass-through authentication Liad Shani <liadff@gmail.com> parents: 1559 diff changeset	427 RewriteEngine On
d2a108366f8f Added documentation for container-based and proxy pass-through authentication Liad Shani <liadff@gmail.com> parents: 1559 diff changeset	428 RewriteCond %{LA-U:REMOTE_USER} (.+)
d2a108366f8f Added documentation for container-based and proxy pass-through authentication Liad Shani <liadff@gmail.com> parents: 1559 diff changeset	429 RewriteRule .* - [E=RU:%1]
d2a108366f8f Added documentation for container-based and proxy pass-through authentication Liad Shani <liadff@gmail.com> parents: 1559 diff changeset	430 RequestHeader set X-Forwarded-User %{RU}e
3224 8b8edfc25856 whitespace cleanup Marcin Kuzminski <marcin@python-works.com> parents: 2916 diff changeset	431 </Location>
1657 d2a108366f8f Added documentation for container-based and proxy pass-through authentication Liad Shani <liadff@gmail.com> parents: 1559 diff changeset	432
d2a108366f8f Added documentation for container-based and proxy pass-through authentication Liad Shani <liadff@gmail.com> parents: 1559 diff changeset	433
d2a108366f8f Added documentation for container-based and proxy pass-through authentication Liad Shani <liadff@gmail.com> parents: 1559 diff changeset	434 .. note::
d2a108366f8f Added documentation for container-based and proxy pass-through authentication Liad Shani <liadff@gmail.com> parents: 1559 diff changeset	435 If you enable proxy pass-through authentication, make sure your server is
d2a108366f8f Added documentation for container-based and proxy pass-through authentication Liad Shani <liadff@gmail.com> parents: 1559 diff changeset	436 only accessible through the proxy. Otherwise, any client would be able to
d2a108366f8f Added documentation for container-based and proxy pass-through authentication Liad Shani <liadff@gmail.com> parents: 1559 diff changeset	437 forge the authentication header and could effectively become authenticated
d2a108366f8f Added documentation for container-based and proxy pass-through authentication Liad Shani <liadff@gmail.com> parents: 1559 diff changeset	438 using any account of their liking.
d2a108366f8f Added documentation for container-based and proxy pass-through authentication Liad Shani <liadff@gmail.com> parents: 1559 diff changeset	439
5413 22a3fa3c4254 docs: cleanup of casing, markup and spacing of headings Mads Kiilerich <madski@unity3d.com> parents: 5412 diff changeset	440
22a3fa3c4254 docs: cleanup of casing, markup and spacing of headings Mads Kiilerich <madski@unity3d.com> parents: 5412 diff changeset	441 Integration with issue trackers
1838 2ef309c3175d docs update Marcin Kuzminski <marcin@python-works.com> parents: 1745 diff changeset	442 -------------------------------
1657 d2a108366f8f Added documentation for container-based and proxy pass-through authentication Liad Shani <liadff@gmail.com> parents: 1559 diff changeset	443
4192 e73a69cb98dc Rename some strings examples and commands in documentation Bradley M. Kuhn <bkuhn@sfconservancy.org> parents: 4186 diff changeset	444 Kallithea provides a simple integration with issue trackers. It's possible
5425 5ae8e644aa88 docs: spelling, grammar, content and typography Søren Løvborg <sorenl@unity3d.com> parents: 5413 diff changeset	445 to define a regular expression that will match an issue ID in commit messages,
5ae8e644aa88 docs: spelling, grammar, content and typography Søren Løvborg <sorenl@unity3d.com> parents: 5413 diff changeset	446 and have that replaced with a URL to the issue. To enable this simply
4955 4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4925 diff changeset	447 uncomment the following variables in the ini file::
1838 2ef309c3175d docs update Marcin Kuzminski <marcin@python-works.com> parents: 1745 diff changeset	448
3943 a5bccf34c512 fixed docs error, should be issue_pat Marcin Kuzminski <marcin@python-works.com> parents: 3923 diff changeset	449 issue_pat = (?:^#\|\s#)(\w+)
1870 941dee113136 docs update Marcin Kuzminski <marcin@python-works.com> parents: 1838 diff changeset	450 issue_server_link = https://myissueserver.com/{repo}/issue/{id}
1838 2ef309c3175d docs update Marcin Kuzminski <marcin@python-works.com> parents: 1745 diff changeset	451 issue_prefix = #
2ef309c3175d docs update Marcin Kuzminski <marcin@python-works.com> parents: 1745 diff changeset	452
4955 4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4925 diff changeset	453 ``issue_pat`` is the regular expression describing which strings in
4848 570a4e40f0bb docs: improve issue tracker integration docs Andrew Shadura <andrew@shadura.me> parents: 4522 diff changeset	454 commit messages will be treated as issue references. A match group in
570a4e40f0bb docs: improve issue tracker integration docs Andrew Shadura <andrew@shadura.me> parents: 4522 diff changeset	455 parentheses should be used to specify the actual issue id.
570a4e40f0bb docs: improve issue tracker integration docs Andrew Shadura <andrew@shadura.me> parents: 4522 diff changeset	456
4955 4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4925 diff changeset	457 The default expression matches issues in the format ``#<number>``, e.g., ``#300``.
3224 8b8edfc25856 whitespace cleanup Marcin Kuzminski <marcin@python-works.com> parents: 2916 diff changeset	458
5425 5ae8e644aa88 docs: spelling, grammar, content and typography Søren Løvborg <sorenl@unity3d.com> parents: 5413 diff changeset	459 Matched issue references are replaced with the link specified in
5ae8e644aa88 docs: spelling, grammar, content and typography Søren Løvborg <sorenl@unity3d.com> parents: 5413 diff changeset	460 ``issue_server_link``. ``{id}`` is replaced with the issue ID, and
4955 4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4925 diff changeset	461 ``{repo}`` with the repository name. Since the # is stripped away,
4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4925 diff changeset	462 ``issue_prefix`` is prepended to the link text. ``issue_prefix`` doesn't
4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4925 diff changeset	463 necessarily need to be ``#``: if you set issue prefix to ``ISSUE-`` this will
5425 5ae8e644aa88 docs: spelling, grammar, content and typography Søren Løvborg <sorenl@unity3d.com> parents: 5413 diff changeset	464 generate a URL in the format:
5ae8e644aa88 docs: spelling, grammar, content and typography Søren Løvborg <sorenl@unity3d.com> parents: 5413 diff changeset	465
5ae8e644aa88 docs: spelling, grammar, content and typography Søren Løvborg <sorenl@unity3d.com> parents: 5413 diff changeset	466 .. code-block:: html
3224 8b8edfc25856 whitespace cleanup Marcin Kuzminski <marcin@python-works.com> parents: 2916 diff changeset	467
8b8edfc25856 whitespace cleanup Marcin Kuzminski <marcin@python-works.com> parents: 2916 diff changeset	468 <a href="https://myissueserver.com/example_repo/issue/300">ISSUE-300</a>
1657 d2a108366f8f Added documentation for container-based and proxy pass-through authentication Liad Shani <liadff@gmail.com> parents: 1559 diff changeset	469
4848 570a4e40f0bb docs: improve issue tracker integration docs Andrew Shadura <andrew@shadura.me> parents: 4522 diff changeset	470 If needed, more than one pattern can be specified by appending a unique suffix to
570a4e40f0bb docs: improve issue tracker integration docs Andrew Shadura <andrew@shadura.me> parents: 4522 diff changeset	471 the variables. For example::
570a4e40f0bb docs: improve issue tracker integration docs Andrew Shadura <andrew@shadura.me> parents: 4522 diff changeset	472
570a4e40f0bb docs: improve issue tracker integration docs Andrew Shadura <andrew@shadura.me> parents: 4522 diff changeset	473 issue_pat_wiki = (?:wiki-)(.+)
570a4e40f0bb docs: improve issue tracker integration docs Andrew Shadura <andrew@shadura.me> parents: 4522 diff changeset	474 issue_server_link_wiki = https://mywiki.com/{id}
570a4e40f0bb docs: improve issue tracker integration docs Andrew Shadura <andrew@shadura.me> parents: 4522 diff changeset	475 issue_prefix_wiki = WIKI-
570a4e40f0bb docs: improve issue tracker integration docs Andrew Shadura <andrew@shadura.me> parents: 4522 diff changeset	476
570a4e40f0bb docs: improve issue tracker integration docs Andrew Shadura <andrew@shadura.me> parents: 4522 diff changeset	477 With these settings, wiki pages can be referenced as wiki-some-id, and every
5425 5ae8e644aa88 docs: spelling, grammar, content and typography Søren Løvborg <sorenl@unity3d.com> parents: 5413 diff changeset	478 such reference will be transformed into:
5ae8e644aa88 docs: spelling, grammar, content and typography Søren Løvborg <sorenl@unity3d.com> parents: 5413 diff changeset	479
5ae8e644aa88 docs: spelling, grammar, content and typography Søren Løvborg <sorenl@unity3d.com> parents: 5413 diff changeset	480 .. code-block:: html
4848 570a4e40f0bb docs: improve issue tracker integration docs Andrew Shadura <andrew@shadura.me> parents: 4522 diff changeset	481
570a4e40f0bb docs: improve issue tracker integration docs Andrew Shadura <andrew@shadura.me> parents: 4522 diff changeset	482 <a href="https://mywiki.com/some-id">WIKI-some-id</a>
570a4e40f0bb docs: improve issue tracker integration docs Andrew Shadura <andrew@shadura.me> parents: 4522 diff changeset	483
570a4e40f0bb docs: improve issue tracker integration docs Andrew Shadura <andrew@shadura.me> parents: 4522 diff changeset	484
1467 da60cdb41969 doc update - hooks Marcin Kuzminski <marcin@python-works.com> parents: 1448 diff changeset	485 Hook management
da60cdb41969 doc update - hooks Marcin Kuzminski <marcin@python-works.com> parents: 1448 diff changeset	486 ---------------
da60cdb41969 doc update - hooks Marcin Kuzminski <marcin@python-works.com> parents: 1448 diff changeset	487
4955 4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4925 diff changeset	488 Hooks can be managed in similar way to that used in ``.hgrc`` files.
4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4925 diff changeset	489 To access hooks setting click `advanced setup` in the `Hooks` section
4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4925 diff changeset	490 of Mercurial Settings in Admin.
1467 da60cdb41969 doc update - hooks Marcin Kuzminski <marcin@python-works.com> parents: 1448 diff changeset	491
5425 5ae8e644aa88 docs: spelling, grammar, content and typography Søren Løvborg <sorenl@unity3d.com> parents: 5413 diff changeset	492 The built-in hooks cannot be modified, though they can be enabled or disabled in the VCS section.
5ae8e644aa88 docs: spelling, grammar, content and typography Søren Løvborg <sorenl@unity3d.com> parents: 5413 diff changeset	493
5ae8e644aa88 docs: spelling, grammar, content and typography Søren Løvborg <sorenl@unity3d.com> parents: 5413 diff changeset	494 To add another custom hook simply fill in the first textbox with
5ae8e644aa88 docs: spelling, grammar, content and typography Søren Løvborg <sorenl@unity3d.com> parents: 5413 diff changeset	495 ``<name>.<hook_type>`` and the second with the hook path. Example hooks
4955 4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4925 diff changeset	496 can be found in ``kallithea.lib.hooks``.
1467 da60cdb41969 doc update - hooks Marcin Kuzminski <marcin@python-works.com> parents: 1448 diff changeset	497
da60cdb41969 doc update - hooks Marcin Kuzminski <marcin@python-works.com> parents: 1448 diff changeset	498
2017 03a549b35c57 updated setup docs about encoding Marcin Kuzminski <marcin@python-works.com> parents: 1870 diff changeset	499 Changing default encoding
03a549b35c57 updated setup docs about encoding Marcin Kuzminski <marcin@python-works.com> parents: 1870 diff changeset	500 -------------------------
03a549b35c57 updated setup docs about encoding Marcin Kuzminski <marcin@python-works.com> parents: 1870 diff changeset	501
4914 95fe05b1e5f8 docs: better capitalisation Andrew Shadura <andrew@shadura.me> parents: 4902 diff changeset	502 By default, Kallithea uses UTF-8 encoding.
4955 4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4925 diff changeset	503 This is configurable as ``default_encoding`` in the .ini file.
4902 03bbd33bc084 docs: rework stuff Mads Kiilerich <madski@unity3d.com> parents: 4848 diff changeset	504 This affects many parts in Kallithea including user names, filenames, and
4955 4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4925 diff changeset	505 encoding of commit messages. In addition Kallithea can detect if the ``chardet``
4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4925 diff changeset	506 library is installed. If ``chardet`` is detected Kallithea will fallback to it
2017 03a549b35c57 updated setup docs about encoding Marcin Kuzminski <marcin@python-works.com> parents: 1870 diff changeset	507 when there are encode/decode errors.
03a549b35c57 updated setup docs about encoding Marcin Kuzminski <marcin@python-works.com> parents: 1870 diff changeset	508
03a549b35c57 updated setup docs about encoding Marcin Kuzminski <marcin@python-works.com> parents: 1870 diff changeset	509
4902 03bbd33bc084 docs: rework stuff Mads Kiilerich <madski@unity3d.com> parents: 4848 diff changeset	510 Celery configuration
03bbd33bc084 docs: rework stuff Mads Kiilerich <madski@unity3d.com> parents: 4848 diff changeset	511 --------------------
777 aac24db58ce8 fixed cache problem, Marcin Kuzminski <marcin@python-works.com> parents: 775 diff changeset	512
4925 56cd202b777e docs: move all instructions on Celery to Setup Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> parents: 4915 diff changeset	513 Kallithea can use the distributed task queue system Celery_ to run tasks like
5412 2079e864ce51 spelling: use "email" consistently Søren Løvborg <sorenl@unity3d.com> parents: 5077 diff changeset	514 cloning repositories or sending emails.
4925 56cd202b777e docs: move all instructions on Celery to Setup Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> parents: 4915 diff changeset	515
56cd202b777e docs: move all instructions on Celery to Setup Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> parents: 4915 diff changeset	516 Kallithea will in most setups work perfectly fine out of the box (without
56cd202b777e docs: move all instructions on Celery to Setup Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> parents: 4915 diff changeset	517 Celery), executing all tasks in the web server process. Some tasks can however
56cd202b777e docs: move all instructions on Celery to Setup Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> parents: 4915 diff changeset	518 take some time to run and it can be better to run such tasks asynchronously in
56cd202b777e docs: move all instructions on Celery to Setup Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> parents: 4915 diff changeset	519 a separate process so the web server can focus on serving web requests.
56cd202b777e docs: move all instructions on Celery to Setup Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> parents: 4915 diff changeset	520
56cd202b777e docs: move all instructions on Celery to Setup Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> parents: 4915 diff changeset	521 For installation and configuration of Celery, see the `Celery documentation`_.
56cd202b777e docs: move all instructions on Celery to Setup Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> parents: 4915 diff changeset	522 Note that Celery requires a message broker service like RabbitMQ_ (recommended)
56cd202b777e docs: move all instructions on Celery to Setup Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> parents: 4915 diff changeset	523 or Redis_.
777 aac24db58ce8 fixed cache problem, Marcin Kuzminski <marcin@python-works.com> parents: 775 diff changeset	524
4925 56cd202b777e docs: move all instructions on Celery to Setup Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> parents: 4915 diff changeset	525 The use of Celery is configured in the Kallithea ini configuration file.
56cd202b777e docs: move all instructions on Celery to Setup Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> parents: 4915 diff changeset	526 To enable it, simply set::
56cd202b777e docs: move all instructions on Celery to Setup Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> parents: 4915 diff changeset	527
4955 4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4925 diff changeset	528 use_celery = true
777 aac24db58ce8 fixed cache problem, Marcin Kuzminski <marcin@python-works.com> parents: 775 diff changeset	529
4955 4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4925 diff changeset	530 and add or change the ``celery.`` and ``broker.`` configuration variables.
4925 56cd202b777e docs: move all instructions on Celery to Setup Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> parents: 4915 diff changeset	531
56cd202b777e docs: move all instructions on Celery to Setup Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> parents: 4915 diff changeset	532 Remember that the ini files use the format with '.' and not with '_' like
56cd202b777e docs: move all instructions on Celery to Setup Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> parents: 4915 diff changeset	533 Celery. So for example setting `BROKER_HOST` in Celery means setting
56cd202b777e docs: move all instructions on Celery to Setup Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> parents: 4915 diff changeset	534 `broker.host` in the configuration file.
56cd202b777e docs: move all instructions on Celery to Setup Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> parents: 4915 diff changeset	535
56cd202b777e docs: move all instructions on Celery to Setup Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> parents: 4915 diff changeset	536 To start the Celery process, run::
938 442ccfe939d0 fixed changelog, and setup docs. Yeeee a 1000 commit :) Marcin Kuzminski <marcin@python-works.com> parents: 929 diff changeset	537
777 aac24db58ce8 fixed cache problem, Marcin Kuzminski <marcin@python-works.com> parents: 775 diff changeset	538 paster celeryd <configfile.ini>
aac24db58ce8 fixed cache problem, Marcin Kuzminski <marcin@python-works.com> parents: 775 diff changeset	539
aac24db58ce8 fixed cache problem, Marcin Kuzminski <marcin@python-works.com> parents: 775 diff changeset	540
871 7f9e006aa26f docs update for celeryd Marcin Kuzminski <marcin@python-works.com> parents: 845 diff changeset	541 .. note::
3224 8b8edfc25856 whitespace cleanup Marcin Kuzminski <marcin@python-works.com> parents: 2916 diff changeset	542 Make sure you run this command from the same virtualenv, and with the same
4192 e73a69cb98dc Rename some strings examples and commands in documentation Bradley M. Kuhn <bkuhn@sfconservancy.org> parents: 4186 diff changeset	543 user that Kallithea runs.
3224 8b8edfc25856 whitespace cleanup Marcin Kuzminski <marcin@python-works.com> parents: 2916 diff changeset	544
5425 5ae8e644aa88 docs: spelling, grammar, content and typography Søren Løvborg <sorenl@unity3d.com> parents: 5413 diff changeset	545
1062 053983a464e4 docs and readme update Marcin Kuzminski <marcin@python-works.com> parents: 992 diff changeset	546 HTTPS support
053983a464e4 docs and readme update Marcin Kuzminski <marcin@python-works.com> parents: 992 diff changeset	547 -------------
053983a464e4 docs and readme update Marcin Kuzminski <marcin@python-works.com> parents: 992 diff changeset	548
4448 8e26c46e9abe https: introduce https_fixup config setting to enable the special https hacks Mads Kiilerich <madski@unity3d.com> parents: 4192 diff changeset	549 Kallithea will by default generate URLs based on the WSGI environment.
8e26c46e9abe https: introduce https_fixup config setting to enable the special https hacks Mads Kiilerich <madski@unity3d.com> parents: 4192 diff changeset	550
8e26c46e9abe https: introduce https_fixup config setting to enable the special https hacks Mads Kiilerich <madski@unity3d.com> parents: 4192 diff changeset	551 Alternatively, you can use some special configuration settings to control
8e26c46e9abe https: introduce https_fixup config setting to enable the special https hacks Mads Kiilerich <madski@unity3d.com> parents: 4192 diff changeset	552 directly which scheme/protocol Kallithea will use when generating URLs:
1092 8af52e1224ff merge docs in beta with those corrected by Jason Harris Marcin Kuzminski <marcin@python-works.com> parents: 1062 diff changeset	553
5425 5ae8e644aa88 docs: spelling, grammar, content and typography Søren Løvborg <sorenl@unity3d.com> parents: 5413 diff changeset	554 - With ``https_fixup = true``, the scheme will be taken from the
5ae8e644aa88 docs: spelling, grammar, content and typography Søren Løvborg <sorenl@unity3d.com> parents: 5413 diff changeset	555 ``X-Url-Scheme``, ``X-Forwarded-Scheme`` or ``X-Forwarded-Proto`` HTTP header
5ae8e644aa88 docs: spelling, grammar, content and typography Søren Løvborg <sorenl@unity3d.com> parents: 5413 diff changeset	556 (default ``http``).
4955 4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4925 diff changeset	557 - With ``force_https = true`` the default will be ``https``.
5425 5ae8e644aa88 docs: spelling, grammar, content and typography Søren Løvborg <sorenl@unity3d.com> parents: 5413 diff changeset	558 - With ``use_htsts = true``, Kallithea will set ``Strict-Transport-Security`` when using https.
5ae8e644aa88 docs: spelling, grammar, content and typography Søren Løvborg <sorenl@unity3d.com> parents: 5413 diff changeset	559
871 7f9e006aa26f docs update for celeryd Marcin Kuzminski <marcin@python-works.com> parents: 845 diff changeset	560
572 a60cd29ba7e2 more docs update Marcin Kuzminski <marcin@python-works.com> parents: 568 diff changeset	561 Nginx virtual host example
a60cd29ba7e2 more docs update Marcin Kuzminski <marcin@python-works.com> parents: 568 diff changeset	562 --------------------------
a60cd29ba7e2 more docs update Marcin Kuzminski <marcin@python-works.com> parents: 568 diff changeset	563
5425 5ae8e644aa88 docs: spelling, grammar, content and typography Søren Løvborg <sorenl@unity3d.com> parents: 5413 diff changeset	564 Sample config for Nginx using proxy:
5ae8e644aa88 docs: spelling, grammar, content and typography Søren Løvborg <sorenl@unity3d.com> parents: 5413 diff changeset	565
5ae8e644aa88 docs: spelling, grammar, content and typography Søren Løvborg <sorenl@unity3d.com> parents: 5413 diff changeset	566 .. code-block:: nginx
572 a60cd29ba7e2 more docs update Marcin Kuzminski <marcin@python-works.com> parents: 568 diff changeset	567
4902 03bbd33bc084 docs: rework stuff Mads Kiilerich <madski@unity3d.com> parents: 4848 diff changeset	568 upstream kallithea {
1745 456e1e3ce4eb fixes #305 User guide suggests sub-optimal nginx configuration Marcin Kuzminski <marcin@python-works.com> parents: 1657 diff changeset	569 server 127.0.0.1:5000;
456e1e3ce4eb fixes #305 User guide suggests sub-optimal nginx configuration Marcin Kuzminski <marcin@python-works.com> parents: 1657 diff changeset	570 # add more instances for load balancing
456e1e3ce4eb fixes #305 User guide suggests sub-optimal nginx configuration Marcin Kuzminski <marcin@python-works.com> parents: 1657 diff changeset	571 #server 127.0.0.1:5001;
456e1e3ce4eb fixes #305 User guide suggests sub-optimal nginx configuration Marcin Kuzminski <marcin@python-works.com> parents: 1657 diff changeset	572 #server 127.0.0.1:5002;
456e1e3ce4eb fixes #305 User guide suggests sub-optimal nginx configuration Marcin Kuzminski <marcin@python-works.com> parents: 1657 diff changeset	573 }
3224 8b8edfc25856 whitespace cleanup Marcin Kuzminski <marcin@python-works.com> parents: 2916 diff changeset	574
3850 7a4df261a375 added alias configuration option for gists. Marcin Kuzminski <marcin@python-works.com> parents: 3801 diff changeset	575 ## gist alias
7a4df261a375 added alias configuration option for gists. Marcin Kuzminski <marcin@python-works.com> parents: 3801 diff changeset	576 server {
7a4df261a375 added alias configuration option for gists. Marcin Kuzminski <marcin@python-works.com> parents: 3801 diff changeset	577 listen 443;
7a4df261a375 added alias configuration option for gists. Marcin Kuzminski <marcin@python-works.com> parents: 3801 diff changeset	578 server_name gist.myserver.com;
7a4df261a375 added alias configuration option for gists. Marcin Kuzminski <marcin@python-works.com> parents: 3801 diff changeset	579 access_log /var/log/nginx/gist.access.log;
7a4df261a375 added alias configuration option for gists. Marcin Kuzminski <marcin@python-works.com> parents: 3801 diff changeset	580 error_log /var/log/nginx/gist.error.log;
7a4df261a375 added alias configuration option for gists. Marcin Kuzminski <marcin@python-works.com> parents: 3801 diff changeset	581
7a4df261a375 added alias configuration option for gists. Marcin Kuzminski <marcin@python-works.com> parents: 3801 diff changeset	582 ssl on;
4182 05cabd91f7c3 Change example URL Bradley M. Kuhn <bkuhn@sfconservancy.org> parents: 4180 diff changeset	583 ssl_certificate gist.your.kallithea.server.crt;
05cabd91f7c3 Change example URL Bradley M. Kuhn <bkuhn@sfconservancy.org> parents: 4180 diff changeset	584 ssl_certificate_key gist.your.kallithea.server.key;
3850 7a4df261a375 added alias configuration option for gists. Marcin Kuzminski <marcin@python-works.com> parents: 3801 diff changeset	585
7a4df261a375 added alias configuration option for gists. Marcin Kuzminski <marcin@python-works.com> parents: 3801 diff changeset	586 ssl_session_timeout 5m;
7a4df261a375 added alias configuration option for gists. Marcin Kuzminski <marcin@python-works.com> parents: 3801 diff changeset	587
7a4df261a375 added alias configuration option for gists. Marcin Kuzminski <marcin@python-works.com> parents: 3801 diff changeset	588 ssl_protocols SSLv3 TLSv1;
7a4df261a375 added alias configuration option for gists. Marcin Kuzminski <marcin@python-works.com> parents: 3801 diff changeset	589 ssl_ciphers DHE-RSA-AES256-SHA:DHE-RSA-AES128-SHA:EDH-RSA-DES-CBC3-SHA:AES256-SHA:DES-CBC3-SHA:AES128-SHA:RC4-SHA:RC4-MD5;
7a4df261a375 added alias configuration option for gists. Marcin Kuzminski <marcin@python-works.com> parents: 3801 diff changeset	590 ssl_prefer_server_ciphers on;
7a4df261a375 added alias configuration option for gists. Marcin Kuzminski <marcin@python-works.com> parents: 3801 diff changeset	591
4182 05cabd91f7c3 Change example URL Bradley M. Kuhn <bkuhn@sfconservancy.org> parents: 4180 diff changeset	592 rewrite ^/(.+)$ https://your.kallithea.server/_admin/gists/$1;
05cabd91f7c3 Change example URL Bradley M. Kuhn <bkuhn@sfconservancy.org> parents: 4180 diff changeset	593 rewrite (.*) https://your.kallithea.server/_admin/gists;
3850 7a4df261a375 added alias configuration option for gists. Marcin Kuzminski <marcin@python-works.com> parents: 3801 diff changeset	594 }
7a4df261a375 added alias configuration option for gists. Marcin Kuzminski <marcin@python-works.com> parents: 3801 diff changeset	595
1092 8af52e1224ff merge docs in beta with those corrected by Jason Harris Marcin Kuzminski <marcin@python-works.com> parents: 1062 diff changeset	596 server {
3243 c759c0912642 switch to SSL configuration example on nginx Marcin Kuzminski <marcin@python-works.com> parents: 3224 diff changeset	597 listen 443;
4182 05cabd91f7c3 Change example URL Bradley M. Kuhn <bkuhn@sfconservancy.org> parents: 4180 diff changeset	598 server_name your.kallithea.server;
4192 e73a69cb98dc Rename some strings examples and commands in documentation Bradley M. Kuhn <bkuhn@sfconservancy.org> parents: 4186 diff changeset	599 access_log /var/log/nginx/kallithea.access.log;
e73a69cb98dc Rename some strings examples and commands in documentation Bradley M. Kuhn <bkuhn@sfconservancy.org> parents: 4186 diff changeset	600 error_log /var/log/nginx/kallithea.error.log;
1745 456e1e3ce4eb fixes #305 User guide suggests sub-optimal nginx configuration Marcin Kuzminski <marcin@python-works.com> parents: 1657 diff changeset	601
3243 c759c0912642 switch to SSL configuration example on nginx Marcin Kuzminski <marcin@python-works.com> parents: 3224 diff changeset	602 ssl on;
4182 05cabd91f7c3 Change example URL Bradley M. Kuhn <bkuhn@sfconservancy.org> parents: 4180 diff changeset	603 ssl_certificate your.kallithea.server.crt;
05cabd91f7c3 Change example URL Bradley M. Kuhn <bkuhn@sfconservancy.org> parents: 4180 diff changeset	604 ssl_certificate_key your.kallithea.server.key;
3243 c759c0912642 switch to SSL configuration example on nginx Marcin Kuzminski <marcin@python-works.com> parents: 3224 diff changeset	605
c759c0912642 switch to SSL configuration example on nginx Marcin Kuzminski <marcin@python-works.com> parents: 3224 diff changeset	606 ssl_session_timeout 5m;
c759c0912642 switch to SSL configuration example on nginx Marcin Kuzminski <marcin@python-works.com> parents: 3224 diff changeset	607
c759c0912642 switch to SSL configuration example on nginx Marcin Kuzminski <marcin@python-works.com> parents: 3224 diff changeset	608 ssl_protocols SSLv3 TLSv1;
c759c0912642 switch to SSL configuration example on nginx Marcin Kuzminski <marcin@python-works.com> parents: 3224 diff changeset	609 ssl_ciphers DHE-RSA-AES256-SHA:DHE-RSA-AES128-SHA:EDH-RSA-DES-CBC3-SHA:AES256-SHA:DES-CBC3-SHA:AES128-SHA:RC4-SHA:RC4-MD5;
c759c0912642 switch to SSL configuration example on nginx Marcin Kuzminski <marcin@python-works.com> parents: 3224 diff changeset	610 ssl_prefer_server_ciphers on;
c759c0912642 switch to SSL configuration example on nginx Marcin Kuzminski <marcin@python-works.com> parents: 3224 diff changeset	611
3850 7a4df261a375 added alias configuration option for gists. Marcin Kuzminski <marcin@python-works.com> parents: 3801 diff changeset	612 ## uncomment root directive if you want to serve static files by nginx
7a4df261a375 added alias configuration option for gists. Marcin Kuzminski <marcin@python-works.com> parents: 3801 diff changeset	613 ## requires static_files = false in .ini file
4186 7e5f8c12a3fc First step in two-part process to rename directories to kallithea. Bradley M. Kuhn <bkuhn@sfconservancy.org> parents: 4185 diff changeset	614 #root /path/to/installation/kallithea/public;
3917 35c0c62583cd Moved proxy include of nginx to place where Marcin Kuzminski <marcin@python-works.com> parents: 3852 diff changeset	615 include /etc/nginx/proxy.conf;
1092 8af52e1224ff merge docs in beta with those corrected by Jason Harris Marcin Kuzminski <marcin@python-works.com> parents: 1062 diff changeset	616 location / {
4902 03bbd33bc084 docs: rework stuff Mads Kiilerich <madski@unity3d.com> parents: 4848 diff changeset	617 try_files $uri @kallithea;
1092 8af52e1224ff merge docs in beta with those corrected by Jason Harris Marcin Kuzminski <marcin@python-works.com> parents: 1062 diff changeset	618 }
3224 8b8edfc25856 whitespace cleanup Marcin Kuzminski <marcin@python-works.com> parents: 2916 diff changeset	619
4902 03bbd33bc084 docs: rework stuff Mads Kiilerich <madski@unity3d.com> parents: 4848 diff changeset	620 location @kallithea {
03bbd33bc084 docs: rework stuff Mads Kiilerich <madski@unity3d.com> parents: 4848 diff changeset	621 proxy_pass http://kallithea;
1745 456e1e3ce4eb fixes #305 User guide suggests sub-optimal nginx configuration Marcin Kuzminski <marcin@python-works.com> parents: 1657 diff changeset	622 }
456e1e3ce4eb fixes #305 User guide suggests sub-optimal nginx configuration Marcin Kuzminski <marcin@python-works.com> parents: 1657 diff changeset	623
3224 8b8edfc25856 whitespace cleanup Marcin Kuzminski <marcin@python-works.com> parents: 2916 diff changeset	624 }
8b8edfc25856 whitespace cleanup Marcin Kuzminski <marcin@python-works.com> parents: 2916 diff changeset	625
1092 8af52e1224ff merge docs in beta with those corrected by Jason Harris Marcin Kuzminski <marcin@python-works.com> parents: 1062 diff changeset	626 Here's the proxy.conf. It's tuned so it will not timeout on long
8af52e1224ff merge docs in beta with those corrected by Jason Harris Marcin Kuzminski <marcin@python-works.com> parents: 1062 diff changeset	627 pushes or large pushes::
3224 8b8edfc25856 whitespace cleanup Marcin Kuzminski <marcin@python-works.com> parents: 2916 diff changeset	628
572 a60cd29ba7e2 more docs update Marcin Kuzminski <marcin@python-works.com> parents: 568 diff changeset	629 proxy_redirect off;
a60cd29ba7e2 more docs update Marcin Kuzminski <marcin@python-works.com> parents: 568 diff changeset	630 proxy_set_header Host $host;
4073 2c82dd8ba318 Added two headers into example nginx proxy conf that allows container auth Marcin Kuzminski <marcin@python-works.com> parents: 3960 diff changeset	631 ## needed for container auth
2c82dd8ba318 Added two headers into example nginx proxy conf that allows container auth Marcin Kuzminski <marcin@python-works.com> parents: 3960 diff changeset	632 #proxy_set_header REMOTE_USER $remote_user;
2c82dd8ba318 Added two headers into example nginx proxy conf that allows container auth Marcin Kuzminski <marcin@python-works.com> parents: 3960 diff changeset	633 #proxy_set_header X-Forwarded-User $remote_user;
1745 456e1e3ce4eb fixes #305 User guide suggests sub-optimal nginx configuration Marcin Kuzminski <marcin@python-works.com> parents: 1657 diff changeset	634 proxy_set_header X-Url-Scheme $scheme;
572 a60cd29ba7e2 more docs update Marcin Kuzminski <marcin@python-works.com> parents: 568 diff changeset	635 proxy_set_header X-Host $http_host;
a60cd29ba7e2 more docs update Marcin Kuzminski <marcin@python-works.com> parents: 568 diff changeset	636 proxy_set_header X-Real-IP $remote_addr;
a60cd29ba7e2 more docs update Marcin Kuzminski <marcin@python-works.com> parents: 568 diff changeset	637 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	638 proxy_set_header Proxy-host $proxy_host;
a60cd29ba7e2 more docs update Marcin Kuzminski <marcin@python-works.com> parents: 568 diff changeset	639 proxy_buffering off;
1420 a2fe0ac8d007 Updated nginx proxy example to work better with large pushes Marcin Kuzminski <marcin@python-works.com> parents: 1408 diff changeset	640 proxy_connect_timeout 7200;
a2fe0ac8d007 Updated nginx proxy example to work better with large pushes Marcin Kuzminski <marcin@python-works.com> parents: 1408 diff changeset	641 proxy_send_timeout 7200;
a2fe0ac8d007 Updated nginx proxy example to work better with large pushes Marcin Kuzminski <marcin@python-works.com> parents: 1408 diff changeset	642 proxy_read_timeout 7200;
a2fe0ac8d007 Updated nginx proxy example to work better with large pushes Marcin Kuzminski <marcin@python-works.com> parents: 1408 diff changeset	643 proxy_buffers 8 32k;
3919 b367b016ee39 Added large_client_header_buffers directive into example nginx Marcin Kuzminski <marcin@python-works.com> parents: 3917 diff changeset	644 client_max_body_size 1024m;
b367b016ee39 Added large_client_header_buffers directive into example nginx Marcin Kuzminski <marcin@python-works.com> parents: 3917 diff changeset	645 client_body_buffer_size 128k;
b367b016ee39 Added large_client_header_buffers directive into example nginx Marcin Kuzminski <marcin@python-works.com> parents: 3917 diff changeset	646 large_client_header_buffers 8 64k;
3224 8b8edfc25856 whitespace cleanup Marcin Kuzminski <marcin@python-works.com> parents: 2916 diff changeset	647
881 68aaa0aca0d2 Updated docs, added apache proxy example config Marcin Kuzminski <marcin@python-works.com> parents: 871 diff changeset	648
1558 662173ba1846 Improvements to mod_wsgi setup documentation. Augusto Herrmann <augusto.herrmann@planejamento.gov.br> parents: 1467 diff changeset	649 Apache virtual host reverse proxy example
662173ba1846 Improvements to mod_wsgi setup documentation. Augusto Herrmann <augusto.herrmann@planejamento.gov.br> parents: 1467 diff changeset	650 -----------------------------------------
881 68aaa0aca0d2 Updated docs, added apache proxy example config Marcin Kuzminski <marcin@python-works.com> parents: 871 diff changeset	651
5425 5ae8e644aa88 docs: spelling, grammar, content and typography Søren Løvborg <sorenl@unity3d.com> parents: 5413 diff changeset	652 Here is a sample configuration file for Apache using proxy:
5ae8e644aa88 docs: spelling, grammar, content and typography Søren Løvborg <sorenl@unity3d.com> parents: 5413 diff changeset	653
5ae8e644aa88 docs: spelling, grammar, content and typography Søren Løvborg <sorenl@unity3d.com> parents: 5413 diff changeset	654 .. code-block:: apache
881 68aaa0aca0d2 Updated docs, added apache proxy example config Marcin Kuzminski <marcin@python-works.com> parents: 871 diff changeset	655
929 c44b3c9b9f7f doc fix Marcin Kuzminski <marcin@python-works.com> parents: 912 diff changeset	656 <VirtualHost *:80>
c44b3c9b9f7f doc fix Marcin Kuzminski <marcin@python-works.com> parents: 912 diff changeset	657 ServerName hg.myserver.com
c44b3c9b9f7f doc fix Marcin Kuzminski <marcin@python-works.com> parents: 912 diff changeset	658 ServerAlias hg.myserver.com
3224 8b8edfc25856 whitespace cleanup Marcin Kuzminski <marcin@python-works.com> parents: 2916 diff changeset	659
929 c44b3c9b9f7f doc fix Marcin Kuzminski <marcin@python-works.com> parents: 912 diff changeset	660 <Proxy *>
5425 5ae8e644aa88 docs: spelling, grammar, content and typography Søren Løvborg <sorenl@unity3d.com> parents: 5413 diff changeset	661 # For Apache 2.4 and later:
5ae8e644aa88 docs: spelling, grammar, content and typography Søren Løvborg <sorenl@unity3d.com> parents: 5413 diff changeset	662 Require all granted
5ae8e644aa88 docs: spelling, grammar, content and typography Søren Løvborg <sorenl@unity3d.com> parents: 5413 diff changeset	663
5ae8e644aa88 docs: spelling, grammar, content and typography Søren Løvborg <sorenl@unity3d.com> parents: 5413 diff changeset	664 # For Apache 2.2 and earlier, instead use:
5ae8e644aa88 docs: spelling, grammar, content and typography Søren Løvborg <sorenl@unity3d.com> parents: 5413 diff changeset	665 # Order allow,deny
5ae8e644aa88 docs: spelling, grammar, content and typography Søren Løvborg <sorenl@unity3d.com> parents: 5413 diff changeset	666 # Allow from all
929 c44b3c9b9f7f doc fix Marcin Kuzminski <marcin@python-works.com> parents: 912 diff changeset	667 </Proxy>
3224 8b8edfc25856 whitespace cleanup Marcin Kuzminski <marcin@python-works.com> parents: 2916 diff changeset	668
929 c44b3c9b9f7f doc fix Marcin Kuzminski <marcin@python-works.com> parents: 912 diff changeset	669 #important !
c44b3c9b9f7f doc fix Marcin Kuzminski <marcin@python-works.com> parents: 912 diff changeset	670 #Directive to properly generate url (clone url) for pylons
c44b3c9b9f7f doc fix Marcin Kuzminski <marcin@python-works.com> parents: 912 diff changeset	671 ProxyPreserveHost On
3224 8b8edfc25856 whitespace cleanup Marcin Kuzminski <marcin@python-works.com> parents: 2916 diff changeset	672
4192 e73a69cb98dc Rename some strings examples and commands in documentation Bradley M. Kuhn <bkuhn@sfconservancy.org> parents: 4186 diff changeset	673 #kallithea instance
929 c44b3c9b9f7f doc fix Marcin Kuzminski <marcin@python-works.com> parents: 912 diff changeset	674 ProxyPass / http://127.0.0.1:5000/
c44b3c9b9f7f doc fix Marcin Kuzminski <marcin@python-works.com> parents: 912 diff changeset	675 ProxyPassReverse / http://127.0.0.1:5000/
3224 8b8edfc25856 whitespace cleanup Marcin Kuzminski <marcin@python-works.com> parents: 2916 diff changeset	676
929 c44b3c9b9f7f doc fix Marcin Kuzminski <marcin@python-works.com> parents: 912 diff changeset	677 #to enable https use line below
c44b3c9b9f7f doc fix Marcin Kuzminski <marcin@python-works.com> parents: 912 diff changeset	678 #SetEnvIf X-Url-Scheme https HTTPS=1
3224 8b8edfc25856 whitespace cleanup Marcin Kuzminski <marcin@python-works.com> parents: 2916 diff changeset	679 </VirtualHost>
881 68aaa0aca0d2 Updated docs, added apache proxy example config Marcin Kuzminski <marcin@python-works.com> parents: 871 diff changeset	680
68aaa0aca0d2 Updated docs, added apache proxy example config Marcin Kuzminski <marcin@python-works.com> parents: 871 diff changeset	681
68aaa0aca0d2 Updated docs, added apache proxy example config Marcin Kuzminski <marcin@python-works.com> parents: 871 diff changeset	682 Additional tutorial
4915 6892b0515af9 docs: replace a dead link to the pylons cookbook Andrew Shadura <andrew@shadura.me> parents: 4914 diff changeset	683 http://pylonsbook.com/en/1.1/deployment.html#using-apache-to-proxy-requests-to-pylons
572 a60cd29ba7e2 more docs update Marcin Kuzminski <marcin@python-works.com> parents: 568 diff changeset	684
707 1105531ae572 docs update, added ldap section, added troubleshooting section Marcin Kuzminski <marcin@python-works.com> parents: 683 diff changeset	685
1062 053983a464e4 docs and readme update Marcin Kuzminski <marcin@python-works.com> parents: 992 diff changeset	686 Apache as subdirectory
053983a464e4 docs and readme update Marcin Kuzminski <marcin@python-works.com> parents: 992 diff changeset	687 ----------------------
053983a464e4 docs and readme update Marcin Kuzminski <marcin@python-works.com> parents: 992 diff changeset	688
5425 5ae8e644aa88 docs: spelling, grammar, content and typography Søren Løvborg <sorenl@unity3d.com> parents: 5413 diff changeset	689 Apache subdirectory part:
5ae8e644aa88 docs: spelling, grammar, content and typography Søren Løvborg <sorenl@unity3d.com> parents: 5413 diff changeset	690
5ae8e644aa88 docs: spelling, grammar, content and typography Søren Løvborg <sorenl@unity3d.com> parents: 5413 diff changeset	691 .. code-block:: apache
1062 053983a464e4 docs and readme update Marcin Kuzminski <marcin@python-works.com> parents: 992 diff changeset	692
1226 f17fdbe86ab9 update docs for setup Marcin Kuzminski <marcin@python-works.com> parents: 1123 diff changeset	693 <Location /<someprefix> >
f17fdbe86ab9 update docs for setup Marcin Kuzminski <marcin@python-works.com> parents: 1123 diff changeset	694 ProxyPass http://127.0.0.1:5000/<someprefix>
f17fdbe86ab9 update docs for setup Marcin Kuzminski <marcin@python-works.com> parents: 1123 diff changeset	695 ProxyPassReverse http://127.0.0.1:5000/<someprefix>
1062 053983a464e4 docs and readme update Marcin Kuzminski <marcin@python-works.com> parents: 992 diff changeset	696 SetEnvIf X-Url-Scheme https HTTPS=1
3224 8b8edfc25856 whitespace cleanup Marcin Kuzminski <marcin@python-works.com> parents: 2916 diff changeset	697 </Location>
1062 053983a464e4 docs and readme update Marcin Kuzminski <marcin@python-works.com> parents: 992 diff changeset	698
1392 00b8fca6886c fixes issue #206 Marcin Kuzminski <marcin@python-works.com> parents: 1386 diff changeset	699 Besides the regular apache setup you will need to add the following line
4955 4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4925 diff changeset	700 into ``[app:main]`` section of your .ini file::
1062 053983a464e4 docs and readme update Marcin Kuzminski <marcin@python-works.com> parents: 992 diff changeset	701
053983a464e4 docs and readme update Marcin Kuzminski <marcin@python-works.com> parents: 992 diff changeset	702 filter-with = proxy-prefix
053983a464e4 docs and readme update Marcin Kuzminski <marcin@python-works.com> parents: 992 diff changeset	703
053983a464e4 docs and readme update Marcin Kuzminski <marcin@python-works.com> parents: 992 diff changeset	704 Add the following at the end of the .ini file::
053983a464e4 docs and readme update Marcin Kuzminski <marcin@python-works.com> parents: 992 diff changeset	705
053983a464e4 docs and readme update Marcin Kuzminski <marcin@python-works.com> parents: 992 diff changeset	706 [filter:proxy-prefix]
053983a464e4 docs and readme update Marcin Kuzminski <marcin@python-works.com> parents: 992 diff changeset	707 use = egg:PasteDeploy#prefix
3224 8b8edfc25856 whitespace cleanup Marcin Kuzminski <marcin@python-works.com> parents: 2916 diff changeset	708 prefix = /<someprefix>
1062 053983a464e4 docs and readme update Marcin Kuzminski <marcin@python-works.com> parents: 992 diff changeset	709
053983a464e4 docs and readme update Marcin Kuzminski <marcin@python-works.com> parents: 992 diff changeset	710
4955 4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4925 diff changeset	711 then change ``<someprefix>`` into your chosen prefix
1226 f17fdbe86ab9 update docs for setup Marcin Kuzminski <marcin@python-works.com> parents: 1123 diff changeset	712
5425 5ae8e644aa88 docs: spelling, grammar, content and typography Søren Løvborg <sorenl@unity3d.com> parents: 5413 diff changeset	713 Apache with mod_wsgi
1386 5a31d387f347 Added example wsgi config into docs Marcin Kuzminski <marcin@python-works.com> parents: 1309 diff changeset	714 --------------------
5a31d387f347 Added example wsgi config into docs Marcin Kuzminski <marcin@python-works.com> parents: 1309 diff changeset	715
4192 e73a69cb98dc Rename some strings examples and commands in documentation Bradley M. Kuhn <bkuhn@sfconservancy.org> parents: 4186 diff changeset	716 Alternatively, Kallithea can be set up with Apache under mod_wsgi. For
1558 662173ba1846 Improvements to mod_wsgi setup documentation. Augusto Herrmann <augusto.herrmann@planejamento.gov.br> parents: 1467 diff changeset	717 that, you'll need to:
662173ba1846 Improvements to mod_wsgi setup documentation. Augusto Herrmann <augusto.herrmann@planejamento.gov.br> parents: 1467 diff changeset	718
662173ba1846 Improvements to mod_wsgi setup documentation. Augusto Herrmann <augusto.herrmann@planejamento.gov.br> parents: 1467 diff changeset	719 - Install mod_wsgi. If using a Debian-based distro, you can install
662173ba1846 Improvements to mod_wsgi setup documentation. Augusto Herrmann <augusto.herrmann@planejamento.gov.br> parents: 1467 diff changeset	720 the package libapache2-mod-wsgi::
1559 a9fef2e6c1ff Syntax correction on the recently changed documentation. Augusto Herrmann <augusto.herrmann@planejamento.gov.br> parents: 1558 diff changeset	721
1558 662173ba1846 Improvements to mod_wsgi setup documentation. Augusto Herrmann <augusto.herrmann@planejamento.gov.br> parents: 1467 diff changeset	722 aptitude install libapache2-mod-wsgi
1559 a9fef2e6c1ff Syntax correction on the recently changed documentation. Augusto Herrmann <augusto.herrmann@planejamento.gov.br> parents: 1558 diff changeset	723
1558 662173ba1846 Improvements to mod_wsgi setup documentation. Augusto Herrmann <augusto.herrmann@planejamento.gov.br> parents: 1467 diff changeset	724 - Enable mod_wsgi::
1559 a9fef2e6c1ff Syntax correction on the recently changed documentation. Augusto Herrmann <augusto.herrmann@planejamento.gov.br> parents: 1558 diff changeset	725
1558 662173ba1846 Improvements to mod_wsgi setup documentation. Augusto Herrmann <augusto.herrmann@planejamento.gov.br> parents: 1467 diff changeset	726 a2enmod wsgi
1559 a9fef2e6c1ff Syntax correction on the recently changed documentation. Augusto Herrmann <augusto.herrmann@planejamento.gov.br> parents: 1558 diff changeset	727
1558 662173ba1846 Improvements to mod_wsgi setup documentation. Augusto Herrmann <augusto.herrmann@planejamento.gov.br> parents: 1467 diff changeset	728 - Create a wsgi dispatch script, like the one below. Make sure you
4955 4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4925 diff changeset	729 check that the paths correctly point to where you installed Kallithea
1558 662173ba1846 Improvements to mod_wsgi setup documentation. Augusto Herrmann <augusto.herrmann@planejamento.gov.br> parents: 1467 diff changeset	730 and its Python Virtual Environment.
4955 4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4925 diff changeset	731 - Enable the ``WSGIScriptAlias`` directive for the WSGI dispatch script,
1558 662173ba1846 Improvements to mod_wsgi setup documentation. Augusto Herrmann <augusto.herrmann@planejamento.gov.br> parents: 1467 diff changeset	732 as in the following example. Once again, check the paths are
662173ba1846 Improvements to mod_wsgi setup documentation. Augusto Herrmann <augusto.herrmann@planejamento.gov.br> parents: 1467 diff changeset	733 correctly specified.
662173ba1846 Improvements to mod_wsgi setup documentation. Augusto Herrmann <augusto.herrmann@planejamento.gov.br> parents: 1467 diff changeset	734
5425 5ae8e644aa88 docs: spelling, grammar, content and typography Søren Løvborg <sorenl@unity3d.com> parents: 5413 diff changeset	735 Here is a sample excerpt from an Apache Virtual Host configuration file:
5ae8e644aa88 docs: spelling, grammar, content and typography Søren Løvborg <sorenl@unity3d.com> parents: 5413 diff changeset	736
5ae8e644aa88 docs: spelling, grammar, content and typography Søren Løvborg <sorenl@unity3d.com> parents: 5413 diff changeset	737
5ae8e644aa88 docs: spelling, grammar, content and typography Søren Løvborg <sorenl@unity3d.com> parents: 5413 diff changeset	738 .. code-block:: apache
1558 662173ba1846 Improvements to mod_wsgi setup documentation. Augusto Herrmann <augusto.herrmann@planejamento.gov.br> parents: 1467 diff changeset	739
4902 03bbd33bc084 docs: rework stuff Mads Kiilerich <madski@unity3d.com> parents: 4848 diff changeset	740 WSGIDaemonProcess kallithea \
03bbd33bc084 docs: rework stuff Mads Kiilerich <madski@unity3d.com> parents: 4848 diff changeset	741 processes=1 threads=4 \
03bbd33bc084 docs: rework stuff Mads Kiilerich <madski@unity3d.com> parents: 4848 diff changeset	742 python-path=/srv/kallithea/pyenv/lib/python2.7/site-packages
03bbd33bc084 docs: rework stuff Mads Kiilerich <madski@unity3d.com> parents: 4848 diff changeset	743 WSGIScriptAlias / /srv/kallithea/dispatch.wsgi
2076 77d215d6121f docs on apache WSGI update Marcin Kuzminski <marcin@python-works.com> parents: 2017 diff changeset	744 WSGIPassAuthorization On
1386 5a31d387f347 Added example wsgi config into docs Marcin Kuzminski <marcin@python-works.com> parents: 1309 diff changeset	745
5425 5ae8e644aa88 docs: spelling, grammar, content and typography Søren Løvborg <sorenl@unity3d.com> parents: 5413 diff changeset	746 Or if using a dispatcher WSGI script with proper virtualenv activation:
5ae8e644aa88 docs: spelling, grammar, content and typography Søren Løvborg <sorenl@unity3d.com> parents: 5413 diff changeset	747
5ae8e644aa88 docs: spelling, grammar, content and typography Søren Løvborg <sorenl@unity3d.com> parents: 5413 diff changeset	748 .. code-block:: apache
4902 03bbd33bc084 docs: rework stuff Mads Kiilerich <madski@unity3d.com> parents: 4848 diff changeset	749
03bbd33bc084 docs: rework stuff Mads Kiilerich <madski@unity3d.com> parents: 4848 diff changeset	750 WSGIDaemonProcess kallithea processes=1 threads=4
03bbd33bc084 docs: rework stuff Mads Kiilerich <madski@unity3d.com> parents: 4848 diff changeset	751 WSGIScriptAlias / /srv/kallithea/dispatch.wsgi
03bbd33bc084 docs: rework stuff Mads Kiilerich <madski@unity3d.com> parents: 4848 diff changeset	752 WSGIPassAuthorization On
03bbd33bc084 docs: rework stuff Mads Kiilerich <madski@unity3d.com> parents: 4848 diff changeset	753
03bbd33bc084 docs: rework stuff Mads Kiilerich <madski@unity3d.com> parents: 4848 diff changeset	754
2800 6540ee9179da updated apache wsgi example ref #535 Marcin Kuzminski <marcin@python-works.com> parents: 2748 diff changeset	755 .. note::
4902 03bbd33bc084 docs: rework stuff Mads Kiilerich <madski@unity3d.com> parents: 4848 diff changeset	756 When running apache as root, please make sure it doesn't run Kallithea as
4955 4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4925 diff changeset	757 root, for examply by adding: ``user=www-data group=www-data`` to the configuration.
2800 6540ee9179da updated apache wsgi example ref #535 Marcin Kuzminski <marcin@python-works.com> parents: 2748 diff changeset	758
6540ee9179da updated apache wsgi example ref #535 Marcin Kuzminski <marcin@python-works.com> parents: 2748 diff changeset	759 .. note::
4902 03bbd33bc084 docs: rework stuff Mads Kiilerich <madski@unity3d.com> parents: 4848 diff changeset	760 If running Kallithea in multiprocess mode,
4955 4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4925 diff changeset	761 make sure you set ``instance_id = *`` in the configuration so each process
4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4925 diff changeset	762 gets it's own cache invalidation key.
2800 6540ee9179da updated apache wsgi example ref #535 Marcin Kuzminski <marcin@python-works.com> parents: 2748 diff changeset	763
6540ee9179da updated apache wsgi example ref #535 Marcin Kuzminski <marcin@python-works.com> parents: 2748 diff changeset	764
5425 5ae8e644aa88 docs: spelling, grammar, content and typography Søren Løvborg <sorenl@unity3d.com> parents: 5413 diff changeset	765 Example WSGI dispatch script:
5ae8e644aa88 docs: spelling, grammar, content and typography Søren Løvborg <sorenl@unity3d.com> parents: 5413 diff changeset	766
5ae8e644aa88 docs: spelling, grammar, content and typography Søren Løvborg <sorenl@unity3d.com> parents: 5413 diff changeset	767 .. code-block:: python
707 1105531ae572 docs update, added ldap section, added troubleshooting section Marcin Kuzminski <marcin@python-works.com> parents: 683 diff changeset	768
1386 5a31d387f347 Added example wsgi config into docs Marcin Kuzminski <marcin@python-works.com> parents: 1309 diff changeset	769 import os
5a31d387f347 Added example wsgi config into docs Marcin Kuzminski <marcin@python-works.com> parents: 1309 diff changeset	770 os.environ["HGENCODING"] = "UTF-8"
4902 03bbd33bc084 docs: rework stuff Mads Kiilerich <madski@unity3d.com> parents: 4848 diff changeset	771 os.environ['PYTHON_EGG_CACHE'] = '/srv/kallithea/.egg-cache'
3224 8b8edfc25856 whitespace cleanup Marcin Kuzminski <marcin@python-works.com> parents: 2916 diff changeset	772
1386 5a31d387f347 Added example wsgi config into docs Marcin Kuzminski <marcin@python-works.com> parents: 1309 diff changeset	773 # sometimes it's needed to set the curent dir
4902 03bbd33bc084 docs: rework stuff Mads Kiilerich <madski@unity3d.com> parents: 4848 diff changeset	774 os.chdir('/srv/kallithea/')
1558 662173ba1846 Improvements to mod_wsgi setup documentation. Augusto Herrmann <augusto.herrmann@planejamento.gov.br> parents: 1467 diff changeset	775
662173ba1846 Improvements to mod_wsgi setup documentation. Augusto Herrmann <augusto.herrmann@planejamento.gov.br> parents: 1467 diff changeset	776 import site
4902 03bbd33bc084 docs: rework stuff Mads Kiilerich <madski@unity3d.com> parents: 4848 diff changeset	777 site.addsitedir("/srv/kallithea/pyenv/lib/python2.7/site-packages")
3224 8b8edfc25856 whitespace cleanup Marcin Kuzminski <marcin@python-works.com> parents: 2916 diff changeset	778
1386 5a31d387f347 Added example wsgi config into docs Marcin Kuzminski <marcin@python-works.com> parents: 1309 diff changeset	779 from paste.deploy import loadapp
5a31d387f347 Added example wsgi config into docs Marcin Kuzminski <marcin@python-works.com> parents: 1309 diff changeset	780 from paste.script.util.logging_config import fileConfig
5a31d387f347 Added example wsgi config into docs Marcin Kuzminski <marcin@python-works.com> parents: 1309 diff changeset	781
4902 03bbd33bc084 docs: rework stuff Mads Kiilerich <madski@unity3d.com> parents: 4848 diff changeset	782 fileConfig('/srv/kallithea/my.ini')
03bbd33bc084 docs: rework stuff Mads Kiilerich <madski@unity3d.com> parents: 4848 diff changeset	783 application = loadapp('config:/srv/kallithea/my.ini')
03bbd33bc084 docs: rework stuff Mads Kiilerich <madski@unity3d.com> parents: 4848 diff changeset	784
5425 5ae8e644aa88 docs: spelling, grammar, content and typography Søren Løvborg <sorenl@unity3d.com> parents: 5413 diff changeset	785 Or using proper virtualenv activation:
5ae8e644aa88 docs: spelling, grammar, content and typography Søren Løvborg <sorenl@unity3d.com> parents: 5413 diff changeset	786
5ae8e644aa88 docs: spelling, grammar, content and typography Søren Løvborg <sorenl@unity3d.com> parents: 5413 diff changeset	787 .. code-block:: python
4902 03bbd33bc084 docs: rework stuff Mads Kiilerich <madski@unity3d.com> parents: 4848 diff changeset	788
03bbd33bc084 docs: rework stuff Mads Kiilerich <madski@unity3d.com> parents: 4848 diff changeset	789 activate_this = '/srv/kallithea/venv/bin/activate_this.py'
5425 5ae8e644aa88 docs: spelling, grammar, content and typography Søren Løvborg <sorenl@unity3d.com> parents: 5413 diff changeset	790 execfile(activate_this, dict(__file__=activate_this))
1386 5a31d387f347 Added example wsgi config into docs Marcin Kuzminski <marcin@python-works.com> parents: 1309 diff changeset	791
4902 03bbd33bc084 docs: rework stuff Mads Kiilerich <madski@unity3d.com> parents: 4848 diff changeset	792 import os
03bbd33bc084 docs: rework stuff Mads Kiilerich <madski@unity3d.com> parents: 4848 diff changeset	793 os.environ['HOME'] = '/srv/kallithea'
03bbd33bc084 docs: rework stuff Mads Kiilerich <madski@unity3d.com> parents: 4848 diff changeset	794
03bbd33bc084 docs: rework stuff Mads Kiilerich <madski@unity3d.com> parents: 4848 diff changeset	795 ini = '/srv/kallithea/kallithea.ini'
03bbd33bc084 docs: rework stuff Mads Kiilerich <madski@unity3d.com> parents: 4848 diff changeset	796 from paste.script.util.logging_config import fileConfig
03bbd33bc084 docs: rework stuff Mads Kiilerich <madski@unity3d.com> parents: 4848 diff changeset	797 fileConfig(ini)
03bbd33bc084 docs: rework stuff Mads Kiilerich <madski@unity3d.com> parents: 4848 diff changeset	798 from paste.deploy import loadapp
03bbd33bc084 docs: rework stuff Mads Kiilerich <madski@unity3d.com> parents: 4848 diff changeset	799 application = loadapp('config:' + ini)
1558 662173ba1846 Improvements to mod_wsgi setup documentation. Augusto Herrmann <augusto.herrmann@planejamento.gov.br> parents: 1467 diff changeset	800
707 1105531ae572 docs update, added ldap section, added troubleshooting section Marcin Kuzminski <marcin@python-works.com> parents: 683 diff changeset	801
591 1e2adb37cab6 docs update Marcin Kuzminski <marcin@python-works.com> parents: 572 diff changeset	802 Other configuration files
1e2adb37cab6 docs update Marcin Kuzminski <marcin@python-works.com> parents: 572 diff changeset	803 -------------------------
1e2adb37cab6 docs update Marcin Kuzminski <marcin@python-works.com> parents: 572 diff changeset	804
5425 5ae8e644aa88 docs: spelling, grammar, content and typography Søren Løvborg <sorenl@unity3d.com> parents: 5413 diff changeset	805 A number of `example init.d scripts`__ can be found in
5ae8e644aa88 docs: spelling, grammar, content and typography Søren Løvborg <sorenl@unity3d.com> parents: 5413 diff changeset	806 the ``init.d`` directory of the Kallithea source.
5ae8e644aa88 docs: spelling, grammar, content and typography Søren Løvborg <sorenl@unity3d.com> parents: 5413 diff changeset	807
5ae8e644aa88 docs: spelling, grammar, content and typography Søren Løvborg <sorenl@unity3d.com> parents: 5413 diff changeset	808 .. __: https://kallithea-scm.org/repos/kallithea/files/tip/init.d/ .
591 1e2adb37cab6 docs update Marcin Kuzminski <marcin@python-works.com> parents: 572 diff changeset	809
572 a60cd29ba7e2 more docs update Marcin Kuzminski <marcin@python-works.com> parents: 568 diff changeset	810 .. _virtualenv: http://pypi.python.org/pypi/virtualenv
a60cd29ba7e2 more docs update Marcin Kuzminski <marcin@python-works.com> parents: 568 diff changeset	811 .. _python: http://www.python.org/
4914 95fe05b1e5f8 docs: better capitalisation Andrew Shadura <andrew@shadura.me> parents: 4902 diff changeset	812 .. _Mercurial: http://mercurial.selenic.com/
4925 56cd202b777e docs: move all instructions on Celery to Setup Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> parents: 4915 diff changeset	813 .. _Celery: http://celeryproject.org/
56cd202b777e docs: move all instructions on Celery to Setup Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> parents: 4915 diff changeset	814 .. _Celery documentation: http://docs.celeryproject.org/en/latest/getting-started/index.html
56cd202b777e docs: move all instructions on Celery to Setup Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> parents: 4915 diff changeset	815 .. _RabbitMQ: http://www.rabbitmq.com/
56cd202b777e docs: move all instructions on Celery to Setup Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> parents: 4915 diff changeset	816 .. _Redis: http://redis.io/
992 c03d16787b5c Update documentation for LDAP settings (and add Active Directory information). Thayne Harbaugh <thayne@fusionio.com> parents: 968 diff changeset	817 .. _python-ldap: http://www.python-ldap.org/
1092 8af52e1224ff merge docs in beta with those corrected by Jason Harris Marcin Kuzminski <marcin@python-works.com> parents: 1062 diff changeset	818 .. _mercurial-server: http://www.lshift.net/mercurial-server.html
8af52e1224ff merge docs in beta with those corrected by Jason Harris Marcin Kuzminski <marcin@python-works.com> parents: 1062 diff changeset	819 .. _PublishingRepositories: http://mercurial.selenic.com/wiki/PublishingRepositories

Mercurial > kallithea

annotate docs/setup.rst @ 5425:5ae8e644aa88