kallithea Changeset - 7982eac0703d

Changeset - 7982eac0703d

Parent rev.

Child rev.

[Not reviewed]

default

0 1 0

Mads Kiilerich (mads) - 5 years ago 2020-09-03 15:05:44
mads@kiilerich.com

Grafted from: 8d0d71623d01

docs: drop documentation for installing without virtualenv

Installing globally as root require an unjustified trust in our build/install
process ... and makes it very hard to uninstall or clean up.

Installing as a user is slightly better but also more error-prone and not
recommended.

Those who really want to do it and know how to do it also don't need this
description.

1 file changed with 6 insertions and 27 deletions:

docs/installation.rst

0 comments (0 inline, 0 general)

docs/installation.rst

➞

Show inline comments

@@ @@ -10,30 +10,30 @@ The following describes three different @@
   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.
 - Kallithea can also be installed with plain pip - globally or with ``--user``
   or similar. 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. We recommend using virtualenv.
 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 libffi-dev python3-dev
@@ @@ -116,45 +116,24 @@ An additional benefit of virtualenv is t @@
    distribution's package manager.
    Alternatively, download a .tar.gz from http://pypi.python.org/pypi/Kallithea,
    extract it and install from source by running::
      pip install --upgrade .
 - This will install Kallithea together with all other required
   Python libraries into the activated virtualenv.
 You can now proceed to :ref:`install-front-end`.
 .. _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:`install-front-end`.
 .. _install-front-end:
 Prepare front-end files
 -----------------------
 Finally, the front-end files with CSS and JavaScript must be prepared. This
 depends on having some commands available in the shell search path: ``npm``
 version 6 or later, and ``node.js`` (version 12 or later) available as
 ``node``. The installation method for these dependencies varies between
 operating systems and distributions.
 Prepare the front-end by running::

0 comments (0 inline, 0 general)