annotate docs/overview.rst @ 8829:01cb988e82a5

celery: celery-run should only initialize app and sqlalchemy after workers have been forked If app and SqlAlchemy were initialized before launching celery, the forked workers would inherit the database connection ... and that doesn't work. This could be handled by disposing the engine after forking the worker or before each task ... but it remains unnecessary and wrong to initialize the engine early when it isn't used, and then fork it.
author Mads Kiilerich <mads@kiilerich.com>
date Fri, 01 Jan 2021 18:04:16 +0100
parents c819a1e9103b
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
5081
154becd92f40 docs: add installation overview section
Mads Kiilerich <madski@unity3d.com>
parents:
diff changeset
1 .. _overview:
154becd92f40 docs: add installation overview section
Mads Kiilerich <madski@unity3d.com>
parents:
diff changeset
2
154becd92f40 docs: add installation overview section
Mads Kiilerich <madski@unity3d.com>
parents:
diff changeset
3 =====================
5413
22a3fa3c4254 docs: cleanup of casing, markup and spacing of headings
Mads Kiilerich <madski@unity3d.com>
parents: 5081
diff changeset
4 Installation overview
5081
154becd92f40 docs: add installation overview section
Mads Kiilerich <madski@unity3d.com>
parents:
diff changeset
5 =====================
154becd92f40 docs: add installation overview section
Mads Kiilerich <madski@unity3d.com>
parents:
diff changeset
6
154becd92f40 docs: add installation overview section
Mads Kiilerich <madski@unity3d.com>
parents:
diff changeset
7 Some overview and some details that can help understanding the options when
154becd92f40 docs: add installation overview section
Mads Kiilerich <madski@unity3d.com>
parents:
diff changeset
8 installing Kallithea.
154becd92f40 docs: add installation overview section
Mads Kiilerich <madski@unity3d.com>
parents:
diff changeset
9
8427
d59cb6068e55 docs: clarify the installation steps and how things fit together
Mads Kiilerich <mads@kiilerich.com>
parents: 8209
diff changeset
10 1. **Prepare environment and external dependencies.**
d59cb6068e55 docs: clarify the installation steps and how things fit together
Mads Kiilerich <mads@kiilerich.com>
parents: 8209
diff changeset
11 Kallithea needs:
d59cb6068e55 docs: clarify the installation steps and how things fit together
Mads Kiilerich <mads@kiilerich.com>
parents: 8209
diff changeset
12
d59cb6068e55 docs: clarify the installation steps and how things fit together
Mads Kiilerich <mads@kiilerich.com>
parents: 8209
diff changeset
13 * A filesystem where the Mercurial and Git repositories can be stored.
d59cb6068e55 docs: clarify the installation steps and how things fit together
Mads Kiilerich <mads@kiilerich.com>
parents: 8209
diff changeset
14 * A database where meta data can be stored.
d59cb6068e55 docs: clarify the installation steps and how things fit together
Mads Kiilerich <mads@kiilerich.com>
parents: 8209
diff changeset
15 * A Python environment where the Kallithea application and its dependencies
d59cb6068e55 docs: clarify the installation steps and how things fit together
Mads Kiilerich <mads@kiilerich.com>
parents: 8209
diff changeset
16 can be installed.
d59cb6068e55 docs: clarify the installation steps and how things fit together
Mads Kiilerich <mads@kiilerich.com>
parents: 8209
diff changeset
17 * A web server that can host the Kallithea web application using the WSGI
d59cb6068e55 docs: clarify the installation steps and how things fit together
Mads Kiilerich <mads@kiilerich.com>
parents: 8209
diff changeset
18 API.
d59cb6068e55 docs: clarify the installation steps and how things fit together
Mads Kiilerich <mads@kiilerich.com>
parents: 8209
diff changeset
19
d59cb6068e55 docs: clarify the installation steps and how things fit together
Mads Kiilerich <mads@kiilerich.com>
parents: 8209
diff changeset
20 2. **Install Kallithea software.**
d59cb6068e55 docs: clarify the installation steps and how things fit together
Mads Kiilerich <mads@kiilerich.com>
parents: 8209
diff changeset
21 This makes the ``kallithea-cli`` command line tool available.
d59cb6068e55 docs: clarify the installation steps and how things fit together
Mads Kiilerich <mads@kiilerich.com>
parents: 8209
diff changeset
22
8612
4d742b172010 docs: front-end-build is actually a part of the install process - it is shared among all the instances
Mads Kiilerich <mads@kiilerich.com>
parents: 8605
diff changeset
23 3. **Prepare front-end files**
8613
0765771dbe5a docs: clarify the need for having 'npm' and 'node' available in $PATH
Mads Kiilerich <mads@kiilerich.com>
parents: 8612
diff changeset
24 Some front-end files must be fetched or created using ``npm`` and ``node``
0765771dbe5a docs: clarify the need for having 'npm' and 'node' available in $PATH
Mads Kiilerich <mads@kiilerich.com>
parents: 8612
diff changeset
25 tooling so they can be served to the client as static files.
8612
4d742b172010 docs: front-end-build is actually a part of the install process - it is shared among all the instances
Mads Kiilerich <mads@kiilerich.com>
parents: 8605
diff changeset
26
4d742b172010 docs: front-end-build is actually a part of the install process - it is shared among all the instances
Mads Kiilerich <mads@kiilerich.com>
parents: 8605
diff changeset
27 4. **Create low level configuration file.**
8427
d59cb6068e55 docs: clarify the installation steps and how things fit together
Mads Kiilerich <mads@kiilerich.com>
parents: 8209
diff changeset
28 Use ``kallithea-cli config-create`` to create a ``.ini`` file with database
8442
75b1994e4959 docs: make it more clear that config-create with http_server=X should be used (Issue #358)
Mads Kiilerich <mads@kiilerich.com>
parents: 8427
diff changeset
29 connection info, mail server information, configuration for the specified
75b1994e4959 docs: make it more clear that config-create with http_server=X should be used (Issue #358)
Mads Kiilerich <mads@kiilerich.com>
parents: 8427
diff changeset
30 web server, etc.
8427
d59cb6068e55 docs: clarify the installation steps and how things fit together
Mads Kiilerich <mads@kiilerich.com>
parents: 8209
diff changeset
31
8612
4d742b172010 docs: front-end-build is actually a part of the install process - it is shared among all the instances
Mads Kiilerich <mads@kiilerich.com>
parents: 8605
diff changeset
32 5. **Populate the database.**
8427
d59cb6068e55 docs: clarify the installation steps and how things fit together
Mads Kiilerich <mads@kiilerich.com>
parents: 8209
diff changeset
33 Use ``kallithea-cli db-create`` with the ``.ini`` file to create the
d59cb6068e55 docs: clarify the installation steps and how things fit together
Mads Kiilerich <mads@kiilerich.com>
parents: 8209
diff changeset
34 database schema and insert the most basic information: the location of the
d59cb6068e55 docs: clarify the installation steps and how things fit together
Mads Kiilerich <mads@kiilerich.com>
parents: 8209
diff changeset
35 repository store and an initial local admin user.
d59cb6068e55 docs: clarify the installation steps and how things fit together
Mads Kiilerich <mads@kiilerich.com>
parents: 8209
diff changeset
36
8576
a63ccbc632d1 docs: add more section headings to setup description to show how it corresponds to the overview
Mads Kiilerich <mads@kiilerich.com>
parents: 8569
diff changeset
37 6. **Configure the web server.**
8427
d59cb6068e55 docs: clarify the installation steps and how things fit together
Mads Kiilerich <mads@kiilerich.com>
parents: 8209
diff changeset
38 The web server must invoke the WSGI entrypoint for the Kallithea software
d59cb6068e55 docs: clarify the installation steps and how things fit together
Mads Kiilerich <mads@kiilerich.com>
parents: 8209
diff changeset
39 using the ``.ini`` file (and thus the database). This makes the web
d59cb6068e55 docs: clarify the installation steps and how things fit together
Mads Kiilerich <mads@kiilerich.com>
parents: 8209
diff changeset
40 application available so the local admin user can log in and tweak the
d59cb6068e55 docs: clarify the installation steps and how things fit together
Mads Kiilerich <mads@kiilerich.com>
parents: 8209
diff changeset
41 configuration further.
d59cb6068e55 docs: clarify the installation steps and how things fit together
Mads Kiilerich <mads@kiilerich.com>
parents: 8209
diff changeset
42
8576
a63ccbc632d1 docs: add more section headings to setup description to show how it corresponds to the overview
Mads Kiilerich <mads@kiilerich.com>
parents: 8569
diff changeset
43 7. **Configure users.**
8427
d59cb6068e55 docs: clarify the installation steps and how things fit together
Mads Kiilerich <mads@kiilerich.com>
parents: 8209
diff changeset
44 The initial admin user can create additional local users, or configure how
d59cb6068e55 docs: clarify the installation steps and how things fit together
Mads Kiilerich <mads@kiilerich.com>
parents: 8209
diff changeset
45 users can be created and authenticated from other user directories.
d59cb6068e55 docs: clarify the installation steps and how things fit together
Mads Kiilerich <mads@kiilerich.com>
parents: 8209
diff changeset
46
d59cb6068e55 docs: clarify the installation steps and how things fit together
Mads Kiilerich <mads@kiilerich.com>
parents: 8209
diff changeset
47 See the subsequent sections, the separate OS-specific instructions, and
d59cb6068e55 docs: clarify the installation steps and how things fit together
Mads Kiilerich <mads@kiilerich.com>
parents: 8209
diff changeset
48 :ref:`setup` for details on these steps.
d59cb6068e55 docs: clarify the installation steps and how things fit together
Mads Kiilerich <mads@kiilerich.com>
parents: 8209
diff changeset
49
5081
154becd92f40 docs: add installation overview section
Mads Kiilerich <madski@unity3d.com>
parents:
diff changeset
50
8633
c354d1a7537f docs: give "File system location" overview
Mads Kiilerich <mads@kiilerich.com>
parents: 8613
diff changeset
51 File system location
c354d1a7537f docs: give "File system location" overview
Mads Kiilerich <mads@kiilerich.com>
parents: 8613
diff changeset
52 --------------------
c354d1a7537f docs: give "File system location" overview
Mads Kiilerich <mads@kiilerich.com>
parents: 8613
diff changeset
53
c354d1a7537f docs: give "File system location" overview
Mads Kiilerich <mads@kiilerich.com>
parents: 8613
diff changeset
54 Kallithea can be installed in many different ways. The main parts are:
c354d1a7537f docs: give "File system location" overview
Mads Kiilerich <mads@kiilerich.com>
parents: 8613
diff changeset
55
c354d1a7537f docs: give "File system location" overview
Mads Kiilerich <mads@kiilerich.com>
parents: 8613
diff changeset
56 - A location for the Kallithea software and its dependencies. This includes
c354d1a7537f docs: give "File system location" overview
Mads Kiilerich <mads@kiilerich.com>
parents: 8613
diff changeset
57 the Python code, template files, and front-end code. After installation, this
c354d1a7537f docs: give "File system location" overview
Mads Kiilerich <mads@kiilerich.com>
parents: 8613
diff changeset
58 will be read-only (except when upgrading).
c354d1a7537f docs: give "File system location" overview
Mads Kiilerich <mads@kiilerich.com>
parents: 8613
diff changeset
59
c354d1a7537f docs: give "File system location" overview
Mads Kiilerich <mads@kiilerich.com>
parents: 8613
diff changeset
60 - A location for the ``.ini`` configuration file that tells the Kallithea
c354d1a7537f docs: give "File system location" overview
Mads Kiilerich <mads@kiilerich.com>
parents: 8613
diff changeset
61 instance which database to use (and thus also the repository location).
c354d1a7537f docs: give "File system location" overview
Mads Kiilerich <mads@kiilerich.com>
parents: 8613
diff changeset
62 After installation, this will be read-only (except when upgrading).
c354d1a7537f docs: give "File system location" overview
Mads Kiilerich <mads@kiilerich.com>
parents: 8613
diff changeset
63
c354d1a7537f docs: give "File system location" overview
Mads Kiilerich <mads@kiilerich.com>
parents: 8613
diff changeset
64 - A location for various data files and caches for the Kallithea instance. This
c354d1a7537f docs: give "File system location" overview
Mads Kiilerich <mads@kiilerich.com>
parents: 8613
diff changeset
65 is by default in a ``data`` directory next to the ``.ini`` file. This will
c354d1a7537f docs: give "File system location" overview
Mads Kiilerich <mads@kiilerich.com>
parents: 8613
diff changeset
66 have to be writable by the running Kallithea service.
c354d1a7537f docs: give "File system location" overview
Mads Kiilerich <mads@kiilerich.com>
parents: 8613
diff changeset
67
c354d1a7537f docs: give "File system location" overview
Mads Kiilerich <mads@kiilerich.com>
parents: 8613
diff changeset
68 - A database. The ``.ini`` file specifies which database to use. The database
c354d1a7537f docs: give "File system location" overview
Mads Kiilerich <mads@kiilerich.com>
parents: 8613
diff changeset
69 will be a separate service and live elsewhere in the filesystem if using
c354d1a7537f docs: give "File system location" overview
Mads Kiilerich <mads@kiilerich.com>
parents: 8613
diff changeset
70 PostgreSQL or MariaDB/MySQL. If using SQLite, it will by default live next to
c354d1a7537f docs: give "File system location" overview
Mads Kiilerich <mads@kiilerich.com>
parents: 8613
diff changeset
71 the ``.ini`` file, as ``kallithea.db``.
c354d1a7537f docs: give "File system location" overview
Mads Kiilerich <mads@kiilerich.com>
parents: 8613
diff changeset
72
c354d1a7537f docs: give "File system location" overview
Mads Kiilerich <mads@kiilerich.com>
parents: 8613
diff changeset
73 - A location for the repositories that are hosted by this Kallithea instance.
c354d1a7537f docs: give "File system location" overview
Mads Kiilerich <mads@kiilerich.com>
parents: 8613
diff changeset
74 This will have to be writable by the running Kallithea service. The path to
c354d1a7537f docs: give "File system location" overview
Mads Kiilerich <mads@kiilerich.com>
parents: 8613
diff changeset
75 this location will be configured in the database.
c354d1a7537f docs: give "File system location" overview
Mads Kiilerich <mads@kiilerich.com>
parents: 8613
diff changeset
76
8635
c819a1e9103b docs: clarify the idea of best practice of installing in srv
Mads Kiilerich <mads@kiilerich.com>
parents: 8634
diff changeset
77 For production setups, one recommendation is to use ``/srv/kallithea`` for the
c819a1e9103b docs: clarify the idea of best practice of installing in srv
Mads Kiilerich <mads@kiilerich.com>
parents: 8634
diff changeset
78 ``.ini`` and ``data``, place the virtualenv in ``venv``, and use a Kallithea
c819a1e9103b docs: clarify the idea of best practice of installing in srv
Mads Kiilerich <mads@kiilerich.com>
parents: 8634
diff changeset
79 clone in ``kallithea``. Create a ``kallithea`` user, let it own
c819a1e9103b docs: clarify the idea of best practice of installing in srv
Mads Kiilerich <mads@kiilerich.com>
parents: 8634
diff changeset
80 ``/srv/kallithea``, and run as that user when installing.
c819a1e9103b docs: clarify the idea of best practice of installing in srv
Mads Kiilerich <mads@kiilerich.com>
parents: 8634
diff changeset
81
8633
c354d1a7537f docs: give "File system location" overview
Mads Kiilerich <mads@kiilerich.com>
parents: 8613
diff changeset
82 For simple setups, it is fine to just use something like a ``kallithea`` user
c354d1a7537f docs: give "File system location" overview
Mads Kiilerich <mads@kiilerich.com>
parents: 8613
diff changeset
83 with home in ``/home/kallithea`` and place everything there.
c354d1a7537f docs: give "File system location" overview
Mads Kiilerich <mads@kiilerich.com>
parents: 8613
diff changeset
84
c354d1a7537f docs: give "File system location" overview
Mads Kiilerich <mads@kiilerich.com>
parents: 8613
diff changeset
85 For experiments, it might be convenient to run everything as yourself and work
c354d1a7537f docs: give "File system location" overview
Mads Kiilerich <mads@kiilerich.com>
parents: 8613
diff changeset
86 inside a clone of Kallithea, with the ``.ini`` and SQLite database in the root
8634
6bab917402b4 docs: when using venv with a clone, recommend using 'venv' as location
Mads Kiilerich <mads@kiilerich.com>
parents: 8633
diff changeset
87 of the clone, and a virtualenv in ``venv``.
8633
c354d1a7537f docs: give "File system location" overview
Mads Kiilerich <mads@kiilerich.com>
parents: 8613
diff changeset
88
c354d1a7537f docs: give "File system location" overview
Mads Kiilerich <mads@kiilerich.com>
parents: 8613
diff changeset
89
5413
22a3fa3c4254 docs: cleanup of casing, markup and spacing of headings
Mads Kiilerich <madski@unity3d.com>
parents: 5081
diff changeset
90 Python environment
5081
154becd92f40 docs: add installation overview section
Mads Kiilerich <madski@unity3d.com>
parents:
diff changeset
91 ------------------
154becd92f40 docs: add installation overview section
Mads Kiilerich <madski@unity3d.com>
parents:
diff changeset
92
154becd92f40 docs: add installation overview section
Mads Kiilerich <madski@unity3d.com>
parents:
diff changeset
93 **Kallithea** is written entirely in Python_ and requires Python version
8209
01aca0a4f876 py3: officially support Python 3
Mads Kiilerich <mads@kiilerich.com>
parents: 8193
diff changeset
94 3.6 or higher.
5081
154becd92f40 docs: add installation overview section
Mads Kiilerich <madski@unity3d.com>
parents:
diff changeset
95
154becd92f40 docs: add installation overview section
Mads Kiilerich <madski@unity3d.com>
parents:
diff changeset
96 Given a Python installation, there are different ways of providing the
154becd92f40 docs: add installation overview section
Mads Kiilerich <madski@unity3d.com>
parents:
diff changeset
97 environment for running Python applications. Each of them pretty much
154becd92f40 docs: add installation overview section
Mads Kiilerich <madski@unity3d.com>
parents:
diff changeset
98 corresponds to a ``site-packages`` directory somewhere where packages can be
154becd92f40 docs: add installation overview section
Mads Kiilerich <madski@unity3d.com>
parents:
diff changeset
99 installed.
154becd92f40 docs: add installation overview section
Mads Kiilerich <madski@unity3d.com>
parents:
diff changeset
100
154becd92f40 docs: add installation overview section
Mads Kiilerich <madski@unity3d.com>
parents:
diff changeset
101 Kallithea itself can be run from source or be installed, but even when running
154becd92f40 docs: add installation overview section
Mads Kiilerich <madski@unity3d.com>
parents:
diff changeset
102 from source, there are some dependencies that must be installed in the Python
154becd92f40 docs: add installation overview section
Mads Kiilerich <madski@unity3d.com>
parents:
diff changeset
103 environment used for running Kallithea.
154becd92f40 docs: add installation overview section
Mads Kiilerich <madski@unity3d.com>
parents:
diff changeset
104
154becd92f40 docs: add installation overview section
Mads Kiilerich <madski@unity3d.com>
parents:
diff changeset
105 - Packages *could* be installed in Python's ``site-packages`` directory ... but
154becd92f40 docs: add installation overview section
Mads Kiilerich <madski@unity3d.com>
parents:
diff changeset
106 that would require running pip_ as root and it would be hard to uninstall or
154becd92f40 docs: add installation overview section
Mads Kiilerich <madski@unity3d.com>
parents:
diff changeset
107 upgrade and is probably not a good idea unless using a package manager.
154becd92f40 docs: add installation overview section
Mads Kiilerich <madski@unity3d.com>
parents:
diff changeset
108
154becd92f40 docs: add installation overview section
Mads Kiilerich <madski@unity3d.com>
parents:
diff changeset
109 - Packages could also be installed in ``~/.local`` ... but that is probably
154becd92f40 docs: add installation overview section
Mads Kiilerich <madski@unity3d.com>
parents:
diff changeset
110 only a good idea if using a dedicated user per application or instance.
154becd92f40 docs: add installation overview section
Mads Kiilerich <madski@unity3d.com>
parents:
diff changeset
111
8193
89e9aef9b983 py3: use "python3 -m venv" instead of virtualenv package
Mads Kiilerich <mads@kiilerich.com>
parents: 7708
diff changeset
112 - Finally, it can be installed in a virtualenv. That is a very lightweight
5081
154becd92f40 docs: add installation overview section
Mads Kiilerich <madski@unity3d.com>
parents:
diff changeset
113 "container" where each Kallithea instance can get its own dedicated and
154becd92f40 docs: add installation overview section
Mads Kiilerich <madski@unity3d.com>
parents:
diff changeset
114 self-contained virtual environment.
154becd92f40 docs: add installation overview section
Mads Kiilerich <madski@unity3d.com>
parents:
diff changeset
115
154becd92f40 docs: add installation overview section
Mads Kiilerich <madski@unity3d.com>
parents:
diff changeset
116 We recommend using virtualenv for installing Kallithea.
154becd92f40 docs: add installation overview section
Mads Kiilerich <madski@unity3d.com>
parents:
diff changeset
117
154becd92f40 docs: add installation overview section
Mads Kiilerich <madski@unity3d.com>
parents:
diff changeset
118
7653
9bae11163c31 docs: outline the challenges of specifying a locale for services (Issue #340)
Mads Kiilerich <mads@kiilerich.com>
parents: 7456
diff changeset
119 Locale environment
9bae11163c31 docs: outline the challenges of specifying a locale for services (Issue #340)
Mads Kiilerich <mads@kiilerich.com>
parents: 7456
diff changeset
120 ------------------
9bae11163c31 docs: outline the challenges of specifying a locale for services (Issue #340)
Mads Kiilerich <mads@kiilerich.com>
parents: 7456
diff changeset
121
9bae11163c31 docs: outline the challenges of specifying a locale for services (Issue #340)
Mads Kiilerich <mads@kiilerich.com>
parents: 7456
diff changeset
122 In order to ensure a correct functioning of Kallithea with respect to non-ASCII
9bae11163c31 docs: outline the challenges of specifying a locale for services (Issue #340)
Mads Kiilerich <mads@kiilerich.com>
parents: 7456
diff changeset
123 characters in user names, file paths, commit messages, etc., it is very
9bae11163c31 docs: outline the challenges of specifying a locale for services (Issue #340)
Mads Kiilerich <mads@kiilerich.com>
parents: 7456
diff changeset
124 important that Kallithea is run with a correct `locale` configuration.
9bae11163c31 docs: outline the challenges of specifying a locale for services (Issue #340)
Mads Kiilerich <mads@kiilerich.com>
parents: 7456
diff changeset
125
9bae11163c31 docs: outline the challenges of specifying a locale for services (Issue #340)
Mads Kiilerich <mads@kiilerich.com>
parents: 7456
diff changeset
126 On Unix, environment variables like ``LANG`` or ``LC_ALL`` can specify a language (like
9bae11163c31 docs: outline the challenges of specifying a locale for services (Issue #340)
Mads Kiilerich <mads@kiilerich.com>
parents: 7456
diff changeset
127 ``en_US``) and encoding (like ``UTF-8``) to use for code points outside the ASCII
9bae11163c31 docs: outline the challenges of specifying a locale for services (Issue #340)
Mads Kiilerich <mads@kiilerich.com>
parents: 7456
diff changeset
128 range. The flexibility of supporting multiple encodings of Unicode has the flip
9bae11163c31 docs: outline the challenges of specifying a locale for services (Issue #340)
Mads Kiilerich <mads@kiilerich.com>
parents: 7456
diff changeset
129 side of having to specify which encoding to use - especially for Mercurial.
9bae11163c31 docs: outline the challenges of specifying a locale for services (Issue #340)
Mads Kiilerich <mads@kiilerich.com>
parents: 7456
diff changeset
130
9bae11163c31 docs: outline the challenges of specifying a locale for services (Issue #340)
Mads Kiilerich <mads@kiilerich.com>
parents: 7456
diff changeset
131 It depends on the OS distribution and system configuration which locales are
9bae11163c31 docs: outline the challenges of specifying a locale for services (Issue #340)
Mads Kiilerich <mads@kiilerich.com>
parents: 7456
diff changeset
132 available. For example, some Docker containers based on Debian default to only
9bae11163c31 docs: outline the challenges of specifying a locale for services (Issue #340)
Mads Kiilerich <mads@kiilerich.com>
parents: 7456
diff changeset
133 supporting the ``C`` language, while other Linux environments have ``en_US`` but not
9bae11163c31 docs: outline the challenges of specifying a locale for services (Issue #340)
Mads Kiilerich <mads@kiilerich.com>
parents: 7456
diff changeset
134 ``C``. The ``locale -a`` command will show which values are available on the
9bae11163c31 docs: outline the challenges of specifying a locale for services (Issue #340)
Mads Kiilerich <mads@kiilerich.com>
parents: 7456
diff changeset
135 current system. Regardless of the actual language, you should normally choose a
9bae11163c31 docs: outline the challenges of specifying a locale for services (Issue #340)
Mads Kiilerich <mads@kiilerich.com>
parents: 7456
diff changeset
136 locale that has the ``UTF-8`` encoding (note that spellings ``utf8``, ``utf-8``,
9bae11163c31 docs: outline the challenges of specifying a locale for services (Issue #340)
Mads Kiilerich <mads@kiilerich.com>
parents: 7456
diff changeset
137 ``UTF8``, ``UTF-8`` are all referring to the same thing)
9bae11163c31 docs: outline the challenges of specifying a locale for services (Issue #340)
Mads Kiilerich <mads@kiilerich.com>
parents: 7456
diff changeset
138
9bae11163c31 docs: outline the challenges of specifying a locale for services (Issue #340)
Mads Kiilerich <mads@kiilerich.com>
parents: 7456
diff changeset
139 For technical reasons, the locale configuration **must** be provided in the
9bae11163c31 docs: outline the challenges of specifying a locale for services (Issue #340)
Mads Kiilerich <mads@kiilerich.com>
parents: 7456
diff changeset
140 environment in which Kallithea runs - it cannot be specified in the ``.ini`` file.
9bae11163c31 docs: outline the challenges of specifying a locale for services (Issue #340)
Mads Kiilerich <mads@kiilerich.com>
parents: 7456
diff changeset
141 How to practically do this depends on the web server that is used and the way it
9bae11163c31 docs: outline the challenges of specifying a locale for services (Issue #340)
Mads Kiilerich <mads@kiilerich.com>
parents: 7456
diff changeset
142 is started. For example, gearbox is often started by a normal user, either
9bae11163c31 docs: outline the challenges of specifying a locale for services (Issue #340)
Mads Kiilerich <mads@kiilerich.com>
parents: 7456
diff changeset
143 manually or via a script. In this case, the required locale environment
9bae11163c31 docs: outline the challenges of specifying a locale for services (Issue #340)
Mads Kiilerich <mads@kiilerich.com>
parents: 7456
diff changeset
144 variables can be provided directly in that user's environment or in the script.
9bae11163c31 docs: outline the challenges of specifying a locale for services (Issue #340)
Mads Kiilerich <mads@kiilerich.com>
parents: 7456
diff changeset
145 However, web servers like Apache are often started at boot via an init script or
9bae11163c31 docs: outline the challenges of specifying a locale for services (Issue #340)
Mads Kiilerich <mads@kiilerich.com>
parents: 7456
diff changeset
146 service file. Modifying the environment for this case would thus require
9bae11163c31 docs: outline the challenges of specifying a locale for services (Issue #340)
Mads Kiilerich <mads@kiilerich.com>
parents: 7456
diff changeset
147 root/administrator privileges. Moreover, that environment would dictate the
9bae11163c31 docs: outline the challenges of specifying a locale for services (Issue #340)
Mads Kiilerich <mads@kiilerich.com>
parents: 7456
diff changeset
148 settings for all web services running under that web server, Kallithea being
9bae11163c31 docs: outline the challenges of specifying a locale for services (Issue #340)
Mads Kiilerich <mads@kiilerich.com>
parents: 7456
diff changeset
149 just one of them. Specifically in the case of Apache with ``mod_wsgi``, the
9bae11163c31 docs: outline the challenges of specifying a locale for services (Issue #340)
Mads Kiilerich <mads@kiilerich.com>
parents: 7456
diff changeset
150 locale can be set for a specific service in its ``WSGIDaemonProcess`` directive,
9bae11163c31 docs: outline the challenges of specifying a locale for services (Issue #340)
Mads Kiilerich <mads@kiilerich.com>
parents: 7456
diff changeset
151 using the ``lang`` parameter.
9bae11163c31 docs: outline the challenges of specifying a locale for services (Issue #340)
Mads Kiilerich <mads@kiilerich.com>
parents: 7456
diff changeset
152
9bae11163c31 docs: outline the challenges of specifying a locale for services (Issue #340)
Mads Kiilerich <mads@kiilerich.com>
parents: 7456
diff changeset
153
5413
22a3fa3c4254 docs: cleanup of casing, markup and spacing of headings
Mads Kiilerich <madski@unity3d.com>
parents: 5081
diff changeset
154 Installation methods
5081
154becd92f40 docs: add installation overview section
Mads Kiilerich <madski@unity3d.com>
parents:
diff changeset
155 --------------------
154becd92f40 docs: add installation overview section
Mads Kiilerich <madski@unity3d.com>
parents:
diff changeset
156
154becd92f40 docs: add installation overview section
Mads Kiilerich <madski@unity3d.com>
parents:
diff changeset
157 Kallithea must be installed on a server. Kallithea is installed in a Python
154becd92f40 docs: add installation overview section
Mads Kiilerich <madski@unity3d.com>
parents:
diff changeset
158 environment so it can use packages that are installed there and make itself
154becd92f40 docs: add installation overview section
Mads Kiilerich <madski@unity3d.com>
parents:
diff changeset
159 available for other packages.
154becd92f40 docs: add installation overview section
Mads Kiilerich <madski@unity3d.com>
parents:
diff changeset
160
154becd92f40 docs: add installation overview section
Mads Kiilerich <madski@unity3d.com>
parents:
diff changeset
161 Two different cases will pretty much cover the options for how it can be
154becd92f40 docs: add installation overview section
Mads Kiilerich <madski@unity3d.com>
parents:
diff changeset
162 installed.
154becd92f40 docs: add installation overview section
Mads Kiilerich <madski@unity3d.com>
parents:
diff changeset
163
5435
60e04a21bf0f docs: more consistent use of --
Mads Kiilerich <madski@unity3d.com>
parents: 5433
diff changeset
164 - The Kallithea source repository can be cloned and used -- it is kept stable and
5081
154becd92f40 docs: add installation overview section
Mads Kiilerich <madski@unity3d.com>
parents:
diff changeset
165 can be used in production. The Kallithea maintainers use the development
154becd92f40 docs: add installation overview section
Mads Kiilerich <madski@unity3d.com>
parents:
diff changeset
166 branch in production. The advantage of installation from source and regularly
154becd92f40 docs: add installation overview section
Mads Kiilerich <madski@unity3d.com>
parents:
diff changeset
167 updating it is that you take advantage of the most recent improvements. Using
154becd92f40 docs: add installation overview section
Mads Kiilerich <madski@unity3d.com>
parents:
diff changeset
168 it directly from a DVCS also means that it is easy to track local customizations.
154becd92f40 docs: add installation overview section
Mads Kiilerich <madski@unity3d.com>
parents:
diff changeset
169
5755
250f8150c4bb docs: suggest using pip instead of setup.py develop
Andrew Shadura <andrew@shadura.me>
parents: 5435
diff changeset
170 Running ``pip install -e .`` in the source will use pip to install the
5081
154becd92f40 docs: add installation overview section
Mads Kiilerich <madski@unity3d.com>
parents:
diff changeset
171 necessary dependencies in the Python environment and create a
154becd92f40 docs: add installation overview section
Mads Kiilerich <madski@unity3d.com>
parents:
diff changeset
172 ``.../site-packages/Kallithea.egg-link`` file there that points at the Kallithea
154becd92f40 docs: add installation overview section
Mads Kiilerich <madski@unity3d.com>
parents:
diff changeset
173 source.
154becd92f40 docs: add installation overview section
Mads Kiilerich <madski@unity3d.com>
parents:
diff changeset
174
154becd92f40 docs: add installation overview section
Mads Kiilerich <madski@unity3d.com>
parents:
diff changeset
175 - Kallithea can also be installed from ready-made packages using a package manager.
154becd92f40 docs: add installation overview section
Mads Kiilerich <madski@unity3d.com>
parents:
diff changeset
176 The official released versions are available on PyPI_ and can be downloaded and
154becd92f40 docs: add installation overview section
Mads Kiilerich <madski@unity3d.com>
parents:
diff changeset
177 installed with all dependencies using ``pip install kallithea``.
154becd92f40 docs: add installation overview section
Mads Kiilerich <madski@unity3d.com>
parents:
diff changeset
178
154becd92f40 docs: add installation overview section
Mads Kiilerich <madski@unity3d.com>
parents:
diff changeset
179 With this method, Kallithea is installed in the Python environment as any
8209
01aca0a4f876 py3: officially support Python 3
Mads Kiilerich <mads@kiilerich.com>
parents: 8193
diff changeset
180 other package, usually as a ``.../site-packages/Kallithea-X-py3.8.egg/``
5081
154becd92f40 docs: add installation overview section
Mads Kiilerich <madski@unity3d.com>
parents:
diff changeset
181 directory with Python files and everything else that is needed.
154becd92f40 docs: add installation overview section
Mads Kiilerich <madski@unity3d.com>
parents:
diff changeset
182
154becd92f40 docs: add installation overview section
Mads Kiilerich <madski@unity3d.com>
parents:
diff changeset
183 (``pip install kallithea`` from a source tree will do pretty much the same
154becd92f40 docs: add installation overview section
Mads Kiilerich <madski@unity3d.com>
parents:
diff changeset
184 but build the Kallithea package itself locally instead of downloading it.)
154becd92f40 docs: add installation overview section
Mads Kiilerich <madski@unity3d.com>
parents:
diff changeset
185
7456
39f81c536ad4 docs: Fix a couple of build warnings
Mads Kiilerich <mads@kiilerich.com>
parents: 7437
diff changeset
186 .. note::
8444
850f096505ac docs: mention the npm dependency more clearly (Issue #345)
Mads Kiilerich <mads@kiilerich.com>
parents: 8442
diff changeset
187 Kallithea includes front-end code that needs to be processed to prepare
850f096505ac docs: mention the npm dependency more clearly (Issue #345)
Mads Kiilerich <mads@kiilerich.com>
parents: 8442
diff changeset
188 static files that can be served at run time and used on the client side. The
850f096505ac docs: mention the npm dependency more clearly (Issue #345)
Mads Kiilerich <mads@kiilerich.com>
parents: 8442
diff changeset
189 tool npm_ is used to download external dependencies and orchestrate the
850f096505ac docs: mention the npm dependency more clearly (Issue #345)
Mads Kiilerich <mads@kiilerich.com>
parents: 8442
diff changeset
190 processing. The ``npm`` binary must thus be available at install time but is
850f096505ac docs: mention the npm dependency more clearly (Issue #345)
Mads Kiilerich <mads@kiilerich.com>
parents: 8442
diff changeset
191 not used at run time.
7055
6ef837acb0d2 less: don't distribute the generated style.css file - for now, it must be built with npm after installing Kallithea
domruf <dominikruf@gmail.com>
parents: 6554
diff changeset
192
5081
154becd92f40 docs: add installation overview section
Mads Kiilerich <madski@unity3d.com>
parents:
diff changeset
193
5413
22a3fa3c4254 docs: cleanup of casing, markup and spacing of headings
Mads Kiilerich <madski@unity3d.com>
parents: 5081
diff changeset
194 Web server
5081
154becd92f40 docs: add installation overview section
Mads Kiilerich <madski@unity3d.com>
parents:
diff changeset
195 ----------
154becd92f40 docs: add installation overview section
Mads Kiilerich <madski@unity3d.com>
parents:
diff changeset
196
154becd92f40 docs: add installation overview section
Mads Kiilerich <madski@unity3d.com>
parents:
diff changeset
197 Kallithea is (primarily) a WSGI_ application that must be run from a web
5417
36a35394b3cb docs: fix some confusing paste/paster typos
Mads Kiilerich <madski@unity3d.com>
parents: 5413
diff changeset
198 server that serves WSGI applications over HTTP.
5081
154becd92f40 docs: add installation overview section
Mads Kiilerich <madski@unity3d.com>
parents:
diff changeset
199
5418
439792d55052 docs: try to improve the web server overview page
Mads Kiilerich <madski@unity3d.com>
parents: 5417
diff changeset
200 Kallithea itself is not serving HTTP (or HTTPS); that is the web server's
439792d55052 docs: try to improve the web server overview page
Mads Kiilerich <madski@unity3d.com>
parents: 5417
diff changeset
201 responsibility. Kallithea does however need to know its own user facing URL
439792d55052 docs: try to improve the web server overview page
Mads Kiilerich <madski@unity3d.com>
parents: 5417
diff changeset
202 (protocol, address, port and path) for each HTTP request. Kallithea will
439792d55052 docs: try to improve the web server overview page
Mads Kiilerich <madski@unity3d.com>
parents: 5417
diff changeset
203 usually use its own HTML/cookie based authentication but can also be configured
439792d55052 docs: try to improve the web server overview page
Mads Kiilerich <madski@unity3d.com>
parents: 5417
diff changeset
204 to use web server authentication.
5081
154becd92f40 docs: add installation overview section
Mads Kiilerich <madski@unity3d.com>
parents:
diff changeset
205
5418
439792d55052 docs: try to improve the web server overview page
Mads Kiilerich <madski@unity3d.com>
parents: 5417
diff changeset
206 There are several web server options:
5081
154becd92f40 docs: add installation overview section
Mads Kiilerich <madski@unity3d.com>
parents:
diff changeset
207
6554
2c3d30095d5e gearbox: replace paster with something TurboGears2-ish that still works with the Pylons stack
Mads Kiilerich <madski@unity3d.com>
parents: 6339
diff changeset
208 - Kallithea uses the Gearbox_ tool as command line interface. Gearbox provides
2c3d30095d5e gearbox: replace paster with something TurboGears2-ish that still works with the Pylons stack
Mads Kiilerich <madski@unity3d.com>
parents: 6339
diff changeset
209 ``gearbox serve`` as a convenient way to launch a Python WSGI / web server
5418
439792d55052 docs: try to improve the web server overview page
Mads Kiilerich <madski@unity3d.com>
parents: 5417
diff changeset
210 from the command line. That is perfect for development and evaluation.
439792d55052 docs: try to improve the web server overview page
Mads Kiilerich <madski@unity3d.com>
parents: 5417
diff changeset
211 Actual use in production might have different requirements and need extra
439792d55052 docs: try to improve the web server overview page
Mads Kiilerich <madski@unity3d.com>
parents: 5417
diff changeset
212 work to make it manageable as a scalable system service.
5081
154becd92f40 docs: add installation overview section
Mads Kiilerich <madski@unity3d.com>
parents:
diff changeset
213
8442
75b1994e4959 docs: make it more clear that config-create with http_server=X should be used (Issue #358)
Mads Kiilerich <mads@kiilerich.com>
parents: 8427
diff changeset
214 Gearbox comes with its own built-in web server for development but Kallithea
75b1994e4959 docs: make it more clear that config-create with http_server=X should be used (Issue #358)
Mads Kiilerich <mads@kiilerich.com>
parents: 8427
diff changeset
215 defaults to using Waitress_. Gunicorn_ and Gevent_ are also options. These
75b1994e4959 docs: make it more clear that config-create with http_server=X should be used (Issue #358)
Mads Kiilerich <mads@kiilerich.com>
parents: 8427
diff changeset
216 web servers have different limited feature sets.
5081
154becd92f40 docs: add installation overview section
Mads Kiilerich <madski@unity3d.com>
parents:
diff changeset
217
8442
75b1994e4959 docs: make it more clear that config-create with http_server=X should be used (Issue #358)
Mads Kiilerich <mads@kiilerich.com>
parents: 8427
diff changeset
218 The web server used by ``gearbox serve`` is configured in the ``.ini`` file.
75b1994e4959 docs: make it more clear that config-create with http_server=X should be used (Issue #358)
Mads Kiilerich <mads@kiilerich.com>
parents: 8427
diff changeset
219 Create it with ``config-create`` using for example ``http_server=waitress``
75b1994e4959 docs: make it more clear that config-create with http_server=X should be used (Issue #358)
Mads Kiilerich <mads@kiilerich.com>
parents: 8427
diff changeset
220 to get a configuration starting point for your choice of web server.
75b1994e4959 docs: make it more clear that config-create with http_server=X should be used (Issue #358)
Mads Kiilerich <mads@kiilerich.com>
parents: 8427
diff changeset
221
75b1994e4959 docs: make it more clear that config-create with http_server=X should be used (Issue #358)
Mads Kiilerich <mads@kiilerich.com>
parents: 8427
diff changeset
222 (Gearbox will do like ``paste`` and use the WSGI application entry point
8569
87de82eb7cb0 docs: update docs changes from stable 75b1994e4959 with kallithea.config.application refactoring in default 3a02b678b5e7
Mads Kiilerich <mads@kiilerich.com>
parents: 8568
diff changeset
223 ``kallithea.config.application:make_app`` as specified in ``setup.py``.)
5081
154becd92f40 docs: add installation overview section
Mads Kiilerich <madski@unity3d.com>
parents:
diff changeset
224
154becd92f40 docs: add installation overview section
Mads Kiilerich <madski@unity3d.com>
parents:
diff changeset
225 - `Apache httpd`_ can serve WSGI applications directly using mod_wsgi_ and a
154becd92f40 docs: add installation overview section
Mads Kiilerich <madski@unity3d.com>
parents:
diff changeset
226 simple Python file with the necessary configuration. This is a good option if
154becd92f40 docs: add installation overview section
Mads Kiilerich <madski@unity3d.com>
parents:
diff changeset
227 Apache is an option.
154becd92f40 docs: add installation overview section
Mads Kiilerich <madski@unity3d.com>
parents:
diff changeset
228
8442
75b1994e4959 docs: make it more clear that config-create with http_server=X should be used (Issue #358)
Mads Kiilerich <mads@kiilerich.com>
parents: 8427
diff changeset
229 - uWSGI_ is also a full web server with built-in WSGI module. Use
75b1994e4959 docs: make it more clear that config-create with http_server=X should be used (Issue #358)
Mads Kiilerich <mads@kiilerich.com>
parents: 8427
diff changeset
230 ``config-create`` with ``http_server=uwsgi`` to get a ``.ini`` file with
75b1994e4959 docs: make it more clear that config-create with http_server=X should be used (Issue #358)
Mads Kiilerich <mads@kiilerich.com>
parents: 8427
diff changeset
231 uWSGI configuration.
5418
439792d55052 docs: try to improve the web server overview page
Mads Kiilerich <madski@unity3d.com>
parents: 5417
diff changeset
232
5081
154becd92f40 docs: add installation overview section
Mads Kiilerich <madski@unity3d.com>
parents:
diff changeset
233 - IIS_ can also server WSGI applications directly using isapi-wsgi_.
154becd92f40 docs: add installation overview section
Mads Kiilerich <madski@unity3d.com>
parents:
diff changeset
234
5418
439792d55052 docs: try to improve the web server overview page
Mads Kiilerich <madski@unity3d.com>
parents: 5417
diff changeset
235 - A `reverse HTTP proxy <https://en.wikipedia.org/wiki/Reverse_proxy>`_
439792d55052 docs: try to improve the web server overview page
Mads Kiilerich <madski@unity3d.com>
parents: 5417
diff changeset
236 can be put in front of another web server which has WSGI support.
439792d55052 docs: try to improve the web server overview page
Mads Kiilerich <madski@unity3d.com>
parents: 5417
diff changeset
237 Such a layered setup can be complex but might in some cases be the right
439792d55052 docs: try to improve the web server overview page
Mads Kiilerich <madski@unity3d.com>
parents: 5417
diff changeset
238 option, for example to standardize on one internet-facing web server, to add
439792d55052 docs: try to improve the web server overview page
Mads Kiilerich <madski@unity3d.com>
parents: 5417
diff changeset
239 encryption or special authentication or for other security reasons, to
439792d55052 docs: try to improve the web server overview page
Mads Kiilerich <madski@unity3d.com>
parents: 5417
diff changeset
240 provide caching of static files, or to provide load balancing or fail-over.
439792d55052 docs: try to improve the web server overview page
Mads Kiilerich <madski@unity3d.com>
parents: 5417
diff changeset
241 Nginx_, Varnish_ and HAProxy_ are often used for this purpose, often in front
6554
2c3d30095d5e gearbox: replace paster with something TurboGears2-ish that still works with the Pylons stack
Mads Kiilerich <madski@unity3d.com>
parents: 6339
diff changeset
242 of a ``gearbox serve`` that somehow is wrapped as a service.
5081
154becd92f40 docs: add installation overview section
Mads Kiilerich <madski@unity3d.com>
parents:
diff changeset
243
154becd92f40 docs: add installation overview section
Mads Kiilerich <madski@unity3d.com>
parents:
diff changeset
244 The best option depends on what you are familiar with and the requirements for
154becd92f40 docs: add installation overview section
Mads Kiilerich <madski@unity3d.com>
parents:
diff changeset
245 performance and stability. Also, keep in mind that Kallithea mainly is serving
5418
439792d55052 docs: try to improve the web server overview page
Mads Kiilerich <madski@unity3d.com>
parents: 5417
diff changeset
246 dynamically generated pages from a relatively slow Python process. Kallithea is
439792d55052 docs: try to improve the web server overview page
Mads Kiilerich <madski@unity3d.com>
parents: 5417
diff changeset
247 also often used inside organizations with a limited amount of users and thus no
5081
154becd92f40 docs: add installation overview section
Mads Kiilerich <madski@unity3d.com>
parents:
diff changeset
248 continuous hammering from the internet.
154becd92f40 docs: add installation overview section
Mads Kiilerich <madski@unity3d.com>
parents:
diff changeset
249
8445
0bca9e828db2 docs: mention the need for worker process restarts to avoid "memory leaks" (Issue #346)
Mads Kiilerich <mads@kiilerich.com>
parents: 8444
diff changeset
250 .. note::
0bca9e828db2 docs: mention the need for worker process restarts to avoid "memory leaks" (Issue #346)
Mads Kiilerich <mads@kiilerich.com>
parents: 8444
diff changeset
251 Kallithea, the libraries it uses, and Python itself do in several places use
0bca9e828db2 docs: mention the need for worker process restarts to avoid "memory leaks" (Issue #346)
Mads Kiilerich <mads@kiilerich.com>
parents: 8444
diff changeset
252 simple caching in memory. Caches and memory are not always released in a way
0bca9e828db2 docs: mention the need for worker process restarts to avoid "memory leaks" (Issue #346)
Mads Kiilerich <mads@kiilerich.com>
parents: 8444
diff changeset
253 that is suitable for long-running processes. They might appear to be leaking
0bca9e828db2 docs: mention the need for worker process restarts to avoid "memory leaks" (Issue #346)
Mads Kiilerich <mads@kiilerich.com>
parents: 8444
diff changeset
254 memory. The worker processes should thus regularly be restarted - for
0bca9e828db2 docs: mention the need for worker process restarts to avoid "memory leaks" (Issue #346)
Mads Kiilerich <mads@kiilerich.com>
parents: 8444
diff changeset
255 example after 1000 requests and/or one hour. This can usually be done by the
0bca9e828db2 docs: mention the need for worker process restarts to avoid "memory leaks" (Issue #346)
Mads Kiilerich <mads@kiilerich.com>
parents: 8444
diff changeset
256 web server or the tool used for running it as a system service.
0bca9e828db2 docs: mention the need for worker process restarts to avoid "memory leaks" (Issue #346)
Mads Kiilerich <mads@kiilerich.com>
parents: 8444
diff changeset
257
5081
154becd92f40 docs: add installation overview section
Mads Kiilerich <madski@unity3d.com>
parents:
diff changeset
258
154becd92f40 docs: add installation overview section
Mads Kiilerich <madski@unity3d.com>
parents:
diff changeset
259 .. _Python: http://www.python.org/
154becd92f40 docs: add installation overview section
Mads Kiilerich <madski@unity3d.com>
parents:
diff changeset
260 .. _Gunicorn: http://gunicorn.org/
8442
75b1994e4959 docs: make it more clear that config-create with http_server=X should be used (Issue #358)
Mads Kiilerich <mads@kiilerich.com>
parents: 8427
diff changeset
261 .. _Gevent: http://www.gevent.org/
8604
61bd04b90f58 docs: clean up readthedocs URLs
Mads Kiilerich <mads@kiilerich.com>
parents: 8576
diff changeset
262 .. _Waitress: https://docs.pylonsproject.org/projects/waitress/
61bd04b90f58 docs: clean up readthedocs URLs
Mads Kiilerich <mads@kiilerich.com>
parents: 8576
diff changeset
263 .. _Gearbox: https://turbogears.readthedocs.io/en/latest/turbogears/gearbox.html
5081
154becd92f40 docs: add installation overview section
Mads Kiilerich <madski@unity3d.com>
parents:
diff changeset
264 .. _PyPI: https://pypi.python.org/pypi
154becd92f40 docs: add installation overview section
Mads Kiilerich <madski@unity3d.com>
parents:
diff changeset
265 .. _Apache httpd: http://httpd.apache.org/
8605
7a7273f08cfb docs: mod_wsgi is no longer on google code
Mads Kiilerich <mads@kiilerich.com>
parents: 8604
diff changeset
266 .. _mod_wsgi: https://modwsgi.readthedocs.io/
5081
154becd92f40 docs: add installation overview section
Mads Kiilerich <madski@unity3d.com>
parents:
diff changeset
267 .. _isapi-wsgi: https://github.com/hexdump42/isapi-wsgi
8604
61bd04b90f58 docs: clean up readthedocs URLs
Mads Kiilerich <mads@kiilerich.com>
parents: 8576
diff changeset
268 .. _uWSGI: https://uwsgi-docs.readthedocs.io/
5081
154becd92f40 docs: add installation overview section
Mads Kiilerich <madski@unity3d.com>
parents:
diff changeset
269 .. _nginx: http://nginx.org/en/
154becd92f40 docs: add installation overview section
Mads Kiilerich <madski@unity3d.com>
parents:
diff changeset
270 .. _iis: http://en.wikipedia.org/wiki/Internet_Information_Services
154becd92f40 docs: add installation overview section
Mads Kiilerich <madski@unity3d.com>
parents:
diff changeset
271 .. _pip: http://en.wikipedia.org/wiki/Pip_%28package_manager%29
154becd92f40 docs: add installation overview section
Mads Kiilerich <madski@unity3d.com>
parents:
diff changeset
272 .. _WSGI: http://en.wikipedia.org/wiki/Web_Server_Gateway_Interface
5418
439792d55052 docs: try to improve the web server overview page
Mads Kiilerich <madski@unity3d.com>
parents: 5417
diff changeset
273 .. _HAProxy: http://www.haproxy.org/
439792d55052 docs: try to improve the web server overview page
Mads Kiilerich <madski@unity3d.com>
parents: 5417
diff changeset
274 .. _Varnish: https://www.varnish-cache.org/
7437
b66725ba01ed cli: add command 'kallithea-cli front-end-build'
Thomas De Schampheleire <thomas.de_schampheleire@nokia.com>
parents: 7055
diff changeset
275 .. _npm: https://www.npmjs.com/