kallithea: docs/installation

annotate docs/installation_win.rst @ 5478:23f8f477ed35 stable

release: set version number to 0.2.9 to hint that it is a 0.3 rc I don't trust the rc numbering system in kallithea/__init__.py and how it interacts with pip versioning.

author	Mads Kiilerich <madski@unity3d.com>
date	Sun, 06 Sep 2015 23:38:08 +0200
parents	60e04a21bf0f
children	ae9ab4c92d46

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
5413 22a3fa3c4254 docs: cleanup of casing, markup and spacing of headings Mads Kiilerich <madski@unity3d.com> parents: 4955 diff changeset	3 ================================================================
4815 64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer Denis Blanchette <dblanchette@coveo.com> parents: diff changeset	4 Installation and upgrade on Windows (7/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	5 ================================================================
64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer Denis Blanchette <dblanchette@coveo.com> parents: diff changeset	6
5433 fbbe80e3322b docs: consistent spacing around headings Mads Kiilerich <madski@unity3d.com> parents: 5413 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 First time install
64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer Denis Blanchette <dblanchette@coveo.com> parents: diff changeset	9 ::::::::::::::::::
64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer Denis Blanchette <dblanchette@coveo.com> parents: diff changeset	10
64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer Denis Blanchette <dblanchette@coveo.com> parents: diff changeset	11 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	12
64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer Denis Blanchette <dblanchette@coveo.com> parents: diff changeset	13 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	14
64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer Denis Blanchette <dblanchette@coveo.com> parents: diff changeset	15 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	16
5435 60e04a21bf0f docs: more consistent use of -- Mads Kiilerich <madski@unity3d.com> parents: 5434 diff changeset	17 Step 1 -- Install Python
60e04a21bf0f docs: more consistent use of -- Mads Kiilerich <madski@unity3d.com> parents: 5434 diff changeset	18 ------------------------
4815 64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer Denis Blanchette <dblanchette@coveo.com> parents: diff changeset	19
64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer Denis Blanchette <dblanchette@coveo.com> parents: diff changeset	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.
64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer Denis Blanchette <dblanchette@coveo.com> parents: diff changeset	21
4955 4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4902 diff changeset	22 .. warning:: Python 3.x is not supported.
4815 64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer Denis Blanchette <dblanchette@coveo.com> parents: diff changeset	23
64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer Denis Blanchette <dblanchette@coveo.com> parents: diff changeset	24 - Download Python 2.x.y from http://www.python.org/download/
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
4955 4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4902 diff changeset	29 While writing this guide, the latest version was v2.7.9.
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
64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer Denis Blanchette <dblanchette@coveo.com> parents: diff changeset	31 be needed in the next step. In this case, it is "2.7".
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
60e04a21bf0f docs: more consistent use of -- Mads Kiilerich <madski@unity3d.com> parents: 5434 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
4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4902 diff changeset	45 path. Typically this is ``C:\\Python27``.
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
60e04a21bf0f docs: more consistent use of -- Mads Kiilerich <madski@unity3d.com> parents: 5434 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)
4955 4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4902 diff changeset	55 - Choose the file ending with ".amd64-py2.x.exe" (".win32-py2.x.exe"
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:
4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4902 diff changeset	58 http://sourceforge.net/projects/pywin32/files/pywin32/Build%20219/pywin32-219.win-amd64-py2.7.exe/download
4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4902 diff changeset	59 (x64)
4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4902 diff changeset	60 http://sourceforge.net/projects/pywin32/files/pywin32/Build%20219/pywin32-219.win32-py2.7.exe/download
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 4 -- Install pip
60e04a21bf0f docs: more consistent use of -- Mads Kiilerich <madski@unity3d.com> parents: 5434 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 pip is a package management system for Python. You will need it to install Kallithea and its dependencies.
64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer Denis Blanchette <dblanchette@coveo.com> parents: diff changeset	67
64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer Denis Blanchette <dblanchette@coveo.com> parents: diff changeset	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).
64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer Denis Blanchette <dblanchette@coveo.com> parents: diff changeset	69
64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer Denis Blanchette <dblanchette@coveo.com> parents: diff changeset	70 If it was not installed or if you are using Python>=2.6,<2.7.9:
64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer Denis Blanchette <dblanchette@coveo.com> parents: diff changeset	71
64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer Denis Blanchette <dblanchette@coveo.com> parents: diff changeset	72 - Go to https://bootstrap.pypa.io
64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer Denis Blanchette <dblanchette@coveo.com> parents: diff changeset	73 - Right-click on get-pip.py and choose Saves as...
64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer Denis Blanchette <dblanchette@coveo.com> parents: diff changeset	74 - Run "python get-pip.py" in the folder where you downloaded get-pip.py (may require admin access).
4902 03bbd33bc084 docs: rework stuff Mads Kiilerich <madski@unity3d.com> parents: 4815 diff changeset	75
4955 4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4902 diff changeset	76 .. note::
4815 64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer Denis Blanchette <dblanchette@coveo.com> parents: diff changeset	77
4955 4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4902 diff changeset	78 See http://stackoverflow.com/questions/4750806/how-to-install-pip-on-windows
4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4902 diff changeset	79 for details and alternative methods.
4815 64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer Denis Blanchette <dblanchette@coveo.com> parents: diff changeset	80
4955 4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4902 diff changeset	81 Note that pip.exe will be placed inside your Python installation's
4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4902 diff changeset	82 Scripts folder, which is likely not on your path. To correct this,
4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4902 diff changeset	83 open a CMD and type::
4815 64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer Denis Blanchette <dblanchette@coveo.com> parents: diff changeset	84
64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer Denis Blanchette <dblanchette@coveo.com> parents: diff changeset	85 SETX PATH "%PATH%;[your-python-path]\Scripts" /M
64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer Denis Blanchette <dblanchette@coveo.com> parents: diff changeset	86
5435 60e04a21bf0f docs: more consistent use of -- Mads Kiilerich <madski@unity3d.com> parents: 5434 diff changeset	87 Step 5 -- Kallithea folder structure
60e04a21bf0f docs: more consistent use of -- Mads Kiilerich <madski@unity3d.com> parents: 5434 diff changeset	88 ------------------------------------
4815 64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer Denis Blanchette <dblanchette@coveo.com> parents: diff changeset	89
64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer Denis Blanchette <dblanchette@coveo.com> parents: diff changeset	90 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	91
4955 4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4902 diff changeset	92 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	93 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	94 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	95 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	96
64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer Denis Blanchette <dblanchette@coveo.com> parents: diff changeset	97 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	98
64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer Denis Blanchette <dblanchette@coveo.com> parents: diff changeset	99 C:\Kallithea
64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer Denis Blanchette <dblanchette@coveo.com> parents: diff changeset	100 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	101 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	102 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	103
5435 60e04a21bf0f docs: more consistent use of -- Mads Kiilerich <madski@unity3d.com> parents: 5434 diff changeset	104 Step 6 -- Install virtualenv
60e04a21bf0f docs: more consistent use of -- Mads Kiilerich <madski@unity3d.com> parents: 5434 diff changeset	105 ----------------------------
4815 64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer Denis Blanchette <dblanchette@coveo.com> parents: diff changeset	106
64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer Denis Blanchette <dblanchette@coveo.com> parents: diff changeset	107 .. note::
64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer Denis Blanchette <dblanchette@coveo.com> parents: diff changeset	108 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	109 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	110
64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer Denis Blanchette <dblanchette@coveo.com> parents: diff changeset	111 In a command prompt type::
64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer Denis Blanchette <dblanchette@coveo.com> parents: diff changeset	112
64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer Denis Blanchette <dblanchette@coveo.com> parents: diff changeset	113 pip install virtualenv
64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer Denis Blanchette <dblanchette@coveo.com> parents: diff changeset	114
64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer Denis Blanchette <dblanchette@coveo.com> parents: diff changeset	115 Virtualenv will now be inside your Python Scripts path (C:\\Python27\\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	116
64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer Denis Blanchette <dblanchette@coveo.com> parents: diff changeset	117 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	118
64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer Denis Blanchette <dblanchette@coveo.com> parents: diff changeset	119 virtualenv 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	120
5435 60e04a21bf0f docs: more consistent use of -- Mads Kiilerich <madski@unity3d.com> parents: 5434 diff changeset	121 Step 7 -- Install Kallithea
60e04a21bf0f docs: more consistent use of -- Mads Kiilerich <madski@unity3d.com> parents: 5434 diff changeset	122 ---------------------------
4815 64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer Denis Blanchette <dblanchette@coveo.com> parents: diff changeset	123
4955 4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4902 diff changeset	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.
4815 64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer Denis Blanchette <dblanchette@coveo.com> parents: diff changeset	125 Some Python packages use managed code and need to be compiled.
64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer Denis Blanchette <dblanchette@coveo.com> parents: diff changeset	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.
64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer Denis Blanchette <dblanchette@coveo.com> parents: diff changeset	127
64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer Denis Blanchette <dblanchette@coveo.com> parents: diff changeset	128 Download and install "Microsoft Visual C++ Compiler for Python 2.7" from http://aka.ms/vcpython27
64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer Denis Blanchette <dblanchette@coveo.com> parents: diff changeset	129
64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer Denis Blanchette <dblanchette@coveo.com> parents: diff changeset	130 .. note::
64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer Denis Blanchette <dblanchette@coveo.com> parents: diff changeset	131 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	132
64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer Denis Blanchette <dblanchette@coveo.com> parents: diff changeset	133 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	134
64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer Denis Blanchette <dblanchette@coveo.com> parents: diff changeset	135 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	136 activate
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 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	139 (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	140
64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer Denis Blanchette <dblanchette@coveo.com> parents: diff changeset	141 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	142
4955 4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4902 diff changeset	143 .. 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	144 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	145 normal.
4815 64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer Denis Blanchette <dblanchette@coveo.com> parents: diff changeset	146
5435 60e04a21bf0f docs: more consistent use of -- Mads Kiilerich <madski@unity3d.com> parents: 5434 diff changeset	147 Step 8 -- Install git (optional)
60e04a21bf0f docs: more consistent use of -- Mads Kiilerich <madski@unity3d.com> parents: 5434 diff changeset	148 --------------------------------
4955 4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4902 diff changeset	149
4815 64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer Denis Blanchette <dblanchette@coveo.com> parents: diff changeset	150 Mercurial being a python package, it was installed automatically when doing "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	151
64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer Denis Blanchette <dblanchette@coveo.com> parents: diff changeset	152 You need to install git manually if you want Kallithea to be able to host git repositories.
64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer Denis Blanchette <dblanchette@coveo.com> parents: diff changeset	153
64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer Denis Blanchette <dblanchette@coveo.com> parents: diff changeset	154 See http://git-scm.com/book/en/v2/Getting-Started-Installing-Git#Installing-on-Windows for instructions.
64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer Denis Blanchette <dblanchette@coveo.com> parents: diff changeset	155
5435 60e04a21bf0f docs: more consistent use of -- Mads Kiilerich <madski@unity3d.com> parents: 5434 diff changeset	156 Step 9 -- Configuring Kallithea
60e04a21bf0f docs: more consistent use of -- Mads Kiilerich <madski@unity3d.com> parents: 5434 diff changeset	157 -------------------------------
4815 64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer Denis Blanchette <dblanchette@coveo.com> parents: diff changeset	158
64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer Denis Blanchette <dblanchette@coveo.com> parents: diff changeset	159 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	160
4955 4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4902 diff changeset	161 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	162 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	163 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	164
64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer Denis Blanchette <dblanchette@coveo.com> parents: diff changeset	165 cd 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	166 paster make-config Kallithea production.ini
64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer Denis Blanchette <dblanchette@coveo.com> parents: diff changeset	167
4955 4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4902 diff changeset	168 Then you must edit production.ini to fit your needs (IP address, IP
4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4902 diff changeset	169 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	170 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	171 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	172
4955 4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4902 diff changeset	173 __ http://notepad-plus-plus.org/
4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4902 diff changeset	174
4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4902 diff changeset	175 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	176
64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer Denis Blanchette <dblanchette@coveo.com> parents: diff changeset	177 paster setup-db production.ini
64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer Denis Blanchette <dblanchette@coveo.com> parents: diff changeset	178
4955 4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4902 diff changeset	179 .. warning:: This time a new database will be installed. You must
4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4902 diff changeset	180 follow a different step to later upgrade to a newer
4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4902 diff changeset	181 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	182
4955 4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4902 diff changeset	183 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	184
4955 4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4902 diff changeset	185 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	186
4955 4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4902 diff changeset	187 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	188
4955 4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4902 diff changeset	189 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	190
64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer Denis Blanchette <dblanchette@coveo.com> parents: diff changeset	191 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	192
64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer Denis Blanchette <dblanchette@coveo.com> parents: diff changeset	193 If you decided not to install git, you will get errors about it that you can ignore.
64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer Denis Blanchette <dblanchette@coveo.com> parents: diff changeset	194
5435 60e04a21bf0f docs: more consistent use of -- Mads Kiilerich <madski@unity3d.com> parents: 5434 diff changeset	195 Step 10 -- Running Kallithea
60e04a21bf0f docs: more consistent use of -- Mads Kiilerich <madski@unity3d.com> parents: 5434 diff changeset	196 ----------------------------
4815 64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer Denis Blanchette <dblanchette@coveo.com> parents: diff changeset	197
64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer Denis Blanchette <dblanchette@coveo.com> parents: diff changeset	198 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	199
64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer Denis Blanchette <dblanchette@coveo.com> parents: diff changeset	200 paster serve production.ini
64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer Denis Blanchette <dblanchette@coveo.com> parents: diff changeset	201
64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer Denis Blanchette <dblanchette@coveo.com> parents: diff changeset	202 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	203
64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer Denis Blanchette <dblanchette@coveo.com> parents: diff changeset	204 It works!! :-)
64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer Denis Blanchette <dblanchette@coveo.com> parents: diff changeset	205
64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer Denis Blanchette <dblanchette@coveo.com> parents: diff changeset	206 Remark:
64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer Denis Blanchette <dblanchette@coveo.com> parents: diff changeset	207 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	208
4955 4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4902 diff changeset	209 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	210
64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer Denis Blanchette <dblanchette@coveo.com> parents: diff changeset	211 - Installing Celery
64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer Denis Blanchette <dblanchette@coveo.com> parents: diff changeset	212 - 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	213
64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer Denis Blanchette <dblanchette@coveo.com> parents: diff changeset	214 - 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	215 - 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	216 - 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	217
64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer Denis Blanchette <dblanchette@coveo.com> parents: diff changeset	218 - 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	219
64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer Denis Blanchette <dblanchette@coveo.com> parents: diff changeset	220 - https://groups.google.com/group/rhodecode/msg/c433074e813ffdc4
64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer Denis Blanchette <dblanchette@coveo.com> parents: diff changeset	221
64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer Denis Blanchette <dblanchette@coveo.com> parents: diff changeset	222
64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer Denis Blanchette <dblanchette@coveo.com> parents: diff changeset	223 Upgrading
64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer Denis Blanchette <dblanchette@coveo.com> parents: diff changeset	224 :::::::::
64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer Denis Blanchette <dblanchette@coveo.com> parents: diff changeset	225
64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer Denis Blanchette <dblanchette@coveo.com> parents: diff changeset	226 Stop running Kallithea
64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer Denis Blanchette <dblanchette@coveo.com> parents: diff changeset	227 Open a CommandPrompt like in Step 7 (cd to C:\Kallithea\Env\Scripts and activate) and type::
64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer Denis Blanchette <dblanchette@coveo.com> parents: diff changeset	228
64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer Denis Blanchette <dblanchette@coveo.com> parents: diff changeset	229 pip install kallithea --upgrade
64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer Denis Blanchette <dblanchette@coveo.com> parents: diff changeset	230 cd \Kallithea\Bin
64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer Denis Blanchette <dblanchette@coveo.com> parents: diff changeset	231
64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer Denis Blanchette <dblanchette@coveo.com> parents: diff changeset	232 Backup your production.ini file now.
64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer Denis Blanchette <dblanchette@coveo.com> parents: diff changeset	233
4955 4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4902 diff changeset	234 Then run::
4815 64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer Denis Blanchette <dblanchette@coveo.com> parents: diff changeset	235
64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer Denis Blanchette <dblanchette@coveo.com> parents: diff changeset	236 paster make-config Kallithea production.ini
64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer Denis Blanchette <dblanchette@coveo.com> parents: diff changeset	237
64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer Denis Blanchette <dblanchette@coveo.com> parents: diff changeset	238 Look for changes and update your production.ini accordingly.
64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer Denis Blanchette <dblanchette@coveo.com> parents: diff changeset	239
4955 4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4902 diff changeset	240 Next, update the database::
4815 64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer Denis Blanchette <dblanchette@coveo.com> parents: diff changeset	241
64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer Denis Blanchette <dblanchette@coveo.com> parents: diff changeset	242 paster upgrade-db production.ini
64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer Denis Blanchette <dblanchette@coveo.com> parents: diff changeset	243
4955 4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4902 diff changeset	244 More details can be found in `<upgrade.html>`_.

Mercurial > kallithea

annotate docs/installation_win.rst @ 5478:23f8f477ed35 stable