Mercurial > kallithea
annotate docs/installation_win.rst @ 8769:d35d14b05b82
diff: handle some escaped characters in Git diffs
There are some odd characters (like \r and \n) that the Kallithea UI doesn't
allow in filenames in repos. Kallithea (through the routes module) will fail to
generate URLs when browsing Files. That is a known limitation with minimal
real-world impact, non-trivial to work around or fix.
There are very few relevant use cases for tracking files with odd filenames. \t
is valid but is hard to render in a meaningful way in the UI. And ASCII
characters like \ and " are not usable on Windows and should just be avoided.
Kallithea would parse Git diffs with odd characers incorrectly or fail, even
before hitting the known limitation. With this change, Kallithea will parse
diffs with odd filenames correctly (and then hit the limitation).
Git will quote odd filenames and escape the odd characters when emitting diffs.
(Mercurial does by design not allow \r and \n , and Mercurial will thus never
have to quote file names in diffs.)
Quotes are already handled (and ignored). With this change, Kallithea will
handle \ unescaping of \\ and \", the usual letters like \r and \n and \t, and
octal numbers like \033 (for ESC) .
Filenames with \ and " will work perfectly (when not on Windows).
Filenames with \t and ESC will work fine, but without helpful display in the
UI.
Filenames with \r and \n will still make the UI fail when trying to generate
URLs.
Thanks to stypr of Flatt Security for raising this.
author | Mads Kiilerich <mads@kiilerich.com> |
---|---|
date | Sat, 14 Nov 2020 15:41:39 +0100 |
parents | 01aca0a4f876 |
children | 0a9ddb8cd8c1 |
rev | line source |
---|---|
4815
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
1 .. _installation_win: |
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
2 |
8209
01aca0a4f876
py3: officially support Python 3
Mads Kiilerich <mads@kiilerich.com>
parents:
8193
diff
changeset
|
3 .. warning:: This section is outdated and needs updating for Python 3. |
01aca0a4f876
py3: officially support Python 3
Mads Kiilerich <mads@kiilerich.com>
parents:
8193
diff
changeset
|
4 |
5954
8075ec3d0233
docs: restructure Kallithea upgrade instructions
Søren Løvborg <sorenl@unity3d.com>
parents:
5575
diff
changeset
|
5 ==================================================== |
8075ec3d0233
docs: restructure Kallithea upgrade instructions
Søren Løvborg <sorenl@unity3d.com>
parents:
5575
diff
changeset
|
6 Installation on Windows (7/Server 2008 R2 and newer) |
8075ec3d0233
docs: restructure Kallithea upgrade instructions
Søren Løvborg <sorenl@unity3d.com>
parents:
5575
diff
changeset
|
7 ==================================================== |
4815
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
8 |
5433
fbbe80e3322b
docs: consistent spacing around headings
Mads Kiilerich <madski@unity3d.com>
parents:
5413
diff
changeset
|
9 |
4815
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
10 First time install |
5575
ed2fb6e84a02
docs: use consistent style for section titles
Mads Kiilerich <madski@unity3d.com>
parents:
5519
diff
changeset
|
11 ------------------ |
4815
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
12 |
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
13 Target OS: Windows 7 and newer or Windows Server 2008 R2 and newer |
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
14 |
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
15 Tested on Windows 8.1, Windows Server 2008 R2 and Windows Server 2012 |
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
16 |
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
17 To install on an older version of Windows, see `<installation_win_old.html>`_ |
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
18 |
5435
60e04a21bf0f
docs: more consistent use of --
Mads Kiilerich <madski@unity3d.com>
parents:
5434
diff
changeset
|
19 Step 1 -- Install Python |
5575
ed2fb6e84a02
docs: use consistent style for section titles
Mads Kiilerich <madski@unity3d.com>
parents:
5519
diff
changeset
|
20 ^^^^^^^^^^^^^^^^^^^^^^^^ |
4815
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
21 |
8209
01aca0a4f876
py3: officially support Python 3
Mads Kiilerich <mads@kiilerich.com>
parents:
8193
diff
changeset
|
22 Install Python 3. Latest version is recommended. If you need another version, they can run side by side. |
4815
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
23 |
8209
01aca0a4f876
py3: officially support Python 3
Mads Kiilerich <mads@kiilerich.com>
parents:
8193
diff
changeset
|
24 - Download Python 3 from http://www.python.org/download/ |
4815
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
25 - Choose and click on the version |
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
26 - Click on "Windows X86-64 Installer" for x64 or "Windows x86 MSI installer" for Win32. |
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
27 - Disable UAC or run the installer with admin privileges. If you chose to disable UAC, do not forget to reboot afterwards. |
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
28 |
8209
01aca0a4f876
py3: officially support Python 3
Mads Kiilerich <mads@kiilerich.com>
parents:
8193
diff
changeset
|
29 While writing this guide, the latest version was v3.8.1. |
4815
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
30 Remember the specific major and minor versions installed, because they will |
8209
01aca0a4f876
py3: officially support Python 3
Mads Kiilerich <mads@kiilerich.com>
parents:
8193
diff
changeset
|
31 be needed in the next step. In this case, it is "3.8". |
4815
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
32 |
5435
60e04a21bf0f
docs: more consistent use of --
Mads Kiilerich <madski@unity3d.com>
parents:
5434
diff
changeset
|
33 Step 2 -- Python BIN |
5575
ed2fb6e84a02
docs: use consistent style for section titles
Mads Kiilerich <madski@unity3d.com>
parents:
5519
diff
changeset
|
34 ^^^^^^^^^^^^^^^^^^^^ |
4815
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
35 |
4955
4e6dfdb3fa01
docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents:
4902
diff
changeset
|
36 Add Python BIN folder to the path. This can be done manually (editing |
4e6dfdb3fa01
docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents:
4902
diff
changeset
|
37 "PATH" environment variable) or by using Windows Support Tools that |
4e6dfdb3fa01
docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents:
4902
diff
changeset
|
38 come pre-installed in Windows Vista/7 and later. |
4815
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
39 |
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
40 Open a CMD and type:: |
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
41 |
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
42 SETX PATH "%PATH%;[your-python-path]" /M |
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
43 |
4955
4e6dfdb3fa01
docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents:
4902
diff
changeset
|
44 Please substitute [your-python-path] with your Python installation |
8209
01aca0a4f876
py3: officially support Python 3
Mads Kiilerich <mads@kiilerich.com>
parents:
8193
diff
changeset
|
45 path. Typically this is ``C:\\Python38``. |
4815
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
46 |
5435
60e04a21bf0f
docs: more consistent use of --
Mads Kiilerich <madski@unity3d.com>
parents:
5434
diff
changeset
|
47 Step 3 -- Install pywin32 extensions |
5575
ed2fb6e84a02
docs: use consistent style for section titles
Mads Kiilerich <madski@unity3d.com>
parents:
5519
diff
changeset
|
48 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
4815
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
49 |
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
50 Download pywin32 from: |
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
51 http://sourceforge.net/projects/pywin32/files/ |
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
52 |
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
53 - Click on "pywin32" folder |
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
54 - Click on the first folder (in this case, Build 219, maybe newer when you try) |
8209
01aca0a4f876
py3: officially support Python 3
Mads Kiilerich <mads@kiilerich.com>
parents:
8193
diff
changeset
|
55 - Choose the file ending with ".amd64-py3.x.exe" (".win32-py3.x.exe" |
4955
4e6dfdb3fa01
docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents:
4902
diff
changeset
|
56 for Win32) where x is the minor version of Python you installed. |
4e6dfdb3fa01
docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents:
4902
diff
changeset
|
57 When writing this guide, the file was: |
8209
01aca0a4f876
py3: officially support Python 3
Mads Kiilerich <mads@kiilerich.com>
parents:
8193
diff
changeset
|
58 http://sourceforge.net/projects/pywin32/files/pywin32/Build%20219/pywin32-219.win-amd64-py3.8.exe/download |
4955
4e6dfdb3fa01
docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents:
4902
diff
changeset
|
59 (x64) |
8209
01aca0a4f876
py3: officially support Python 3
Mads Kiilerich <mads@kiilerich.com>
parents:
8193
diff
changeset
|
60 http://sourceforge.net/projects/pywin32/files/pywin32/Build%20219/pywin32-219.win32-py3.8.exe/download |
4955
4e6dfdb3fa01
docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents:
4902
diff
changeset
|
61 (Win32) |
4815
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
62 |
5435
60e04a21bf0f
docs: more consistent use of --
Mads Kiilerich <madski@unity3d.com>
parents:
5434
diff
changeset
|
63 Step 5 -- Kallithea folder structure |
5575
ed2fb6e84a02
docs: use consistent style for section titles
Mads Kiilerich <madski@unity3d.com>
parents:
5519
diff
changeset
|
64 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
4815
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
65 |
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
66 Create a Kallithea folder structure. |
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
67 |
4955
4e6dfdb3fa01
docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents:
4902
diff
changeset
|
68 This is only an example to install Kallithea. Of course, you can |
4e6dfdb3fa01
docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents:
4902
diff
changeset
|
69 change it. However, this guide will follow the proposed structure, so |
4e6dfdb3fa01
docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents:
4902
diff
changeset
|
70 please later adapt the paths if you change them. Folders without |
4e6dfdb3fa01
docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents:
4902
diff
changeset
|
71 spaces are recommended. |
4815
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
72 |
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
73 Create the following folder structure:: |
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
74 |
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
75 C:\Kallithea |
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
76 C:\Kallithea\Bin |
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
77 C:\Kallithea\Env |
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
78 C:\Kallithea\Repos |
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
79 |
5435
60e04a21bf0f
docs: more consistent use of --
Mads Kiilerich <madski@unity3d.com>
parents:
5434
diff
changeset
|
80 Step 6 -- Install virtualenv |
5575
ed2fb6e84a02
docs: use consistent style for section titles
Mads Kiilerich <madski@unity3d.com>
parents:
5519
diff
changeset
|
81 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
4815
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
82 |
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
83 .. note:: |
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
84 A python virtual environment will allow for isolation between the Python packages of your system and those used for Kallithea. |
4955
4e6dfdb3fa01
docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents:
4902
diff
changeset
|
85 It is strongly recommended to use it to ensure that Kallithea does not change a dependency that other software uses or vice versa. |
4815
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
86 |
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
87 To create a virtual environment, run:: |
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
88 |
8193
89e9aef9b983
py3: use "python3 -m venv" instead of virtualenv package
Mads Kiilerich <mads@kiilerich.com>
parents:
7791
diff
changeset
|
89 python3 -m venv C:\Kallithea\Env |
4815
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
90 |
5435
60e04a21bf0f
docs: more consistent use of --
Mads Kiilerich <madski@unity3d.com>
parents:
5434
diff
changeset
|
91 Step 7 -- Install Kallithea |
5575
ed2fb6e84a02
docs: use consistent style for section titles
Mads Kiilerich <madski@unity3d.com>
parents:
5519
diff
changeset
|
92 ^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
4815
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
93 |
4955
4e6dfdb3fa01
docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents:
4902
diff
changeset
|
94 In order to install Kallithea, you need to be able to run "pip install kallithea". It will use pip to install the Kallithea Python package and its dependencies. |
4815
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
95 Some Python packages use managed code and need to be compiled. |
8209
01aca0a4f876
py3: officially support Python 3
Mads Kiilerich <mads@kiilerich.com>
parents:
8193
diff
changeset
|
96 This can be done on Linux without any special steps. On Windows, you will need to install Microsoft Visual C++ compiler for Python 3.8. |
4815
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
97 |
8209
01aca0a4f876
py3: officially support Python 3
Mads Kiilerich <mads@kiilerich.com>
parents:
8193
diff
changeset
|
98 Download and install "Microsoft Visual C++ Compiler for Python 3.8" from http://aka.ms/vcpython27 |
4815
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
99 |
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
100 .. note:: |
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
101 You can also install the dependencies using already compiled Windows binaries packages. A good source of compiled Python packages is http://www.lfd.uci.edu/~gohlke/pythonlibs/. However, not all of the necessary packages for Kallithea are on this site and some are hard to find, so we will stick with using the compiler. |
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
102 |
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
103 In a command prompt type (adapting paths if necessary):: |
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
104 |
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
105 cd C:\Kallithea\Env\Scripts |
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
106 activate |
5519
8c234ae2c258
docs: add advice of upgrading pip and setuptools in new virtualenvs
Mads Kiilerich <madski@unity3d.com>
parents:
5502
diff
changeset
|
107 pip install --upgrade pip setuptools |
4815
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
108 |
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
109 The prompt will change into "(Env) C:\\Kallithea\\Env\\Scripts" or similar |
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
110 (depending of your folder structure). Then type:: |
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
111 |
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
112 pip install kallithea |
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
113 |
4955
4e6dfdb3fa01
docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents:
4902
diff
changeset
|
114 .. note:: This will take some time. Please wait patiently until it is fully |
4e6dfdb3fa01
docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents:
4902
diff
changeset
|
115 complete. Some warnings will appear. Don't worry, they are |
4e6dfdb3fa01
docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents:
4902
diff
changeset
|
116 normal. |
4815
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
117 |
5975
d9e6e489f171
docs: reminder to add c:\path\to\git\bin to PATH
domruf <dominikruf@gmail.com>
parents:
5954
diff
changeset
|
118 Step 8 -- Install Git (optional) |
5575
ed2fb6e84a02
docs: use consistent style for section titles
Mads Kiilerich <madski@unity3d.com>
parents:
5519
diff
changeset
|
119 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
4955
4e6dfdb3fa01
docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents:
4902
diff
changeset
|
120 |
5975
d9e6e489f171
docs: reminder to add c:\path\to\git\bin to PATH
domruf <dominikruf@gmail.com>
parents:
5954
diff
changeset
|
121 Mercurial being a python package, was installed automatically when doing ``pip install kallithea``. |
4815
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
122 |
5975
d9e6e489f171
docs: reminder to add c:\path\to\git\bin to PATH
domruf <dominikruf@gmail.com>
parents:
5954
diff
changeset
|
123 You need to install Git manually if you want Kallithea to be able to host Git repositories. |
4815
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
124 See http://git-scm.com/book/en/v2/Getting-Started-Installing-Git#Installing-on-Windows for instructions. |
5975
d9e6e489f171
docs: reminder to add c:\path\to\git\bin to PATH
domruf <dominikruf@gmail.com>
parents:
5954
diff
changeset
|
125 The location of the Git binaries (like ``c:\path\to\git\bin``) must be |
d9e6e489f171
docs: reminder to add c:\path\to\git\bin to PATH
domruf <dominikruf@gmail.com>
parents:
5954
diff
changeset
|
126 added to the ``PATH`` environment variable so ``git.exe`` and other tools like |
d9e6e489f171
docs: reminder to add c:\path\to\git\bin to PATH
domruf <dominikruf@gmail.com>
parents:
5954
diff
changeset
|
127 ``gzip.exe`` are available. |
4815
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
128 |
5435
60e04a21bf0f
docs: more consistent use of --
Mads Kiilerich <madski@unity3d.com>
parents:
5434
diff
changeset
|
129 Step 9 -- Configuring Kallithea |
5575
ed2fb6e84a02
docs: use consistent style for section titles
Mads Kiilerich <madski@unity3d.com>
parents:
5519
diff
changeset
|
130 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
4815
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
131 |
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
132 Steps taken from `<setup.html>`_ |
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
133 |
4955
4e6dfdb3fa01
docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents:
4902
diff
changeset
|
134 You have to use the same command prompt as in Step 7, so if you closed |
4e6dfdb3fa01
docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents:
4902
diff
changeset
|
135 it, reopen it following the same commands (including the "activate" |
4e6dfdb3fa01
docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents:
4902
diff
changeset
|
136 one). When ready, type:: |
4815
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
137 |
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
138 cd C:\Kallithea\Bin |
7406
7784a1212471
cli: convert 'gearbox make-config' into 'kallithea-cli config-create'
Thomas De Schampheleire <thomas.de_schampheleire@nokia.com>
parents:
7389
diff
changeset
|
139 kallithea-cli config-create my.ini |
4815
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
140 |
7389
0955a02f7170
docs: align use of 'my.ini' as configfile placeholder
Thomas De Schampheleire <thomas.de_schampheleire@nokia.com>
parents:
6555
diff
changeset
|
141 Then you must edit my.ini to fit your needs (IP address, IP |
4955
4e6dfdb3fa01
docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents:
4902
diff
changeset
|
142 port, mail settings, database, etc.). `NotePad++`__ or a similar text |
4e6dfdb3fa01
docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents:
4902
diff
changeset
|
143 editor is recommended to properly handle the newline character |
4e6dfdb3fa01
docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents:
4902
diff
changeset
|
144 differences between Unix and Windows. |
4815
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
145 |
4955
4e6dfdb3fa01
docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents:
4902
diff
changeset
|
146 __ http://notepad-plus-plus.org/ |
4e6dfdb3fa01
docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents:
4902
diff
changeset
|
147 |
4e6dfdb3fa01
docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents:
4902
diff
changeset
|
148 For the sake of simplicity, run it with the default settings. After your edits (if any) in the previous command prompt, type:: |
4815
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
149 |
7414
3158cf0dafb7
cli: convert 'gearbox setup-db' into 'kallithea-cli db-create'
Thomas De Schampheleire <thomas.de_schampheleire@nokia.com>
parents:
7406
diff
changeset
|
150 kallithea-cli db-create -c my.ini |
4815
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
151 |
4955
4e6dfdb3fa01
docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents:
4902
diff
changeset
|
152 .. warning:: This time a *new* database will be installed. You must |
5954
8075ec3d0233
docs: restructure Kallithea upgrade instructions
Søren Løvborg <sorenl@unity3d.com>
parents:
5575
diff
changeset
|
153 follow a different process to later :ref:`upgrade <upgrade>` |
8075ec3d0233
docs: restructure Kallithea upgrade instructions
Søren Løvborg <sorenl@unity3d.com>
parents:
5575
diff
changeset
|
154 to a newer Kallithea version. |
4815
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
155 |
4955
4e6dfdb3fa01
docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents:
4902
diff
changeset
|
156 The script will ask you for confirmation about creating a new database, answer yes (y) |
4815
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
157 |
4955
4e6dfdb3fa01
docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents:
4902
diff
changeset
|
158 The script will ask you for the repository path, answer C:\\Kallithea\\Repos (or similar). |
4815
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
159 |
4955
4e6dfdb3fa01
docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents:
4902
diff
changeset
|
160 The script will ask you for the admin username and password, answer "admin" + "123456" (or whatever you want) |
4815
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
161 |
4955
4e6dfdb3fa01
docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents:
4902
diff
changeset
|
162 The script will ask you for admin mail, answer "admin@xxxx.com" (or whatever you want). |
4815
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
163 |
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
164 If you make a mistake and the script doesn't end, don't worry: start it again. |
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
165 |
5975
d9e6e489f171
docs: reminder to add c:\path\to\git\bin to PATH
domruf <dominikruf@gmail.com>
parents:
5954
diff
changeset
|
166 If you decided not to install Git, you will get errors about it that you can ignore. |
4815
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
167 |
5435
60e04a21bf0f
docs: more consistent use of --
Mads Kiilerich <madski@unity3d.com>
parents:
5434
diff
changeset
|
168 Step 10 -- Running Kallithea |
5575
ed2fb6e84a02
docs: use consistent style for section titles
Mads Kiilerich <madski@unity3d.com>
parents:
5519
diff
changeset
|
169 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
4815
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
170 |
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
171 In the previous command prompt, being in the C:\\Kallithea\\Bin folder, type:: |
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
172 |
7389
0955a02f7170
docs: align use of 'my.ini' as configfile placeholder
Thomas De Schampheleire <thomas.de_schampheleire@nokia.com>
parents:
6555
diff
changeset
|
173 gearbox serve -c my.ini |
4815
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
174 |
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
175 Open your web server, and go to http://127.0.0.1:5000 |
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
176 |
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
177 It works!! :-) |
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
178 |
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
179 Remark: |
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
180 If it does not work the first time, Ctrl-C the CMD process and start it again. Don't forget the "http://" in Internet Explorer. |
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
181 |
4955
4e6dfdb3fa01
docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents:
4902
diff
changeset
|
182 What this guide does not cover: |
4815
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
183 |
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
184 - Installing Celery |
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
185 - Running Kallithea as a Windows Service. You can investigate here: |
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
186 |
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
187 - http://pypi.python.org/pypi/wsgisvc |
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
188 - http://ryrobes.com/python/running-python-scripts-as-a-windows-service/ |
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
189 - http://wiki.pylonshq.com/display/pylonscookbook/How+to+run+Pylons+as+a+Windows+service |
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
190 |
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
191 - Using Apache. You can investigate here: |
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
192 |
64b1a2320bcb
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents:
diff
changeset
|
193 - https://groups.google.com/group/rhodecode/msg/c433074e813ffdc4 |