Mercurial > kallithea

comparison docs/installation_win.rst @ 5435:60e04a21bf0f

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
docs: more consistent use of --
author Mads Kiilerich <madski@unity3d.com>
date Wed, 26 Aug 2015 17:28:58 +0200
parents 8867673c8192
children ae9ab4c92d46
comparison
equal deleted inserted replaced
5434:8867673c8192 5435:60e04a21bf0f
12 12
13 Tested on Windows 8.1, Windows Server 2008 R2 and Windows Server 2012 13 Tested on Windows 8.1, Windows Server 2008 R2 and Windows Server 2012
14 14
15 To install on an older version of Windows, see `<installation_win_old.html>`_ 15 To install on an older version of Windows, see `<installation_win_old.html>`_
16 16
17 Step 1 - Install Python 17 Step 1 -- Install Python
18 ----------------------- 18 ------------------------
19 19
20 Install Python 2.x.y (x = 6 or 7). Latest version is recommended. If you need another version, they can run side by side. 20 Install Python 2.x.y (x = 6 or 7). Latest version is recommended. If you need another version, they can run side by side.
21 21
22 .. warning:: Python 3.x is not supported. 22 .. warning:: Python 3.x is not supported.
23 23
28 28
29 While writing this guide, the latest version was v2.7.9. 29 While writing this guide, the latest version was v2.7.9.
30 Remember the specific major and minor versions installed, because they will 30 Remember the specific major and minor versions installed, because they will
31 be needed in the next step. In this case, it is "2.7". 31 be needed in the next step. In this case, it is "2.7".
32 32
33 Step 2 - Python BIN 33 Step 2 -- Python BIN
34 ------------------- 34 --------------------
35 35
36 Add Python BIN folder to the path. This can be done manually (editing 36 Add Python BIN folder to the path. This can be done manually (editing
37 "PATH" environment variable) or by using Windows Support Tools that 37 "PATH" environment variable) or by using Windows Support Tools that
38 come pre-installed in Windows Vista/7 and later. 38 come pre-installed in Windows Vista/7 and later.
39 39
42 SETX PATH "%PATH%;[your-python-path]" /M 42 SETX PATH "%PATH%;[your-python-path]" /M
43 43
44 Please substitute [your-python-path] with your Python installation 44 Please substitute [your-python-path] with your Python installation
45 path. Typically this is ``C:\\Python27``. 45 path. Typically this is ``C:\\Python27``.
46 46
47 Step 3 - Install pywin32 extensions 47 Step 3 -- Install pywin32 extensions
48 ----------------------------------- 48 ------------------------------------
49 49
50 Download pywin32 from: 50 Download pywin32 from:
51 http://sourceforge.net/projects/pywin32/files/ 51 http://sourceforge.net/projects/pywin32/files/
52 52
53 - Click on "pywin32" folder 53 - Click on "pywin32" folder
58 http://sourceforge.net/projects/pywin32/files/pywin32/Build%20219/pywin32-219.win-amd64-py2.7.exe/download 58 http://sourceforge.net/projects/pywin32/files/pywin32/Build%20219/pywin32-219.win-amd64-py2.7.exe/download
59 (x64) 59 (x64)
60 http://sourceforge.net/projects/pywin32/files/pywin32/Build%20219/pywin32-219.win32-py2.7.exe/download 60 http://sourceforge.net/projects/pywin32/files/pywin32/Build%20219/pywin32-219.win32-py2.7.exe/download
61 (Win32) 61 (Win32)
62 62
63 Step 4 - Install pip 63 Step 4 -- Install pip
64 -------------------- 64 ---------------------
65 65
66 pip is a package management system for Python. You will need it to install Kallithea and its dependencies. 66 pip is a package management system for Python. You will need it to install Kallithea and its dependencies.
67 67
68 If you installed Python 2.7.9+, you already have it (as long as you ran the installer with admin privileges or disabled UAC). 68 If you installed Python 2.7.9+, you already have it (as long as you ran the installer with admin privileges or disabled UAC).
69 69
82 Scripts folder, which is likely not on your path. To correct this, 82 Scripts folder, which is likely not on your path. To correct this,
83 open a CMD and type:: 83 open a CMD and type::
84 84
85 SETX PATH "%PATH%;[your-python-path]\Scripts" /M 85 SETX PATH "%PATH%;[your-python-path]\Scripts" /M
86 86
87 Step 5 - Kallithea folder structure 87 Step 5 -- Kallithea folder structure
88 ----------------------------------- 88 ------------------------------------
89 89
90 Create a Kallithea folder structure. 90 Create a Kallithea folder structure.
91 91
92 This is only an example to install Kallithea. Of course, you can 92 This is only an example to install Kallithea. Of course, you can
93 change it. However, this guide will follow the proposed structure, so 93 change it. However, this guide will follow the proposed structure, so
99 C:\Kallithea 99 C:\Kallithea
100 C:\Kallithea\Bin 100 C:\Kallithea\Bin
101 C:\Kallithea\Env 101 C:\Kallithea\Env
102 C:\Kallithea\Repos 102 C:\Kallithea\Repos
103 103
104 Step 6 - Install virtualenv 104 Step 6 -- Install virtualenv
105 --------------------------- 105 ----------------------------
106 106
107 .. note:: 107 .. note::
108 A python virtual environment will allow for isolation between the Python packages of your system and those used for Kallithea. 108 A python virtual environment will allow for isolation between the Python packages of your system and those used for Kallithea.
109 It is strongly recommended to use it to ensure that Kallithea does not change a dependency that other software uses or vice versa. 109 It is strongly recommended to use it to ensure that Kallithea does not change a dependency that other software uses or vice versa.
110 110
116 116
117 To create a virtual environment, run:: 117 To create a virtual environment, run::
118 118
119 virtualenv C:\Kallithea\Env 119 virtualenv C:\Kallithea\Env
120 120
121 Step 7 - Install Kallithea 121 Step 7 -- Install Kallithea
122 -------------------------- 122 ---------------------------
123 123
124 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. 124 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.
125 Some Python packages use managed code and need to be compiled. 125 Some Python packages use managed code and need to be compiled.
126 This can be done on Linux without any special steps. On Windows, you will need to install Microsoft Visual C++ compiler for Python 2.7. 126 This can be done on Linux without any special steps. On Windows, you will need to install Microsoft Visual C++ compiler for Python 2.7.
127 127
142 142
143 .. note:: This will take some time. Please wait patiently until it is fully 143 .. note:: This will take some time. Please wait patiently until it is fully
144 complete. Some warnings will appear. Don't worry, they are 144 complete. Some warnings will appear. Don't worry, they are
145 normal. 145 normal.
146 146
147 Step 8 - Install git (optional) 147 Step 8 -- Install git (optional)
148 --------------------------------
149
150 Mercurial being a python package, it was installed automatically when doing "pip install kallithea".
151
152 You need to install git manually if you want Kallithea to be able to host git repositories.
153
154 See http://git-scm.com/book/en/v2/Getting-Started-Installing-Git#Installing-on-Windows for instructions.
155
156 Step 9 -- Configuring Kallithea
148 ------------------------------- 157 -------------------------------
149
150 Mercurial being a python package, it was installed automatically when doing "pip install kallithea".
151
152 You need to install git manually if you want Kallithea to be able to host git repositories.
153
154 See http://git-scm.com/book/en/v2/Getting-Started-Installing-Git#Installing-on-Windows for instructions.
155
156 Step 9 - Configuring Kallithea
157 ------------------------------
158 158
159 Steps taken from `<setup.html>`_ 159 Steps taken from `<setup.html>`_
160 160
161 You have to use the same command prompt as in Step 7, so if you closed 161 You have to use the same command prompt as in Step 7, so if you closed
162 it, reopen it following the same commands (including the "activate" 162 it, reopen it following the same commands (including the "activate"
190 190
191 If you make a mistake and the script doesn't end, don't worry: start it again. 191 If you make a mistake and the script doesn't end, don't worry: start it again.
192 192
193 If you decided not to install git, you will get errors about it that you can ignore. 193 If you decided not to install git, you will get errors about it that you can ignore.
194 194
195 Step 10 - Running Kallithea 195 Step 10 -- Running Kallithea
196 --------------------------- 196 ----------------------------
197 197
198 In the previous command prompt, being in the C:\\Kallithea\\Bin folder, type:: 198 In the previous command prompt, being in the C:\\Kallithea\\Bin folder, type::
199 199
200 paster serve production.ini 200 paster serve production.ini
201 201