Changeset - 60e04a21bf0f
[Not reviewed]
default
0 5 0
Mads Kiilerich - 10 years ago 2015-08-26 17:28:58
madski@unity3d.com
docs: more consistent use of --
5 files changed with 27 insertions and 29 deletions:
0 comments (0 inline, 0 general)
docs/installation_win.rst
Show inline comments
 
@@ -14,8 +14,8 @@ Tested on Windows 8.1, Windows Server 20
 

	
 
To install on an older version of Windows, see `<installation_win_old.html>`_
 

	
 
Step 1 - Install Python
 
-----------------------
 
Step 1 -- Install Python
 
------------------------
 

	
 
Install Python 2.x.y (x = 6 or 7). Latest version is recommended. If you need another version, they can run side by side.
 

	
 
@@ -30,8 +30,8 @@ While writing this guide, the latest ver
 
Remember the specific major and minor versions installed, because they will
 
be needed in the next step. In this case, it is "2.7".
 

	
 
Step 2 - Python BIN
 
-------------------
 
Step 2 -- Python BIN
 
--------------------
 

	
 
Add Python BIN folder to the path. This can be done manually (editing
 
"PATH" environment variable) or by using Windows Support Tools that
 
@@ -44,8 +44,8 @@ Open a CMD and type::
 
Please substitute [your-python-path] with your Python installation
 
path. Typically this is ``C:\\Python27``.
 

	
 
Step 3 - Install pywin32 extensions
 
-----------------------------------
 
Step 3 -- Install pywin32 extensions
 
------------------------------------
 

	
 
Download pywin32 from:
 
http://sourceforge.net/projects/pywin32/files/
 
@@ -60,8 +60,8 @@ http://sourceforge.net/projects/pywin32/
 
  http://sourceforge.net/projects/pywin32/files/pywin32/Build%20219/pywin32-219.win32-py2.7.exe/download
 
  (Win32)
 

	
 
Step 4 - Install pip
 
--------------------
 
Step 4 -- Install pip
 
---------------------
 

	
 
pip is a package management system for Python. You will need it to install Kallithea and its dependencies.
 

	
 
@@ -84,8 +84,8 @@ open a CMD and type::
 

	
 
  SETX PATH "%PATH%;[your-python-path]\Scripts" /M
 

	
 
Step 5 - Kallithea folder structure
 
-----------------------------------
 
Step 5 -- Kallithea folder structure
 
------------------------------------
 

	
 
Create a Kallithea folder structure.
 

	
 
@@ -101,8 +101,8 @@ Create the following folder structure::
 
  C:\Kallithea\Env
 
  C:\Kallithea\Repos
 

	
 
Step 6 - Install virtualenv
 
---------------------------
 
Step 6 -- Install virtualenv
 
----------------------------
 

	
 
.. note::
 
   A python virtual environment will allow for isolation between the Python packages of your system and those used for Kallithea.
 
@@ -118,8 +118,8 @@ To create a virtual environment, run::
 

	
 
  virtualenv C:\Kallithea\Env
 

	
 
Step 7 - Install Kallithea
 
--------------------------
 
Step 7 -- Install Kallithea
 
---------------------------
 

	
 
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.
 
Some Python packages use managed code and need to be compiled.
 
@@ -144,8 +144,8 @@ The prompt will change into "(Env) C:\\K
 
          complete. Some warnings will appear. Don't worry, they are
 
          normal.
 

	
 
Step 8 - Install git (optional)
 
-------------------------------
 
Step 8 -- Install git (optional)
 
--------------------------------
 

	
 
Mercurial being a python package, it was installed automatically when doing "pip install kallithea".
 

	
 
@@ -153,8 +153,8 @@ You need to install git manually if you 
 

	
 
See http://git-scm.com/book/en/v2/Getting-Started-Installing-Git#Installing-on-Windows for instructions.
 

	
 
Step 9 - Configuring Kallithea
 
------------------------------
 
Step 9 -- Configuring Kallithea
 
-------------------------------
 

	
 
Steps taken from `<setup.html>`_
 

	
 
@@ -192,8 +192,8 @@ If you make a mistake and the script doe
 

	
 
If you decided not to install git, you will get errors about it that you can ignore.
 

	
 
Step 10 - Running Kallithea
 
