Files
@ 190cb30841de
Branch filter:
Location: kallithea/docs/installation.rst
190cb30841de
5.0 KiB
text/prs.fallenstein.rst
branches: fix performance of branch selectors with many branches - only show the first 200 results
The way we use select2, it will cause browser performance problems when a
select list contains thousands of entries. The primary bottleneck is the DOM
creation, secondarily for the query to filter through the entries and decide
what to show. We thus primarily have to limit how many entries we put in the
drop-down, secondarily limit the iteration over data.
One tricky case is where the user specifies a short but full branch name (like
'trunk') but many other branches contains the same string (not necessarily at
the beginning, like 'for-trunk-next-week') which come before the perfect match
in the branch list. It is thus not a solution to just stop searching when a
fixed amount of matches have been found.
Instead, we limit the amount of ordinary query matches, but always show all
prefix matches. We thus always have to iterate through all entries, but we
start using the (presumably) cheaper prefix search when the limit has been
reached.
There is no filtering initially when there is no query term, so that case has
to be handled specially.
Upstream select2 is now at 4.x. Upgrading is not trivial, and getting this
fixed properly upstream is not a short term solution. Instead, we customize our
copy. The benefit from this patch is bigger than the overhead of "maintaining"
it locally.
The way we use select2, it will cause browser performance problems when a
select list contains thousands of entries. The primary bottleneck is the DOM
creation, secondarily for the query to filter through the entries and decide
what to show. We thus primarily have to limit how many entries we put in the
drop-down, secondarily limit the iteration over data.
One tricky case is where the user specifies a short but full branch name (like
'trunk') but many other branches contains the same string (not necessarily at
the beginning, like 'for-trunk-next-week') which come before the perfect match
in the branch list. It is thus not a solution to just stop searching when a
fixed amount of matches have been found.
Instead, we limit the amount of ordinary query matches, but always show all
prefix matches. We thus always have to iterate through all entries, but we
start using the (presumably) cheaper prefix search when the limit has been
reached.
There is no filtering initially when there is no query term, so that case has
to be handled specially.
Upstream select2 is now at 4.x. Upgrading is not trivial, and getting this
fixed properly upstream is not a short term solution. Instead, we customize our
copy. The benefit from this patch is bigger than the overhead of "maintaining"
it locally.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 | .. _installation:
==========================
Installation on Unix/Linux
==========================
The following describes three different ways of installing Kallithea:
- :ref:`installation-source`: The simplest way to keep the installation
up-to-date and track any local customizations is to run directly from
source in a Kallithea repository clone, preferably inside a virtualenv
virtual Python environment.
- :ref:`installation-virtualenv`: If you prefer to only use released versions
of Kallithea, the recommended method is to install Kallithea in a virtual
Python environment using `virtualenv`. The advantages of this method over
direct installation is that Kallithea and its dependencies are completely
contained inside the virtualenv (which also means you can have multiple
installations side by side or remove it entirely by just removing the
virtualenv directory) and does not require root privileges.
- :ref:`installation-without-virtualenv`: The alternative method of installing
a Kallithea release is using standard pip. The package will be installed in
the same location as all other Python packages you have ever installed. As a
result, removing it is not as straightforward as with a virtualenv, as you'd
have to remove its dependencies manually and make sure that they are not
needed by other packages.
Regardless of the installation method you may need to make sure you have
appropriate development packages installed, as installation of some of the
Kallithea dependencies requires a working C compiler and libffi library
headers. Depending on your configuration, you may also need to install
Git and development packages for the database of your choice.
For Debian and Ubuntu, the following command will ensure that a reasonable
set of dependencies is installed::
sudo apt-get install build-essential git python-pip python-virtualenv libffi-dev python-dev
For Fedora and RHEL-derivatives, the following command will ensure that a
reasonable set of dependencies is installed::
sudo yum install gcc git python-pip python-virtualenv libffi-devel python-devel
.. _installation-source:
Installation from repository source
-----------------------------------
To install Kallithea in a virtualenv_ using the stable branch of the development
repository, follow the instructions below::
hg clone https://kallithea-scm.org/repos/kallithea -u stable
cd kallithea
virtualenv ../kallithea-venv
. ../kallithea-venv/bin/activate
pip install --upgrade pip setuptools
pip install -e .
python2 setup.py compile_catalog # for translation of the UI
You can now proceed to :ref:`setup`.
.. _installation-virtualenv:
Installing a released version in a virtualenv
---------------------------------------------
It is highly recommended to use a separate virtualenv_ for installing Kallithea.
This way, all libraries required by Kallithea will be installed separately from your
main Python installation and other applications and things will be less
problematic when upgrading the system or Kallithea.
An additional benefit of virtualenv_ is that it doesn't require root privileges.
- Assuming you have installed virtualenv_, create a new virtual environment
for example, in `/srv/kallithea/venv`, using the virtualenv command::
virtualenv /srv/kallithea/venv
- Activate the virtualenv_ in your current shell session and make sure the
basic requirements are up-to-date by running::
. /srv/kallithea/venv/bin/activate
pip install --upgrade pip setuptools
.. note:: You can't use UNIX ``sudo`` to source the ``virtualenv`` script; it
will "activate" a shell that terminates immediately. It is also perfectly
acceptable (and desirable) to create a virtualenv as a normal user.
.. note:: Some dependencies are optional. If you need them, install them in
the virtualenv too::
pip install psycopg2
pip install python-ldap
This might require installation of development packages using your
distribution's package manager.
- Make a folder for Kallithea data files, and configuration somewhere on the
filesystem. For example::
mkdir /srv/kallithea
- Go into the created directory and run this command to install Kallithea::
pip install kallithea
Alternatively, download a .tar.gz from http://pypi.python.org/pypi/Kallithea,
extract it and run::
pip install .
- This will install Kallithea together with pylons_ and all other required
python libraries into the activated virtualenv.
You can now proceed to :ref:`setup`.
.. _installation-without-virtualenv:
Installing a released version without virtualenv
------------------------------------------------
For installation without virtualenv, 'just' use::
pip install kallithea
Note that this method requires root privileges and will install packages
globally without using the system's package manager.
To install as a regular user in ``~/.local``, you can use::
pip install --user kallithea
You can now proceed to :ref:`setup`.
.. _virtualenv: http://pypi.python.org/pypi/virtualenv
.. _pylons: http://www.pylonsproject.org/
|