##// END OF EJS Templates
venv: limit pip version to stay below 24.1...
venv: limit pip version to stay below 24.1 Latest pip version pip fail: WARNING: Ignoring version 5.0.5 of celery since it has invalid metadata: Requested celery<5.1,>=5 from .../celery-5.0.5-py3-none-any.whl (from Kallithea==0.7.0) has invalid metadata: Expected matching RIGHT_PARENTHESIS for LEFT_PARENTHESIS, after version specifier pytz (>dev) ~^ Please use pip<24.1 if you need to use this version. We already use setuptools<67 for the same reason. Pip will keep noting that a newer pip version is available. Resist the temptation to upgrade.

File last commit:

r8777:ff6c3e28 stable
r8777:ff6c3e28 stable
Show More
installation_win.rst
193 lines | 7.1 KiB | text/x-rst | RstLexer
/ docs / installation_win.rst
Denis Blanchette
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer...
r4815 .. _installation_win:
Mads Kiilerich
py3: officially support Python 3...
r8089 .. warning:: This section is outdated and needs updating for Python 3.
Søren Løvborg
docs: restructure Kallithea upgrade instructions...
r5917 ====================================================
Installation on Windows (7/Server 2008 R2 and newer)
====================================================
Denis Blanchette
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer...
r4815
Mads Kiilerich
docs: consistent spacing around headings...
r5433
Denis Blanchette
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer...
r4815 First time install
Mads Kiilerich
docs: use consistent style for section titles
r5568 ------------------
Denis Blanchette
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer...
r4815
Target OS: Windows 7 and newer or Windows Server 2008 R2 and newer
Tested on Windows 8.1, Windows Server 2008 R2 and Windows Server 2012
To install on an older version of Windows, see `<installation_win_old.html>`_
Mads Kiilerich
docs: more consistent use of --
r5435 Step 1 -- Install Python
Mads Kiilerich
docs: use consistent style for section titles
r5568 ^^^^^^^^^^^^^^^^^^^^^^^^
Denis Blanchette
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer...
r4815
Mads Kiilerich
py3: officially support Python 3...
r8089 Install Python 3. Latest version is recommended. If you need another version, they can run side by side.
Denis Blanchette
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer...
r4815
Mads Kiilerich
py3: officially support Python 3...
r8089 - Download Python 3 from http://www.python.org/download/
Denis Blanchette
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer...
r4815 - Choose and click on the version
- Click on "Windows X86-64 Installer" for x64 or "Windows x86 MSI installer" for Win32.
- Disable UAC or run the installer with admin privileges. If you chose to disable UAC, do not forget to reboot afterwards.
Mads Kiilerich
py3: officially support Python 3...
r8089 While writing this guide, the latest version was v3.8.1.
Denis Blanchette
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer...
r4815 Remember the specific major and minor versions installed, because they will
Mads Kiilerich
py3: officially support Python 3...
r8089 be needed in the next step. In this case, it is "3.8".
Denis Blanchette
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer...
r4815
Mads Kiilerich
docs: more consistent use of --
r5435 Step 2 -- Python BIN
Mads Kiilerich
docs: use consistent style for section titles
r5568 ^^^^^^^^^^^^^^^^^^^^
Denis Blanchette
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer...
r4815
Michael V. DePalatis
docs: English and consistency corrections
r4955 Add Python BIN folder to the path. This can be done manually (editing
"PATH" environment variable) or by using Windows Support Tools that
come pre-installed in Windows Vista/7 and later.
Denis Blanchette
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer...
r4815
Open a CMD and type::
SETX PATH "%PATH%;[your-python-path]" /M
Michael V. DePalatis
docs: English and consistency corrections
r4955 Please substitute [your-python-path] with your Python installation
Mads Kiilerich
py3: officially support Python 3...
r8089 path. Typically this is ``C:\\Python38``.
Denis Blanchette
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer...
r4815
Mads Kiilerich
docs: more consistent use of --
r5435 Step 3 -- Install pywin32 extensions
Mads Kiilerich
docs: use consistent style for section titles
r5568 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Denis Blanchette
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer...
r4815
Download pywin32 from:
http://sourceforge.net/projects/pywin32/files/
- Click on "pywin32" folder
- Click on the first folder (in this case, Build 219, maybe newer when you try)
Mads Kiilerich
py3: officially support Python 3...
r8089 - Choose the file ending with ".amd64-py3.x.exe" (".win32-py3.x.exe"
Michael V. DePalatis
docs: English and consistency corrections
r4955 for Win32) where x is the minor version of Python you installed.
When writing this guide, the file was:
Mads Kiilerich
py3: officially support Python 3...
r8089 http://sourceforge.net/projects/pywin32/files/pywin32/Build%20219/pywin32-219.win-amd64-py3.8.exe/download
Michael V. DePalatis
docs: English and consistency corrections
r4955 (x64)
Mads Kiilerich
py3: officially support Python 3...
r8089 http://sourceforge.net/projects/pywin32/files/pywin32/Build%20219/pywin32-219.win32-py3.8.exe/download
Michael V. DePalatis
docs: English and consistency corrections
r4955 (Win32)
Denis Blanchette
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer...
r4815
Mads Kiilerich
docs: more consistent use of --
r5435 Step 5 -- Kallithea folder structure
Mads Kiilerich
docs: use consistent style for section titles
r5568 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Denis Blanchette
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer...
r4815
Create a Kallithea folder structure.
Michael V. DePalatis
docs: English and consistency corrections
r4955 This is only an example to install Kallithea. Of course, you can
change it. However, this guide will follow the proposed structure, so
please later adapt the paths if you change them. Folders without
spaces are recommended.
Denis Blanchette
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer...
r4815
Create the following folder structure::
C:\Kallithea
C:\Kallithea\Bin
C:\Kallithea\Env
C:\Kallithea\Repos
Mads Kiilerich
docs: more consistent use of --
r5435 Step 6 -- Install virtualenv
Mads Kiilerich
docs: use consistent style for section titles
r5568 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Denis Blanchette
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer...
r4815
.. note::
A python virtual environment will allow for isolation between the Python packages of your system and those used for Kallithea.
Michael V. DePalatis
docs: English and consistency corrections
r4955 It is strongly recommended to use it to ensure that Kallithea does not change a dependency that other software uses or vice versa.
Denis Blanchette
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer...
r4815
To create a virtual environment, run::
Mads Kiilerich
py3: use "python3 -m venv" instead of virtualenv package
r8073 python3 -m venv C:\Kallithea\Env
Denis Blanchette
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer...
r4815
Mads Kiilerich
docs: more consistent use of --
r5435 Step 7 -- Install Kallithea
Mads Kiilerich
docs: use consistent style for section titles
r5568 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
Denis Blanchette
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer...
r4815
Michael V. DePalatis
docs: English and consistency corrections
r4955 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.
Denis Blanchette
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer...
r4815 Some Python packages use managed code and need to be compiled.
Mads Kiilerich
py3: officially support Python 3...
r8089 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.
Denis Blanchette
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer...
r4815
Mads Kiilerich
py3: officially support Python 3...
r8089 Download and install "Microsoft Visual C++ Compiler for Python 3.8" from http://aka.ms/vcpython27
Denis Blanchette
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer...
r4815
.. note::
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.
In a command prompt type (adapting paths if necessary)::
cd C:\Kallithea\Env\Scripts
activate
Mads Kiilerich
venv: limit pip version to stay below 24.1...
r8777 pip install --upgrade "pip<24.1" "setuptools<67"
Denis Blanchette
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer...
r4815
The prompt will change into "(Env) C:\\Kallithea\\Env\\Scripts" or similar
(depending of your folder structure). Then type::
pip install kallithea
Michael V. DePalatis
docs: English and consistency corrections
r4955 .. note:: This will take some time. Please wait patiently until it is fully
complete. Some warnings will appear. Don't worry, they are
normal.
Denis Blanchette
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer...
r4815
domruf
docs: reminder to add c:\path\to\git\bin to PATH
r5938 Step 8 -- Install Git (optional)
Mads Kiilerich
docs: use consistent style for section titles
r5568 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Michael V. DePalatis
docs: English and consistency corrections
r4955
domruf
docs: reminder to add c:\path\to\git\bin to PATH
r5938 Mercurial being a python package, was installed automatically when doing ``pip install kallithea``.
Denis Blanchette
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer...
r4815
domruf
docs: reminder to add c:\path\to\git\bin to PATH
r5938 You need to install Git manually if you want Kallithea to be able to host Git repositories.
Denis Blanchette
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer...
r4815 See http://git-scm.com/book/en/v2/Getting-Started-Installing-Git#Installing-on-Windows for instructions.
domruf
docs: reminder to add c:\path\to\git\bin to PATH
r5938 The location of the Git binaries (like ``c:\path\to\git\bin``) must be
added to the ``PATH`` environment variable so ``git.exe`` and other tools like
``gzip.exe`` are available.
Denis Blanchette
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer...
r4815
Mads Kiilerich
docs: more consistent use of --
r5435 Step 9 -- Configuring Kallithea
Mads Kiilerich
docs: use consistent style for section titles
r5568 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Denis Blanchette
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer...
r4815
Steps taken from `<setup.html>`_
Michael V. DePalatis
docs: English and consistency corrections
r4955 You have to use the same command prompt as in Step 7, so if you closed
it, reopen it following the same commands (including the "activate"
one). When ready, type::
Denis Blanchette
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer...
r4815
cd C:\Kallithea\Bin
Thomas De Schampheleire
cli: convert 'gearbox make-config' into 'kallithea-cli config-create'...
r7327 kallithea-cli config-create my.ini
Denis Blanchette
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer...
r4815
Thomas De Schampheleire
docs: align use of 'my.ini' as configfile placeholder
r7310 Then you must edit my.ini to fit your needs (IP address, IP
Michael V. DePalatis
docs: English and consistency corrections
r4955 port, mail settings, database, etc.). `NotePad++`__ or a similar text
editor is recommended to properly handle the newline character
differences between Unix and Windows.
Denis Blanchette
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer...
r4815
Michael V. DePalatis
docs: English and consistency corrections
r4955 __ http://notepad-plus-plus.org/
For the sake of simplicity, run it with the default settings. After your edits (if any) in the previous command prompt, type::
Denis Blanchette
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer...
r4815
Thomas De Schampheleire
cli: convert 'gearbox setup-db' into 'kallithea-cli db-create'
r7335 kallithea-cli db-create -c my.ini
Denis Blanchette
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer...
r4815
Michael V. DePalatis
docs: English and consistency corrections
r4955 .. warning:: This time a *new* database will be installed. You must
Søren Løvborg
docs: restructure Kallithea upgrade instructions...
r5917 follow a different process to later :ref:`upgrade <upgrade>`
to a newer Kallithea version.
Denis Blanchette
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer...
r4815
Michael V. DePalatis
docs: English and consistency corrections
r4955 The script will ask you for confirmation about creating a new database, answer yes (y)
Denis Blanchette
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer...
r4815
Michael V. DePalatis
docs: English and consistency corrections
r4955 The script will ask you for the repository path, answer C:\\Kallithea\\Repos (or similar).
Denis Blanchette
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer...
r4815
Michael V. DePalatis
docs: English and consistency corrections
r4955 The script will ask you for the admin username and password, answer "admin" + "123456" (or whatever you want)
Denis Blanchette
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer...
r4815
Michael V. DePalatis
docs: English and consistency corrections
r4955 The script will ask you for admin mail, answer "admin@xxxx.com" (or whatever you want).
Denis Blanchette
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer...
r4815
If you make a mistake and the script doesn't end, don't worry: start it again.
domruf
docs: reminder to add c:\path\to\git\bin to PATH
r5938 If you decided not to install Git, you will get errors about it that you can ignore.
Denis Blanchette
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer...
r4815
Mads Kiilerich
docs: more consistent use of --
r5435 Step 10 -- Running Kallithea
Mads Kiilerich
docs: use consistent style for section titles
r5568 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Denis Blanchette
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer...
r4815
In the previous command prompt, being in the C:\\Kallithea\\Bin folder, type::
Thomas De Schampheleire
docs: align use of 'my.ini' as configfile placeholder
r7310 gearbox serve -c my.ini
Denis Blanchette
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer...
r4815
Open your web server, and go to http://127.0.0.1:5000
It works!! :-)
Remark:
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.
Michael V. DePalatis
docs: English and consistency corrections
r4955 What this guide does not cover:
Denis Blanchette
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer...
r4815
- Installing Celery
- Running Kallithea as a Windows Service. You can investigate here:
- http://pypi.python.org/pypi/wsgisvc
- http://ryrobes.com/python/running-python-scripts-as-a-windows-service/
- http://wiki.pylonshq.com/display/pylonscookbook/How+to+run+Pylons+as+a+Windows+service
- Using Apache. You can investigate here:
- https://groups.google.com/group/rhodecode/msg/c433074e813ffdc4