##// END OF EJS Templates
docs: consistent spacing around headings...
Mads Kiilerich -
r5433:fbbe80e3 default
parent child Browse files
Show More
@@ -2,6 +2,7 b''
2 2 Kallithea README
3 3 ================
4 4
5
5 6 About
6 7 -----
7 8
@@ -24,6 +25,7 b' Kallithea was forked from RhodeCode in J'
24 25
25 26 Installation
26 27 ------------
28
27 29 Kallithea requires Python_ 2.x and it is recommended to install it in a
28 30 virtualenv_. Official releases of Kallithea can be installed with::
29 31
@@ -4,7 +4,6 b''
4 4 API
5 5 ===
6 6
7
8 7 Kallithea has a simple JSON RPC API with a single schema for calling all API
9 8 methods. Everything is available by sending JSON encoded http(s) requests to
10 9 ``<your_server>/_admin/api``.
@@ -137,7 +136,6 b' OUTPUT::'
137 136 result : "Pulled from `<reponame>`"
138 137 error : null
139 138
140
141 139 rescan_repos
142 140 ------------
143 141
@@ -161,7 +159,6 b' OUTPUT::'
161 159 'removed': [<list of names of removed repos>]}"
162 160 error : null
163 161
164
165 162 invalidate_cache
166 163 ----------------
167 164
@@ -184,7 +181,6 b' OUTPUT::'
184 181 result : "Caches of repository `<reponame>`"
185 182 error : null
186 183
187
188 184 lock
189 185 ----
190 186
@@ -216,7 +212,6 b' OUTPUT::'
216 212 }
217 213 error : null
218 214
219
220 215 get_ip
221 216 ------
222 217
@@ -249,7 +244,6 b' OUTPUT::'
249 244
250 245 error : null
251 246
252
253 247 get_user
254 248 --------
255 249
@@ -295,7 +289,6 b' OUTPUT::'
295 289 }
296 290 error: null
297 291
298
299 292 get_users
300 293 ---------
301 294
@@ -382,7 +375,6 b' Example::'
382 375
383 376 kallithea-api create_user username:bent email:bent@example.com firstname:Bent lastname:Bentsen extern_type:ldap extern_name:uid=bent,dc=example,dc=com
384 377
385
386 378 update_user
387 379 -----------
388 380
@@ -428,7 +420,6 b' OUTPUT::'
428 420 }
429 421 error: null
430 422
431
432 423 delete_user
433 424 -----------
434 425
@@ -454,7 +445,6 b' OUTPUT::'
454 445 }
455 446 error: null
456 447
457
458 448 get_user_group
459 449 --------------
460 450
@@ -498,7 +488,6 b' OUTPUT::'
498 488 }
499 489 error : null
500 490
501
502 491 get_user_groups
503 492 ---------------
504 493
@@ -526,7 +515,6 b' OUTPUT::'
526 515 ]
527 516 error : null
528 517
529
530 518 create_user_group
531 519 -----------------
532 520
@@ -558,7 +546,6 b' OUTPUT::'
558 546 }
559 547 error: null
560 548
561
562 549 add_user_to_user_group
563 550 ----------------------
564 551
@@ -587,7 +574,6 b' OUTPUT::'
587 574 }
588 575 error: null
589 576
590
591 577 remove_user_from_user_group
592 578 ---------------------------
593 579
@@ -616,7 +602,6 b' OUTPUT::'
616 602 }
617 603 error: null
618 604
619
620 605 get_repo
621 606 --------
622 607
@@ -706,7 +691,6 b' OUTPUT::'
706 691 }
707 692 error: null
708 693
709
710 694 get_repos
711 695 ---------
712 696
@@ -745,7 +729,6 b' OUTPUT::'
745 729 ]
746 730 error: null
747 731
748
749 732 get_repo_nodes
750 733 --------------
751 734
@@ -778,7 +761,6 b' OUTPUT::'
778 761 ]
779 762 error: null
780 763
781
782 764 create_repo
783 765 -----------
784 766
@@ -832,7 +814,6 b' OUTPUT::'
832 814 }
833 815 error: null
834 816
835
836 817 update_repo
837 818 -----------
838 819
@@ -894,7 +875,6 b' OUTPUT::'
894 875 }
895 876 error: null
896 877
897
898 878 fork_repo
899 879 ---------
900 880
@@ -932,7 +912,6 b' OUTPUT::'
932 912 }
933 913 error: null
934 914
935
936 915 delete_repo
937 916 -----------
938 917
@@ -961,7 +940,6 b' OUTPUT::'
961 940 }
962 941 error: null
963 942
964
965 943 grant_user_permission
966 944 ---------------------
967 945
@@ -989,7 +967,6 b' OUTPUT::'
989 967 }
990 968 error: null
991 969
992
993 970 revoke_user_permission
994 971 ----------------------
995 972
@@ -1016,7 +993,6 b' OUTPUT::'
1016 993 }
1017 994 error: null
1018 995
1019
1020 996 grant_user_group_permission
1021 997 ---------------------------
1022 998
@@ -1045,7 +1021,6 b' OUTPUT::'
1045 1021 }
1046 1022 error: null
1047 1023
1048
1049 1024 revoke_user_group_permission
1050 1025 ----------------------------
1051 1026
@@ -6,4 +6,5 b' Changelog'
6 6
7 7 Kallithea project doesn't keep its changelog here. We refer you to our `Mercurial logs`__.
8 8
9
9 10 .. __: https://kallithea-scm.org/repos/kallithea/changelog
@@ -24,6 +24,7 b' than English. Join our project on `Hoste'
24 24 To register, you can use your Bitbucket or GitHub account. See :ref:`translations`
25 25 for more details.
26 26
27
27 28 Getting started
28 29 ---------------
29 30
@@ -69,6 +70,7 b' are::'
69 70 printed immediately) [NOSE_NOCAPTURE]
70 71 --failed Run the tests that failed in the last test run.
71 72
73
72 74 Coding/contribution guidelines
73 75 ------------------------------
74 76
@@ -134,6 +136,7 b' elsewhere (for example in a pull request'
134 136 .. _translations:
135 137 .. include:: ./../kallithea/i18n/how_to
136 138
139
137 140 "Roadmap"
138 141 ---------
139 142
@@ -4,7 +4,6 b''
4 4 Kallithea Documentation
5 5 #######################
6 6
7
8 7 **Readme**
9 8
10 9 .. toctree::
@@ -68,6 +67,7 b' Other topics'
68 67 * :ref:`genindex`
69 68 * :ref:`search`
70 69
70
71 71 .. _virtualenv: http://pypi.python.org/pypi/virtualenv
72 72 .. _python: http://www.python.org/
73 73 .. _django: http://www.djangoproject.com/
@@ -28,6 +28,7 b' The following describes three different '
28 28
29 29 .. _installation-source:
30 30
31
31 32 Installation from repository source
32 33 -----------------------------------
33 34
@@ -48,6 +49,7 b' server.'
48 49
49 50 .. _installation-virtualenv:
50 51
52
51 53 Installing a released version in a virtualenv
52 54 ---------------------------------------------
53 55
@@ -91,6 +93,7 b' You can now proceed to :ref:`setup`.'
91 93
92 94 .. _installation-without-virtualenv:
93 95
96
94 97 Installing a released version without virtualenv
95 98 ------------------------------------------------
96 99
@@ -107,6 +110,7 b' To install as a regular user in ``~/.loc'
107 110
108 111 You can now proceed to :ref:`setup`.
109 112
113
110 114 Upgrading Kallithea from Python Package Index (PyPI)
111 115 ----------------------------------------------------
112 116
@@ -12,12 +12,14 b' preventing you from applying this on IIS'
12 12 For the best security, it is strongly recommended to only host the site over
13 13 a secure connection, e.g. using TLS.
14 14
15
15 16 Prerequisites
16 17 -------------
17 18
18 19 Apart from the normal requirements for Kallithea, it is also necessary to get an
19 20 ISAPI-WSGI bridge module, e.g. isapi-wsgi.
20 21
22
21 23 Installation
22 24 ------------
23 25
@@ -41,7 +43,6 b' to run on the website and neither will K'
41 43 The application pool can be the same as an existing application pool,
42 44 as long as the Kallithea requirements are met by the existing pool.
43 45
44
45 46 ISAPI handler
46 47 .............
47 48
@@ -89,6 +90,7 b' external account*. Finally, save the cha'
89 90 The last necessary step is to enable the relevant authentication in IIS, e.g.
90 91 Windows authentication.
91 92
93
92 94 Troubleshooting
93 95 ---------------
94 96
@@ -4,6 +4,7 b''
4 4 Installation and upgrade on Windows (7/Server 2008 R2 and newer)
5 5 ================================================================
6 6
7
7 8 First time install
8 9 ::::::::::::::::::
9 10
@@ -13,7 +14,6 b' Tested on Windows 8.1, Windows Server 20'
13 14
14 15 To install on an older version of Windows, see `<installation_win_old.html>`_
15 16
16
17 17 Step 1 - Install Python
18 18 -----------------------
19 19
@@ -30,7 +30,6 b' While writing this guide, the latest ver'
30 30 Remember the specific major and minor versions installed, because they will
31 31 be needed in the next step. In this case, it is "2.7".
32 32
33
34 33 Step 2 - Python BIN
35 34 -------------------
36 35
@@ -45,7 +44,6 b' Open a CMD and type::'
45 44 Please substitute [your-python-path] with your Python installation
46 45 path. Typically this is ``C:\\Python27``.
47 46
48
49 47 Step 3 - Install pywin32 extensions
50 48 -----------------------------------
51 49
@@ -62,7 +60,6 b' http://sourceforge.net/projects/pywin32/'
62 60 http://sourceforge.net/projects/pywin32/files/pywin32/Build%20219/pywin32-219.win32-py2.7.exe/download
63 61 (Win32)
64 62
65
66 63 Step 4 - Install pip
67 64 --------------------
68 65
@@ -87,7 +84,6 b' open a CMD and type::'
87 84
88 85 SETX PATH "%PATH%;[your-python-path]\Scripts" /M
89 86
90
91 87 Step 5 - Kallithea folder structure
92 88 -----------------------------------
93 89
@@ -105,7 +101,6 b' Create the following folder structure::'
105 101 C:\Kallithea\Env
106 102 C:\Kallithea\Repos
107 103
108
109 104 Step 6 - Install virtualenv
110 105 ---------------------------
111 106
@@ -123,7 +118,6 b' To create a virtual environment, run::'
123 118
124 119 virtualenv C:\Kallithea\Env
125 120
126
127 121 Step 7 - Install Kallithea
128 122 --------------------------
129 123
@@ -150,7 +144,6 b' The prompt will change into "(Env) C:\\\\K'
150 144 complete. Some warnings will appear. Don't worry, they are
151 145 normal.
152 146
153
154 147 Step 8 - Install git (optional)
155 148 -------------------------------
156 149
@@ -160,7 +153,6 b' You need to install git manually if you '
160 153
161 154 See http://git-scm.com/book/en/v2/Getting-Started-Installing-Git#Installing-on-Windows for instructions.
162 155
163
164 156 Step 9 - Configuring Kallithea
165 157 ------------------------------
166 158
@@ -200,7 +192,6 b' If you make a mistake and the script doe'
200 192
201 193 If you decided not to install git, you will get errors about it that you can ignore.
202 194
203
204 195 Step 10 - Running Kallithea
205 196 ---------------------------
206 197
@@ -4,6 +4,7 b''
4 4 Installation and upgrade on Windows (XP/Vista/Server 2003/Server 2008)
5 5 ======================================================================
6 6
7
7 8 First-time install
8 9 ::::::::::::::::::
9 10
@@ -24,7 +25,6 b' Target OS: Windows XP SP3 32-bit English'
24 25 Step 1 - Install Visual Studio 2008 Express
25 26 -------------------------------------------
26 27
27
28 28 Optional: You can also install MinGW, but VS2008 installation is easier.
29 29
30 30 Download "Visual C++ 2008 Express Edition with SP1" from:
@@ -56,7 +56,6 b' choose "Visual C++ 2008 Express" when in'
56 56 I am not sure why this is not necessary for 32-bit.
57 57 Copy C:\Program Files (x86)\Microsoft Visual Studio 9.0\VC\bin\vcvars64.bat to C:\Program Files (x86)\Microsoft Visual Studio 9.0\VC\bin\amd64\vcvarsamd64.bat
58 58
59
60 59 Step 2 -- Install Python
61 60 ------------------------
62 61
@@ -73,7 +72,6 b' be needed in the next step. In this case'
73 72
74 73 64-bit: Just download and install the 64-bit version of python.
75 74
76
77 75 Step 3 -- Install Win32py extensions
78 76 ------------------------------------
79 77
@@ -93,7 +91,6 b' http://sourceforge.net/projects/pywin32/'
93 91 At the time of writing you can find this at:
94 92 http://sourceforge.net/projects/pywin32/files/pywin32/Build%20218/pywin32-218.win-amd64-py2.7.exe/download
95 93
96
97 94 Step 4 -- Python BIN
98 95 --------------------
99 96
@@ -121,7 +118,6 b' that came preinstalled in Vista/7 and ca'
121 118 Please substitute [your-python-path] with your Python installation path.
122 119 Typically: C:\\Python27
123 120
124
125 121 Step 5 -- Kallithea folder structure
126 122 ------------------------------------
127 123
@@ -139,7 +135,6 b' Create the following folder structure::'
139 135 C:\Kallithea\Env
140 136 C:\Kallithea\Repos
141 137
142
143 138 Step 6 -- Install virtualenv
144 139 ----------------------------
145 140
@@ -160,7 +155,6 b' where you downloaded "virtualenv.py", an'
160 155 (--no-site-packages is now the default behaviour of virtualenv, no need
161 156 to include it)
162 157
163
164 158 Step 7 -- Install Kallithea
165 159 ---------------------------
166 160
@@ -199,7 +193,6 b' The prompt will change into "(Env) C:\\\\K'
199 193
200 194 Some warnings will appear, don't worry as they are normal.
201 195
202
203 196 Step 8 -- Configuring Kallithea
204 197 -------------------------------
205 198
@@ -238,11 +231,9 b' whatever you want)'
238 231 If you make some mistake and the script does not end, don't worry, start
239 232 it again.
240 233
241
242 234 Step 9 -- Running Kallithea
243 235 ---------------------------
244 236
245
246 237 In the previous command prompt, being in the C:\\Kallithea\\Bin folder,
247 238 just type::
248 239
@@ -257,7 +248,6 b' If it does not work first time, just Ctr'
257 248 again. Don't forget the "http://" in Internet Explorer
258 249
259 250
260
261 251 What this Guide does not cover:
262 252
263 253 - Installing Celery
@@ -4,7 +4,6 b''
4 4 Installation overview
5 5 =====================
6 6
7
8 7 Some overview and some details that can help understanding the options when
9 8 installing Kallithea.
10 9
@@ -121,6 +121,7 b' authentication is fully supported.'
121 121 to the Kallithea db and run check functions for permissions
122 122 against that.
123 123
124
124 125 Setting up Whoosh full text search
125 126 ----------------------------------
126 127
@@ -384,7 +385,6 b' administrator can then modify it using K'
384 385 It's also possible for an administrator to create accounts and configure their
385 386 permissions before the user logs in for the first time, using the :ref:`create-user` API.
386 387
387
388 388 Container-based authentication
389 389 ''''''''''''''''''''''''''''''
390 390
@@ -395,7 +395,6 b' After setting up your container (see `Ap'
395 395 to configure it to require authentication on the location configured for
396 396 Kallithea.
397 397
398
399 398 Proxy pass-through authentication
400 399 '''''''''''''''''''''''''''''''''
401 400
@@ -710,6 +709,7 b' Add the following at the end of the .ini'
710 709
711 710 then change ``<someprefix>`` into your chosen prefix
712 711
712
713 713 Apache with mod_wsgi
714 714 --------------------
715 715
@@ -807,6 +807,7 b' the ``init.d`` directory of the Kallithe'
807 807
808 808 .. __: https://kallithea-scm.org/repos/kallithea/files/tip/init.d/ .
809 809
810
810 811 .. _virtualenv: http://pypi.python.org/pypi/virtualenv
811 812 .. _python: http://www.python.org/
812 813 .. _Mercurial: http://mercurial.selenic.com/
@@ -10,6 +10,7 b' Settings'
10 10
11 11 Just copy your .ini file, it contains all Kallithea settings.
12 12
13
13 14 Whoosh index
14 15 ------------
15 16
@@ -9,6 +9,7 b' on how to debug them.'
9 9
10 10 .. note:: First make sure you're using the latest version available.
11 11
12
12 13 Enable detailed debug
13 14 ---------------------
14 15
@@ -15,6 +15,7 b' a username (``smtp_username``) and passw'
15 15 port (``smtp_port``), encryption settings (``smtp_use_tls`` or ``smtp_use_ssl``)
16 16 and/or specific authentication parameters (``smtp_auth``).
17 17
18
18 19 Application emails
19 20 ------------------
20 21
@@ -42,6 +43,7 b' a name and an address in the following f'
42 43 optionally be prefixed with the value of ``email_prefix`` in the configuration
43 44 file.
44 45
46
45 47 Error emails
46 48 ------------
47 49
@@ -61,10 +63,12 b' a name and an address in the following f'
61 63 standard SMTP port (25). If you have a remote SMTP server with a different port,
62 64 you could set up a local forwarding SMTP server on port 25.
63 65
66
64 67 References
65 68 ----------
66 69
67 70 - `Error Middleware (Pylons documentation) <http://pylons-webframework.readthedocs.org/en/latest/debugging.html#error-middleware>`_
68 71 - `ErrorHandler (Pylons modules documentation) <http://pylons-webframework.readthedocs.org/en/latest/modules/middleware.html#pylons.middleware.ErrorHandler>`_
69 72
73
70 74 .. _WebError: https://pypi.python.org/pypi/WebError
@@ -27,6 +27,7 b' It is worth noting that even if someone '
27 27 Kallithea and deletes a repository, you can easily restore such an action by
28 28 renaming the repository directory, removing the ``rm__<date>`` prefix.
29 29
30
30 31 File view: follow current branch
31 32 --------------------------------
32 33
@@ -54,4 +54,5 b' 3. Scale Kallithea horizontally'
54 54 that will separate regular user traffic from automated processes like CI
55 55 servers or build bots.
56 56
57
57 58 .. _SQLAlchemyGrate: https://github.com/shazow/sqlalchemygrate
@@ -17,11 +17,14 b' file ``kallithea/__init__.py`` and comme'
17 17 #'git': 'Git repository',
18 18 }
19 19
20
20 21 Git support
21 22 -----------
22 23
24
23 25 Web server with chunked encoding
24 26 ````````````````````````````````
27
25 28 Large Git pushes require an HTTP server with support for
26 29 chunked encoding for POST. The Python web servers waitress_ and
27 30 gunicorn_ (Linux only) can be used. By default, Kallithea uses
@@ -47,8 +50,10 b' Also make sure to comment out the follow'
47 50 Mercurial support
48 51 -----------------
49 52
53
50 54 Working with Mercurial subrepositories
51 55 ``````````````````````````````````````
56
52 57 This section explains how to use Mercurial subrepositories_ in Kallithea.
53 58
54 59 Example usage::
@@ -77,6 +82,7 b' Cloning ``mainrepo`` will also clone the'
77 82 Next we can edit the subrepository data, and push back to Kallithea. This will
78 83 update both repositories.
79 84
85
80 86 .. _waitress: http://pypi.python.org/pypi/waitress
81 87 .. _gunicorn: http://pypi.python.org/pypi/gunicorn
82 88 .. _subrepositories: http://mercurial.aragost.com/kick-start/en/subrepositories/
@@ -9,6 +9,7 b' Translations are available on Hosted Web'
9 9 Registered users may contribute to the existing languages, or request a new
10 10 language translations.
11 11
12
12 13 Translating using Weblate
13 14 -------------------------
14 15
@@ -26,6 +27,7 b' them. Most common mistakes are inconsist'
26 27 format parameters, untranslated strings copied into the translation. Please perform
27 28 necessary corrections when they're needed, or override the false positives.
28 29
30
29 31 Merging translations from Weblate
30 32 ---------------------------------
31 33
@@ -41,6 +43,7 b' just the same language translation. That'
41 43 which case it should be manually convinced it has to discard the commits it created by
42 44 using its administrative interface.
43 45
46
44 47 Manual creation of a new language translation
45 48 ---------------------------------------------
46 49
@@ -66,6 +69,7 b' Finally, compile the translations::'
66 69
67 70 python setup.py compile_catalog -l <new_language_code>
68 71
72
69 73 Updating translations
70 74 ---------------------
71 75
@@ -80,6 +84,7 b' Update the PO file by doing::'
80 84 Edit the new updated translation file. Repeat all steps after `init_catalog` step from
81 85 new translation instructions
82 86
87
83 88 Testing translations
84 89 --------------------
85 90
General Comments 0
You need to be logged in to leave comments. Login now