Mercurial > kallithea

annotate docs/installation.rst @ 8756:b4749d02192d

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
model: remove unused 'subject' parameter of NotificationModel.create() The subject of emails is determined with EmailNotificationModel._subj_map, based on the notification type. The 'subject' parameter passed to NotificationModel.create is completely unused. Remove this parameter and update its callers, removing code that is now no longer used.
author Thomas De Schampheleire <thomas.de_schampheleire@nokia.com>
date Thu, 05 Nov 2020 22:41:09 +0100
parents 7982eac0703d
children 7e9e1f3d7a93
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
568
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
1 .. _installation:
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
2
4814
d95ea48af67b docs: rename docs/installation_win.rst to docs/installation_win_old.rst, preparing for new docs
Mads Kiilerich <madski@unity3d.com>
parents: 4522
diff changeset
3 ==========================
d95ea48af67b docs: rename docs/installation_win.rst to docs/installation_win_old.rst, preparing for new docs
Mads Kiilerich <madski@unity3d.com>
parents: 4522
diff changeset
4 Installation on Unix/Linux
d95ea48af67b docs: rename docs/installation_win.rst to docs/installation_win_old.rst, preparing for new docs
Mads Kiilerich <madski@unity3d.com>
parents: 4522
diff changeset
5 ==========================
568
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
6
5425
5ae8e644aa88 docs: spelling, grammar, content and typography
Søren Løvborg <sorenl@unity3d.com>
parents: 5413
diff changeset
7 The following describes three different ways of installing Kallithea:
4902
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4814
diff changeset
8
5081
154becd92f40 docs: add installation overview section
Mads Kiilerich <madski@unity3d.com>
parents: 4989
diff changeset
9 - :ref:`installation-source`: The simplest way to keep the installation
5425
5ae8e644aa88 docs: spelling, grammar, content and typography
Søren Løvborg <sorenl@unity3d.com>
parents: 5413
diff changeset
10 up-to-date and track any local customizations is to run directly from
5ae8e644aa88 docs: spelling, grammar, content and typography
Søren Løvborg <sorenl@unity3d.com>
parents: 5413
diff changeset
11 source in a Kallithea repository clone, preferably inside a virtualenv
5ae8e644aa88 docs: spelling, grammar, content and typography
Søren Løvborg <sorenl@unity3d.com>
parents: 5413
diff changeset
12 virtual Python environment.
568
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
13
4924
7c952ea3d7b3 docs/installation: clarify and reorder alternative installation methods
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4922
diff changeset
14 - :ref:`installation-virtualenv`: If you prefer to only use released versions
7c952ea3d7b3 docs/installation: clarify and reorder alternative installation methods
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4922
diff changeset
15 of Kallithea, the recommended method is to install Kallithea in a virtual
7c952ea3d7b3 docs/installation: clarify and reorder alternative installation methods
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4922
diff changeset
16 Python environment using `virtualenv`. The advantages of this method over
7c952ea3d7b3 docs/installation: clarify and reorder alternative installation methods
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4922
diff changeset
17 direct installation is that Kallithea and its dependencies are completely
7c952ea3d7b3 docs/installation: clarify and reorder alternative installation methods
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4922
diff changeset
18 contained inside the virtualenv (which also means you can have multiple
7c952ea3d7b3 docs/installation: clarify and reorder alternative installation methods
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4922
diff changeset
19 installations side by side or remove it entirely by just removing the
7c952ea3d7b3 docs/installation: clarify and reorder alternative installation methods
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4922
diff changeset
20 virtualenv directory) and does not require root privileges.
4922
5e66d3ec9880 docs/installation: add section on installation from repository source
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4914
diff changeset
21
8688
7982eac0703d docs: drop documentation for installing without virtualenv
Mads Kiilerich <mads@kiilerich.com>
parents: 8635
diff changeset
22 - Kallithea can also be installed with plain pip - globally or with ``--user``
7982eac0703d docs: drop documentation for installing without virtualenv
Mads Kiilerich <mads@kiilerich.com>
parents: 8635
diff changeset
23 or similar. The package will be installed in the same location as all other
7982eac0703d docs: drop documentation for installing without virtualenv
Mads Kiilerich <mads@kiilerich.com>
parents: 8635
diff changeset
24 Python packages you have ever installed. As a result, removing it is not as
7982eac0703d docs: drop documentation for installing without virtualenv
Mads Kiilerich <mads@kiilerich.com>
parents: 8635
diff changeset
25 straightforward as with a virtualenv, as you'd have to remove its
7982eac0703d docs: drop documentation for installing without virtualenv
Mads Kiilerich <mads@kiilerich.com>
parents: 8635
diff changeset
26 dependencies manually and make sure that they are not needed by other
7982eac0703d docs: drop documentation for installing without virtualenv
Mads Kiilerich <mads@kiilerich.com>
parents: 8635
diff changeset
27 packages. We recommend using virtualenv.
4924
7c952ea3d7b3 docs/installation: clarify and reorder alternative installation methods
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4922
diff changeset
28
6001
23057179017f docs: add information about extra dependencies we now need
Andrew Shadura <andrew@shadura.me>
parents: 5954
diff changeset
29 Regardless of the installation method you may need to make sure you have
23057179017f docs: add information about extra dependencies we now need
Andrew Shadura <andrew@shadura.me>
parents: 5954
diff changeset
30 appropriate development packages installed, as installation of some of the
23057179017f docs: add information about extra dependencies we now need
Andrew Shadura <andrew@shadura.me>
parents: 5954
diff changeset
31 Kallithea dependencies requires a working C compiler and libffi library
23057179017f docs: add information about extra dependencies we now need
Andrew Shadura <andrew@shadura.me>
parents: 5954
diff changeset
32 headers. Depending on your configuration, you may also need to install
23057179017f docs: add information about extra dependencies we now need
Andrew Shadura <andrew@shadura.me>
parents: 5954
diff changeset
33 Git and development packages for the database of your choice.
23057179017f docs: add information about extra dependencies we now need
Andrew Shadura <andrew@shadura.me>
parents: 5954
diff changeset
34
23057179017f docs: add information about extra dependencies we now need
Andrew Shadura <andrew@shadura.me>
parents: 5954
diff changeset
35 For Debian and Ubuntu, the following command will ensure that a reasonable
23057179017f docs: add information about extra dependencies we now need
Andrew Shadura <andrew@shadura.me>
parents: 5954
diff changeset
36 set of dependencies is installed::
23057179017f docs: add information about extra dependencies we now need
Andrew Shadura <andrew@shadura.me>
parents: 5954
diff changeset
37
8209
01aca0a4f876 py3: officially support Python 3
Mads Kiilerich <mads@kiilerich.com>
parents: 8193
diff changeset
38 sudo apt-get install build-essential git libffi-dev python3-dev
6001
23057179017f docs: add information about extra dependencies we now need
Andrew Shadura <andrew@shadura.me>
parents: 5954
diff changeset
39
23057179017f docs: add information about extra dependencies we now need
Andrew Shadura <andrew@shadura.me>
parents: 5954
diff changeset
40 For Fedora and RHEL-derivatives, the following command will ensure that a
23057179017f docs: add information about extra dependencies we now need
Andrew Shadura <andrew@shadura.me>
parents: 5954
diff changeset
41 reasonable set of dependencies is installed::
23057179017f docs: add information about extra dependencies we now need
Andrew Shadura <andrew@shadura.me>
parents: 5954
diff changeset
42
8209
01aca0a4f876 py3: officially support Python 3
Mads Kiilerich <mads@kiilerich.com>
parents: 8193
diff changeset
43 sudo yum install gcc git libffi-devel python3-devel
6001
23057179017f docs: add information about extra dependencies we now need
Andrew Shadura <andrew@shadura.me>
parents: 5954
diff changeset
44
4924
7c952ea3d7b3 docs/installation: clarify and reorder alternative installation methods
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4922
diff changeset
45 .. _installation-source:
7c952ea3d7b3 docs/installation: clarify and reorder alternative installation methods
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4922
diff changeset
46
5433
fbbe80e3322b docs: consistent spacing around headings
Mads Kiilerich <madski@unity3d.com>
parents: 5425
diff changeset
47
4924
7c952ea3d7b3 docs/installation: clarify and reorder alternative installation methods
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4922
diff changeset
48 Installation from repository source
7c952ea3d7b3 docs/installation: clarify and reorder alternative installation methods
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4922
diff changeset
49 -----------------------------------
7c952ea3d7b3 docs/installation: clarify and reorder alternative installation methods
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4922
diff changeset
50
8193
89e9aef9b983 py3: use "python3 -m venv" instead of virtualenv package
Mads Kiilerich <mads@kiilerich.com>
parents: 7842
diff changeset
51 To install Kallithea in a virtualenv using the stable branch of the development
8608
fc54d9d65006 docs: clarify that the virtualenv activation assume bash
Mads Kiilerich <mads@kiilerich.com>
parents: 8209
diff changeset
52 repository, use the following commands in your bash shell::
4922
5e66d3ec9880 docs/installation: add section on installation from repository source
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4914
diff changeset
53
4989
8927a1ac8d41 docs: prepare for having a stable development branch
Mads Kiilerich <madski@unity3d.com>
parents: 4986
diff changeset
54 hg clone https://kallithea-scm.org/repos/kallithea -u stable
4922
5e66d3ec9880 docs/installation: add section on installation from repository source
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4914
diff changeset
55 cd kallithea
8634
6bab917402b4 docs: when using venv with a clone, recommend using 'venv' as location
Mads Kiilerich <mads@kiilerich.com>
parents: 8633
diff changeset
56 python3 -m venv venv
6bab917402b4 docs: when using venv with a clone, recommend using 'venv' as location
Mads Kiilerich <mads@kiilerich.com>
parents: 8633
diff changeset
57 . venv/bin/activate
5519
8c234ae2c258 docs: add advice of upgrading pip and setuptools in new virtualenvs
Mads Kiilerich <madski@unity3d.com>
parents: 5502
diff changeset
58 pip install --upgrade pip setuptools
6748
29e9cb56f26f docs: recommend --upgrade for all pip installations in a virtualenv
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 6339
diff changeset
59 pip install --upgrade -e .
8209
01aca0a4f876 py3: officially support Python 3
Mads Kiilerich <mads@kiilerich.com>
parents: 8193
diff changeset
60 python3 setup.py compile_catalog # for translation of the UI
4922
5e66d3ec9880 docs/installation: add section on installation from repository source
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4914
diff changeset
61
8632
bff02bfbe2d4 docs: clarify that "Installation from repository source" also will run from source
Mads Kiilerich <mads@kiilerich.com>
parents: 8618
diff changeset
62 .. note::
bff02bfbe2d4 docs: clarify that "Installation from repository source" also will run from source
Mads Kiilerich <mads@kiilerich.com>
parents: 8618
diff changeset
63 This will install all Python dependencies into the virtualenv. Kallithea
bff02bfbe2d4 docs: clarify that "Installation from repository source" also will run from source
Mads Kiilerich <mads@kiilerich.com>
parents: 8618
diff changeset
64 itself will however only be installed as a pointer to the source location.
bff02bfbe2d4 docs: clarify that "Installation from repository source" also will run from source
Mads Kiilerich <mads@kiilerich.com>
parents: 8618
diff changeset
65 The source clone must thus be kept in the same location, and it shouldn't be
bff02bfbe2d4 docs: clarify that "Installation from repository source" also will run from source
Mads Kiilerich <mads@kiilerich.com>
parents: 8618
diff changeset
66 updated to other revisions unless you want to upgrade. Edits in the source
bff02bfbe2d4 docs: clarify that "Installation from repository source" also will run from source
Mads Kiilerich <mads@kiilerich.com>
parents: 8618
diff changeset
67 tree will have immediate impact (possibly after a restart of the service).
bff02bfbe2d4 docs: clarify that "Installation from repository source" also will run from source
Mads Kiilerich <mads@kiilerich.com>
parents: 8618
diff changeset
68
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: 8608
diff changeset
69 You can now proceed to :ref:`install-front-end`.
4922
5e66d3ec9880 docs/installation: add section on installation from repository source
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4914
diff changeset
70
4924
7c952ea3d7b3 docs/installation: clarify and reorder alternative installation methods
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4922
diff changeset
71 .. _installation-virtualenv:
568
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
72
5433
fbbe80e3322b docs: consistent spacing around headings
Mads Kiilerich <madski@unity3d.com>
parents: 5425
diff changeset
73
4924
7c952ea3d7b3 docs/installation: clarify and reorder alternative installation methods
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4922
diff changeset
74 Installing a released version in a virtualenv
7c952ea3d7b3 docs/installation: clarify and reorder alternative installation methods
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4922
diff changeset
75 ---------------------------------------------
2358
69df04ee1e2b added detailed step-by-step installation instruction for windows
Marcin Kuzminski <marcin@python-works.com>
parents: 2351
diff changeset
76
8193
89e9aef9b983 py3: use "python3 -m venv" instead of virtualenv package
Mads Kiilerich <mads@kiilerich.com>
parents: 7842
diff changeset
77 It is highly recommended to use a separate virtualenv for installing Kallithea.
4902
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4814
diff changeset
78 This way, all libraries required by Kallithea will be installed separately from your
4924
7c952ea3d7b3 docs/installation: clarify and reorder alternative installation methods
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4922
diff changeset
79 main Python installation and other applications and things will be less
7c952ea3d7b3 docs/installation: clarify and reorder alternative installation methods
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4922
diff changeset
80 problematic when upgrading the system or Kallithea.
8193
89e9aef9b983 py3: use "python3 -m venv" instead of virtualenv package
Mads Kiilerich <mads@kiilerich.com>
parents: 7842
diff changeset
81 An additional benefit of virtualenv is that it doesn't require root privileges.
568
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
82
8633
c354d1a7537f docs: give "File system location" overview
Mads Kiilerich <mads@kiilerich.com>
parents: 8632
diff changeset
83 - Don't install as root - install as a dedicated user like ``kallithea``.
8634
6bab917402b4 docs: when using venv with a clone, recommend using 'venv' as location
Mads Kiilerich <mads@kiilerich.com>
parents: 8633
diff changeset
84 If necessary, create the top directory for the virtualenv (like
6bab917402b4 docs: when using venv with a clone, recommend using 'venv' as location
Mads Kiilerich <mads@kiilerich.com>
parents: 8633
diff changeset
85 ``/srv/kallithea/venv``) as root and assign ownership to the user.
8633
c354d1a7537f docs: give "File system location" overview
Mads Kiilerich <mads@kiilerich.com>
parents: 8632
diff changeset
86
8635
c819a1e9103b docs: clarify the idea of best practice of installing in srv
Mads Kiilerich <mads@kiilerich.com>
parents: 8634
diff changeset
87 Make a parent folder for the virtualenv (and perhaps also Kallithea
c819a1e9103b docs: clarify the idea of best practice of installing in srv
Mads Kiilerich <mads@kiilerich.com>
parents: 8634
diff changeset
88 configuration and data files) such as ``/srv/kallithea``. Create the
c819a1e9103b docs: clarify the idea of best practice of installing in srv
Mads Kiilerich <mads@kiilerich.com>
parents: 8634
diff changeset
89 directory as root if necessary and grant ownership to the ``kallithea`` user.
c819a1e9103b docs: clarify the idea of best practice of installing in srv
Mads Kiilerich <mads@kiilerich.com>
parents: 8634
diff changeset
90
8633
c354d1a7537f docs: give "File system location" overview
Mads Kiilerich <mads@kiilerich.com>
parents: 8632
diff changeset
91 - Create a new virtual environment, for example in ``/srv/kallithea/venv``,
c354d1a7537f docs: give "File system location" overview
Mads Kiilerich <mads@kiilerich.com>
parents: 8632
diff changeset
92 specifying the right Python binary::
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 568
diff changeset
93
8193
89e9aef9b983 py3: use "python3 -m venv" instead of virtualenv package
Mads Kiilerich <mads@kiilerich.com>
parents: 7842
diff changeset
94 python3 -m venv /srv/kallithea/venv
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 568
diff changeset
95
8193
89e9aef9b983 py3: use "python3 -m venv" instead of virtualenv package
Mads Kiilerich <mads@kiilerich.com>
parents: 7842
diff changeset
96 - Activate the virtualenv in your current shell session and make sure the
8608
fc54d9d65006 docs: clarify that the virtualenv activation assume bash
Mads Kiilerich <mads@kiilerich.com>
parents: 8209
diff changeset
97 basic requirements are up-to-date by running the following commands in your
fc54d9d65006 docs: clarify that the virtualenv activation assume bash
Mads Kiilerich <mads@kiilerich.com>
parents: 8209
diff changeset
98 bash shell::
1092
8af52e1224ff merge docs in beta with those corrected by Jason Harris
Marcin Kuzminski <marcin@python-works.com>
parents: 1062
diff changeset
99
6002
855ba1f07aeb docs: use ., not source, as the user isn't guaranteed to have it
Andrew Shadura <andrew@shadura.me>
parents: 6001
diff changeset
100 . /srv/kallithea/venv/bin/activate
5519
8c234ae2c258 docs: add advice of upgrading pip and setuptools in new virtualenvs
Mads Kiilerich <madski@unity3d.com>
parents: 5502
diff changeset
101 pip install --upgrade pip setuptools
1092
8af52e1224ff merge docs in beta with those corrected by Jason Harris
Marcin Kuzminski <marcin@python-works.com>
parents: 1062
diff changeset
102
8633
c354d1a7537f docs: give "File system location" overview
Mads Kiilerich <mads@kiilerich.com>
parents: 8632
diff changeset
103 .. note:: You can't use UNIX ``sudo`` to source the ``activate`` script; it
c354d1a7537f docs: give "File system location" overview
Mads Kiilerich <mads@kiilerich.com>
parents: 8632
diff changeset
104 will "activate" a shell that terminates immediately.
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3169
diff changeset
105
8633
c354d1a7537f docs: give "File system location" overview
Mads Kiilerich <mads@kiilerich.com>
parents: 8632
diff changeset
106 - Install Kallithea in the activated virtualenv::
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 568
diff changeset
107
6748
29e9cb56f26f docs: recommend --upgrade for all pip installations in a virtualenv
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 6339
diff changeset
108 pip install --upgrade kallithea
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3169
diff changeset
109
7842
3a3d96dbd445 docs: clean up installation of optional dependencies
Mads Kiilerich <mads@kiilerich.com>
parents: 7626
diff changeset
110 .. note:: Some dependencies are optional. If you need them, install them in
3a3d96dbd445 docs: clean up installation of optional dependencies
Mads Kiilerich <mads@kiilerich.com>
parents: 7626
diff changeset
111 the virtualenv too::
3a3d96dbd445 docs: clean up installation of optional dependencies
Mads Kiilerich <mads@kiilerich.com>
parents: 7626
diff changeset
112
3a3d96dbd445 docs: clean up installation of optional dependencies
Mads Kiilerich <mads@kiilerich.com>
parents: 7626
diff changeset
113 pip install --upgrade kallithea python-ldap python-pam psycopg2
3a3d96dbd445 docs: clean up installation of optional dependencies
Mads Kiilerich <mads@kiilerich.com>
parents: 7626
diff changeset
114
3a3d96dbd445 docs: clean up installation of optional dependencies
Mads Kiilerich <mads@kiilerich.com>
parents: 7626
diff changeset
115 This might require installation of development packages using your
3a3d96dbd445 docs: clean up installation of optional dependencies
Mads Kiilerich <mads@kiilerich.com>
parents: 7626
diff changeset
116 distribution's package manager.
3a3d96dbd445 docs: clean up installation of optional dependencies
Mads Kiilerich <mads@kiilerich.com>
parents: 7626
diff changeset
117
8618
a8980488b6ce docs: fix display of 'note' in installation
Thomas De Schampheleire <thomas.de_schampheleire@nokia.com>
parents: 8613
diff changeset
118 Alternatively, download a .tar.gz from http://pypi.python.org/pypi/Kallithea,
a8980488b6ce docs: fix display of 'note' in installation
Thomas De Schampheleire <thomas.de_schampheleire@nokia.com>
parents: 8613
diff changeset
119 extract it and install from source by running::
4902
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4814
diff changeset
120
8618
a8980488b6ce docs: fix display of 'note' in installation
Thomas De Schampheleire <thomas.de_schampheleire@nokia.com>
parents: 8613
diff changeset
121 pip install --upgrade .
4902
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4814
diff changeset
122
6339
8845ece50d51 docs: remove some references to Pylons
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 6002
diff changeset
123 - This will install Kallithea together with all other required
8845ece50d51 docs: remove some references to Pylons
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 6002
diff changeset
124 Python libraries into the activated virtualenv.
4902
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4814
diff changeset
125
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: 8608
diff changeset
126 You can now proceed to :ref:`install-front-end`.
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 568
diff changeset
127
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: 8608
diff changeset
128
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: 8608
diff changeset
129 Prepare front-end files
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: 8608
diff changeset
130 -----------------------
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: 8608
diff changeset
131
8613
0765771dbe5a docs: clarify the need for having 'npm' and 'node' available in $PATH
Mads Kiilerich <mads@kiilerich.com>
parents: 8612
diff changeset
132 Finally, the front-end files with CSS and JavaScript must be prepared. This
0765771dbe5a docs: clarify the need for having 'npm' and 'node' available in $PATH
Mads Kiilerich <mads@kiilerich.com>
parents: 8612
diff changeset
133 depends on having some commands available in the shell search path: ``npm``
0765771dbe5a docs: clarify the need for having 'npm' and 'node' available in $PATH
Mads Kiilerich <mads@kiilerich.com>
parents: 8612
diff changeset
134 version 6 or later, and ``node.js`` (version 12 or later) available as
0765771dbe5a docs: clarify the need for having 'npm' and 'node' available in $PATH
Mads Kiilerich <mads@kiilerich.com>
parents: 8612
diff changeset
135 ``node``. The installation method for these dependencies varies between
0765771dbe5a docs: clarify the need for having 'npm' and 'node' available in $PATH
Mads Kiilerich <mads@kiilerich.com>
parents: 8612
diff changeset
136 operating systems and distributions.
0765771dbe5a docs: clarify the need for having 'npm' and 'node' available in $PATH
Mads Kiilerich <mads@kiilerich.com>
parents: 8612
diff changeset
137
0765771dbe5a docs: clarify the need for having 'npm' and 'node' available in $PATH
Mads Kiilerich <mads@kiilerich.com>
parents: 8612
diff changeset
138 Prepare the front-end by running::
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: 8608
diff changeset
139
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: 8608
diff changeset
140 kallithea-cli front-end-build
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: 8608
diff changeset
141
4924
7c952ea3d7b3 docs/installation: clarify and reorder alternative installation methods
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4922
diff changeset
142 You can now proceed to :ref:`setup`.