---------------------------
 
Step 10 -- Running Kallithea
 
----------------------------
 

	
 
In the previous command prompt, being in the C:\\Kallithea\\Bin folder, type::
 

	
docs/installation_win_old.rst
Show inline comments
 
@@ -19,11 +19,12 @@ Target OS: Windows XP SP3 32-bit English
 
   These extra steps haven been marked as "64-bit".
 
   Tested on Windows Server 2008 R2 SP1, 9-feb-2013.
 
   If you run into any 64-bit related problems, please check these pages:
 

	
 
   - http://blog.victorjabur.com/2011/06/05/compiling-python-2-7-modules-on-windows-32-and-64-using-msvc-2008-express/
 
   - http://bugs.python.org/issue7511
 

	
 
Step 1 - Install Visual Studio 2008 Express
 
-------------------------------------------
 
Step 1 -- Install Visual Studio 2008 Express
 
--------------------------------------------
 

	
 
Optional: You can also install MinGW, but VS2008 installation is easier.
 

	
 
@@ -32,7 +33,7 @@ http://download.microsoft.com/download/E
 
(if not found or relocated, google for "visual studio 2008 express" for updated link. This link was taken from http://stackoverflow.com/questions/15318560/visual-c-2008-express-download-link-dead)
 

	
 
You can also download full ISO file for offline installation, just
 
choose "All - Offline Install ISO image file" in the previous page and
 
choose "All -- Offline Install ISO image file" in the previous page and
 
choose "Visual C++ 2008 Express" when installing.
 

	
 
.. note::
docs/overview.rst
Show inline comments
 
@@ -47,7 +47,7 @@ available for other packages.
 
Two different cases will pretty much cover the options for how it can be
 
installed.
 

	
 
- The Kallithea source repository can be cloned and used - it is kept stable and
 
- The Kallithea source repository can be cloned and used -- it is kept stable and
 
  can be used in production. The Kallithea maintainers use the development
 
  branch in production. The advantage of installation from source and regularly
 
  updating it is that you take advantage of the most recent improvements. Using
docs/setup.rst
Show inline comments
 
@@ -249,7 +249,7 @@ Connection Security : required
 
.. _Certificate Checks:
 

	
 
Certificate Checks : optional
 
    How SSL certificates verification is handled - this is only useful when
 
    How SSL certificates verification is handled -- this is only useful when
 
    `Enable LDAPS`_ is enabled.  Only DEMAND or HARD offer full SSL security
 
    while the other options are susceptible to man-in-the-middle attacks.  SSL
 
    certificates can be installed to /etc/openldap/cacerts so that the
 
@@ -700,7 +700,6 @@ Add the following at the end of the .ini
 
    use = egg:PasteDeploy#prefix
 
    prefix = /<someprefix>
 

	
 

	
 
then change ``<someprefix>`` into your chosen prefix
 

	
 

	
 
@@ -744,7 +743,6 @@ Or if using a dispatcher WSGI script wit
 
    WSGIScriptAlias / /srv/kallithea/dispatch.wsgi
 
    WSGIPassAuthorization On
 

	
 

	
 
.. note::
 
   When running apache as root, please make sure it doesn't run Kallithea as
 
   root, for examply by adding: ``user=www-data group=www-data`` to the configuration.
 
@@ -754,7 +752,6 @@ Or if using a dispatcher WSGI script wit
 
   make sure you set ``instance_id = *`` in the configuration so each process
 
   gets it's own cache invalidation key.
 

	
 

	
 
Example WSGI dispatch script:
 

	
 
.. code-block:: python
docs/theme/nature/layout.html
Show inline comments
 
@@ -9,7 +9,7 @@
 
<form action="https://www.paypal.com/cgi-bin/webscr" method="post" target="_top">
 
<input type="hidden" name="cmd" value="_s-xclick">
 
<input type="hidden" name="hosted_button_id" value="EYXFS3SQPHYUL">
 
<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!">
 
<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif" border="0" name="submit" alt="PayPal &ndash; The safer, easier way to pay online!">
 
<img alt="" border="0" src="https://www.paypalobjects.com/en_US/i/scr/pixel.gif" width="1" height="1">
 
</form>
 
    <div style="padding:5px">
0 comments (0 inline, 0 general)