Mercurial > kallithea
annotate docs/usage/general.rst @ 4846:4fbab9d5be4d
email templates: don't do HTML escaping in plain text templates - convert to Unicode
author | Andrew Shadura <andrew@shadura.me> |
---|---|
date | Fri, 23 Jan 2015 21:26:10 +0100 |
parents | e73a69cb98dc |
children | 03bbd33bc084 |
rev | line source |
---|---|
1025 | 1 .. _general: |
2 | |
2095 | 3 ======================= |
4192
e73a69cb98dc
Rename some strings examples and commands in documentation
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents:
4186
diff
changeset
|
4 General Kallithea usage |
1025 | 5 ======================= |
6 | |
7 | |
8 Repository deleting | |
1123 | 9 ------------------- |
1025 | 10 |
4192
e73a69cb98dc
Rename some strings examples and commands in documentation
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents:
4186
diff
changeset
|
11 Currently when admin/owner deletes a repository, Kallithea does not physically |
1025 | 12 delete a repository from filesystem, it renames it in a special way so it's |
13 not possible to push,clone or access repository. It's worth a notice that, | |
4192
e73a69cb98dc
Rename some strings examples and commands in documentation
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents:
4186
diff
changeset
|
14 even if someone will be given administrative access to Kallithea and will |
1025 | 15 delete a repository You can easy restore such action by restoring `rm__<date>` |
3335 | 16 from the repository name, and internal repository storage (.hg/.git). There |
17 is also a special command for cleaning such archived repos:: | |
18 | |
19 paster cleanup-repos --older-than=30d production.ini | |
20 | |
21 This command will scan for archived repositories that are older than 30d, | |
22 display them and ask if you want to delete them (there's a --dont-ask flag also) | |
23 If you host big amount of repositories with forks that are constantly deleted | |
24 it's recommended that you run such command via crontab. | |
1025 | 25 |
26 Follow current branch in file view | |
1123 | 27 ---------------------------------- |
1025 | 28 |
29 In file view when this checkbox is checked the << and >> arrows will jump | |
1026
3c80eb712a78
uncommented migrate tables, docfix
Marcin Kuzminski <marcin@python-works.com>
parents:
1025
diff
changeset
|
30 to changesets within the same branch currently viewing. So for example |
1025 | 31 if someone is viewing files at 'beta' branch and marks `follow current branch` |
32 checkbox the << and >> buttons will only show him revisions for 'beta' branch | |
33 | |
34 | |
35 Compare view from changelog | |
1123 | 36 --------------------------- |
1025 | 37 |
38 Checkboxes in compare view allow users to view combined compare view. You can | |
39 only show the range between the first and last checkbox (no cherry pick). | |
40 Clicking more than one checkbox will activate a link in top saying | |
3592
549c73bfc206
changelog / compare: adjust titles
Mads Kiilerich <madski@unity3d.com>
parents:
3335
diff
changeset
|
41 `Show selected changesets <from-rev> -> <to-rev>` clicking this will bring |
3335 | 42 compare view. In this view also it's possible to switch to combined compare. |
1025 | 43 |
44 Compare view is also available from the journal on pushes having more than | |
45 one changeset | |
46 | |
47 | |
1813
a8c66e870bd0
implements #285: Implemented non changeable urls for clone url, and web views
Marcin Kuzminski <marcin@python-works.com>
parents:
1123
diff
changeset
|
48 Non changeable repository urls |
a8c66e870bd0
implements #285: Implemented non changeable urls for clone url, and web views
Marcin Kuzminski <marcin@python-works.com>
parents:
1123
diff
changeset
|
49 ------------------------------ |
a8c66e870bd0
implements #285: Implemented non changeable urls for clone url, and web views
Marcin Kuzminski <marcin@python-works.com>
parents:
1123
diff
changeset
|
50 |
a8c66e870bd0
implements #285: Implemented non changeable urls for clone url, and web views
Marcin Kuzminski <marcin@python-works.com>
parents:
1123
diff
changeset
|
51 Due to complicated nature of repository grouping, often urls of repositories |
a8c66e870bd0
implements #285: Implemented non changeable urls for clone url, and web views
Marcin Kuzminski <marcin@python-works.com>
parents:
1123
diff
changeset
|
52 can change. |
a8c66e870bd0
implements #285: Implemented non changeable urls for clone url, and web views
Marcin Kuzminski <marcin@python-works.com>
parents:
1123
diff
changeset
|
53 |
a8c66e870bd0
implements #285: Implemented non changeable urls for clone url, and web views
Marcin Kuzminski <marcin@python-works.com>
parents:
1123
diff
changeset
|
54 example:: |
3224
8b8edfc25856
whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents:
2775
diff
changeset
|
55 |
1813
a8c66e870bd0
implements #285: Implemented non changeable urls for clone url, and web views
Marcin Kuzminski <marcin@python-works.com>
parents:
1123
diff
changeset
|
56 #before |
a8c66e870bd0
implements #285: Implemented non changeable urls for clone url, and web views
Marcin Kuzminski <marcin@python-works.com>
parents:
1123
diff
changeset
|
57 http://server.com/repo_name |
a8c66e870bd0
implements #285: Implemented non changeable urls for clone url, and web views
Marcin Kuzminski <marcin@python-works.com>
parents:
1123
diff
changeset
|
58 # after insertion to test_group group the url will be |
a8c66e870bd0
implements #285: Implemented non changeable urls for clone url, and web views
Marcin Kuzminski <marcin@python-works.com>
parents:
1123
diff
changeset
|
59 http://server.com/test_group/repo_name |
3224
8b8edfc25856
whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents:
2775
diff
changeset
|
60 |
1813
a8c66e870bd0
implements #285: Implemented non changeable urls for clone url, and web views
Marcin Kuzminski <marcin@python-works.com>
parents:
1123
diff
changeset
|
61 This can be an issue for build systems and any other hardcoded scripts, moving |
3224
8b8edfc25856
whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents:
2775
diff
changeset
|
62 repository to a group leads to a need for changing external systems. To |
4192
e73a69cb98dc
Rename some strings examples and commands in documentation
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents:
4186
diff
changeset
|
63 overcome this Kallithea introduces a non changable replacement url. It's |
1813
a8c66e870bd0
implements #285: Implemented non changeable urls for clone url, and web views
Marcin Kuzminski <marcin@python-works.com>
parents:
1123
diff
changeset
|
64 simply an repository ID prefixed with `_` above urls are also accessible as:: |
a8c66e870bd0
implements #285: Implemented non changeable urls for clone url, and web views
Marcin Kuzminski <marcin@python-works.com>
parents:
1123
diff
changeset
|
65 |
a8c66e870bd0
implements #285: Implemented non changeable urls for clone url, and web views
Marcin Kuzminski <marcin@python-works.com>
parents:
1123
diff
changeset
|
66 http://server.com/_<ID> |
3224
8b8edfc25856
whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents:
2775
diff
changeset
|
67 |
1813
a8c66e870bd0
implements #285: Implemented non changeable urls for clone url, and web views
Marcin Kuzminski <marcin@python-works.com>
parents:
1123
diff
changeset
|
68 Since ID are always the same moving the repository will not affect such url. |
3224
8b8edfc25856
whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents:
2775
diff
changeset
|
69 the _<ID> syntax can be used anywhere in the system so urls with repo_name |
1813
a8c66e870bd0
implements #285: Implemented non changeable urls for clone url, and web views
Marcin Kuzminski <marcin@python-works.com>
parents:
1123
diff
changeset
|
70 for changelogs, files and other can be exchanged with _<ID> syntax. |
a8c66e870bd0
implements #285: Implemented non changeable urls for clone url, and web views
Marcin Kuzminski <marcin@python-works.com>
parents:
1123
diff
changeset
|
71 |
a8c66e870bd0
implements #285: Implemented non changeable urls for clone url, and web views
Marcin Kuzminski <marcin@python-works.com>
parents:
1123
diff
changeset
|
72 |
1025 | 73 Mailing |
1123 | 74 ------- |
1025 | 75 |
76 When administrator will fill up the mailing settings in .ini files | |
4192
e73a69cb98dc
Rename some strings examples and commands in documentation
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents:
4186
diff
changeset
|
77 Kallithea will send mails on user registration, or when Kallithea errors occur |
1025 | 78 on errors the mails will have a detailed traceback of error. |
79 | |
80 | |
2105
926f55b038bc
added initial rc-extension module
Marcin Kuzminski <marcin@python-works.com>
parents:
2095
diff
changeset
|
81 Mails are also sent for code comments. If someone comments on a changeset |
3224
8b8edfc25856
whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents:
2775
diff
changeset
|
82 mail is sent to all participants, the person who commited the changeset |
4192
e73a69cb98dc
Rename some strings examples and commands in documentation
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents:
4186
diff
changeset
|
83 (if present in Kallithea), and to all people mentioned with @mention system. |
2105
926f55b038bc
added initial rc-extension module
Marcin Kuzminski <marcin@python-works.com>
parents:
2095
diff
changeset
|
84 |
926f55b038bc
added initial rc-extension module
Marcin Kuzminski <marcin@python-works.com>
parents:
2095
diff
changeset
|
85 |
1025 | 86 Trending source files |
1123 | 87 --------------------- |
1025 | 88 |
89 Trending source files are calculated based on pre defined dict of known | |
90 types and extensions. If You miss some extension or Would like to scan some | |
91 custom files it's possible to add new types in `LANGUAGES_EXTENSIONS_MAP` dict | |
4186
7e5f8c12a3fc
First step in two-part process to rename directories to kallithea.
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents:
3960
diff
changeset
|
92 located in `/kallithea/lib/celerylib/tasks.py` |
2706
22f79562836c
Fixed validators for remote repos
Marcin Kuzminski <marcin@python-works.com>
parents:
2105
diff
changeset
|
93 |
22f79562836c
Fixed validators for remote repos
Marcin Kuzminski <marcin@python-works.com>
parents:
2105
diff
changeset
|
94 |
22f79562836c
Fixed validators for remote repos
Marcin Kuzminski <marcin@python-works.com>
parents:
2105
diff
changeset
|
95 Cloning remote repositories |
22f79562836c
Fixed validators for remote repos
Marcin Kuzminski <marcin@python-works.com>
parents:
2105
diff
changeset
|
96 --------------------------- |
22f79562836c
Fixed validators for remote repos
Marcin Kuzminski <marcin@python-works.com>
parents:
2105
diff
changeset
|
97 |
4192
e73a69cb98dc
Rename some strings examples and commands in documentation
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents:
4186
diff
changeset
|
98 Kallithea has an ability to clone remote repos from given remote locations. |
2706
22f79562836c
Fixed validators for remote repos
Marcin Kuzminski <marcin@python-works.com>
parents:
2105
diff
changeset
|
99 Currently it support following options: |
22f79562836c
Fixed validators for remote repos
Marcin Kuzminski <marcin@python-works.com>
parents:
2105
diff
changeset
|
100 |
22f79562836c
Fixed validators for remote repos
Marcin Kuzminski <marcin@python-works.com>
parents:
2105
diff
changeset
|
101 - hg -> hg clone |
22f79562836c
Fixed validators for remote repos
Marcin Kuzminski <marcin@python-works.com>
parents:
2105
diff
changeset
|
102 - svn -> hg clone |
22f79562836c
Fixed validators for remote repos
Marcin Kuzminski <marcin@python-works.com>
parents:
2105
diff
changeset
|
103 - git -> git clone |
22f79562836c
Fixed validators for remote repos
Marcin Kuzminski <marcin@python-works.com>
parents:
2105
diff
changeset
|
104 |
22f79562836c
Fixed validators for remote repos
Marcin Kuzminski <marcin@python-works.com>
parents:
2105
diff
changeset
|
105 |
22f79562836c
Fixed validators for remote repos
Marcin Kuzminski <marcin@python-works.com>
parents:
2105
diff
changeset
|
106 .. note:: |
3224
8b8edfc25856
whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents:
2775
diff
changeset
|
107 |
2706
22f79562836c
Fixed validators for remote repos
Marcin Kuzminski <marcin@python-works.com>
parents:
2105
diff
changeset
|
108 - *`svn -> hg` cloning requires `hgsubversion` library to be installed.* |
22f79562836c
Fixed validators for remote repos
Marcin Kuzminski <marcin@python-works.com>
parents:
2105
diff
changeset
|
109 |
22f79562836c
Fixed validators for remote repos
Marcin Kuzminski <marcin@python-works.com>
parents:
2105
diff
changeset
|
110 If you need to clone repositories that are protected via basic auth, you |
3224
8b8edfc25856
whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents:
2775
diff
changeset
|
111 might pass the url with stored credentials inside eg. |
4192
e73a69cb98dc
Rename some strings examples and commands in documentation
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents:
4186
diff
changeset
|
112 `http://user:passw@remote.server/repo`, Kallithea will try to login and clone |
2706
22f79562836c
Fixed validators for remote repos
Marcin Kuzminski <marcin@python-works.com>
parents:
2105
diff
changeset
|
113 using given credentials. Please take a note that they will be stored as |
4192
e73a69cb98dc
Rename some strings examples and commands in documentation
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents:
4186
diff
changeset
|
114 plaintext inside the database. Kallithea will remove auth info when showing the |
2706
22f79562836c
Fixed validators for remote repos
Marcin Kuzminski <marcin@python-works.com>
parents:
2105
diff
changeset
|
115 clone url in summary page. |
3770
9f5a4e785823
Updated docs regarding visual settings
Marcin Kuzminski <marcin@python-works.com>
parents:
3703
diff
changeset
|
116 |
9f5a4e785823
Updated docs regarding visual settings
Marcin Kuzminski <marcin@python-works.com>
parents:
3703
diff
changeset
|
117 |
9f5a4e785823
Updated docs regarding visual settings
Marcin Kuzminski <marcin@python-works.com>
parents:
3703
diff
changeset
|
118 |
9f5a4e785823
Updated docs regarding visual settings
Marcin Kuzminski <marcin@python-works.com>
parents:
3703
diff
changeset
|
119 Visual settings in admin pannel |
9f5a4e785823
Updated docs regarding visual settings
Marcin Kuzminski <marcin@python-works.com>
parents:
3703
diff
changeset
|
120 ------------------------------- |
9f5a4e785823
Updated docs regarding visual settings
Marcin Kuzminski <marcin@python-works.com>
parents:
3703
diff
changeset
|
121 |
9f5a4e785823
Updated docs regarding visual settings
Marcin Kuzminski <marcin@python-works.com>
parents:
3703
diff
changeset
|
122 |
4192
e73a69cb98dc
Rename some strings examples and commands in documentation
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents:
4186
diff
changeset
|
123 Visualisation settings in Kallithea settings view are extra customizations |
3770
9f5a4e785823
Updated docs regarding visual settings
Marcin Kuzminski <marcin@python-works.com>
parents:
3703
diff
changeset
|
124 of server behavior. There are 3 main section in the settings. |
9f5a4e785823
Updated docs regarding visual settings
Marcin Kuzminski <marcin@python-works.com>
parents:
3703
diff
changeset
|
125 |
9f5a4e785823
Updated docs regarding visual settings
Marcin Kuzminski <marcin@python-works.com>
parents:
3703
diff
changeset
|
126 General |
9f5a4e785823
Updated docs regarding visual settings
Marcin Kuzminski <marcin@python-works.com>
parents:
3703
diff
changeset
|
127 ~~~~~~~ |
3777 | 128 |
3770
9f5a4e785823
Updated docs regarding visual settings
Marcin Kuzminski <marcin@python-works.com>
parents:
3703
diff
changeset
|
129 `Use repository extra fields` option allows to set a custom fields for each |
9f5a4e785823
Updated docs regarding visual settings
Marcin Kuzminski <marcin@python-works.com>
parents:
3703
diff
changeset
|
130 repository in the system. Each new field consists of 3 attributes `field key`, |
9f5a4e785823
Updated docs regarding visual settings
Marcin Kuzminski <marcin@python-works.com>
parents:
3703
diff
changeset
|
131 `field label`, `field description`. Example usage of such fields would be to |
9f5a4e785823
Updated docs regarding visual settings
Marcin Kuzminski <marcin@python-works.com>
parents:
3703
diff
changeset
|
132 define company specific information into repositories eg. defining repo_manager |
9f5a4e785823
Updated docs regarding visual settings
Marcin Kuzminski <marcin@python-works.com>
parents:
3703
diff
changeset
|
133 key that would add give info about a manager of each repository. There's no |
9f5a4e785823
Updated docs regarding visual settings
Marcin Kuzminski <marcin@python-works.com>
parents:
3703
diff
changeset
|
134 limit for adding custom fields. Newly created fields are accessible via API. |
9f5a4e785823
Updated docs regarding visual settings
Marcin Kuzminski <marcin@python-works.com>
parents:
3703
diff
changeset
|
135 |
4192
e73a69cb98dc
Rename some strings examples and commands in documentation
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents:
4186
diff
changeset
|
136 `Show Kallithea version` option toggles displaying exact Kallithea version in |
3939 | 137 the footer |
138 | |
139 | |
140 Dashboard items | |
141 ~~~~~~~~~~~~~~~ | |
142 | |
143 Number if items in main page dashboard before pagination is displayed | |
144 | |
3770
9f5a4e785823
Updated docs regarding visual settings
Marcin Kuzminski <marcin@python-works.com>
parents:
3703
diff
changeset
|
145 |
9f5a4e785823
Updated docs regarding visual settings
Marcin Kuzminski <marcin@python-works.com>
parents:
3703
diff
changeset
|
146 Icons |
9f5a4e785823
Updated docs regarding visual settings
Marcin Kuzminski <marcin@python-works.com>
parents:
3703
diff
changeset
|
147 ~~~~~ |
9f5a4e785823
Updated docs regarding visual settings
Marcin Kuzminski <marcin@python-works.com>
parents:
3703
diff
changeset
|
148 |
9f5a4e785823
Updated docs regarding visual settings
Marcin Kuzminski <marcin@python-works.com>
parents:
3703
diff
changeset
|
149 Show public repo icon / Show private repo icon on repositories - defines if |
9f5a4e785823
Updated docs regarding visual settings
Marcin Kuzminski <marcin@python-works.com>
parents:
3703
diff
changeset
|
150 public/private icons should be shown in the UI. |
9f5a4e785823
Updated docs regarding visual settings
Marcin Kuzminski <marcin@python-works.com>
parents:
3703
diff
changeset
|
151 |
9f5a4e785823
Updated docs regarding visual settings
Marcin Kuzminski <marcin@python-works.com>
parents:
3703
diff
changeset
|
152 |
9f5a4e785823
Updated docs regarding visual settings
Marcin Kuzminski <marcin@python-works.com>
parents:
3703
diff
changeset
|
153 Meta-Tagging |
9f5a4e785823
Updated docs regarding visual settings
Marcin Kuzminski <marcin@python-works.com>
parents:
3703
diff
changeset
|
154 ~~~~~~~~~~~~ |
9f5a4e785823
Updated docs regarding visual settings
Marcin Kuzminski <marcin@python-works.com>
parents:
3703
diff
changeset
|
155 |
4192
e73a69cb98dc
Rename some strings examples and commands in documentation
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents:
4186
diff
changeset
|
156 With this option enabled, special metatags that are recognisible by Kallithea |
3770
9f5a4e785823
Updated docs regarding visual settings
Marcin Kuzminski <marcin@python-works.com>
parents:
3703
diff
changeset
|
157 will be turned into colored tags. Currently available tags are:: |
9f5a4e785823
Updated docs regarding visual settings
Marcin Kuzminski <marcin@python-works.com>
parents:
3703
diff
changeset
|
158 |
9f5a4e785823
Updated docs regarding visual settings
Marcin Kuzminski <marcin@python-works.com>
parents:
3703
diff
changeset
|
159 [featured] |
9f5a4e785823
Updated docs regarding visual settings
Marcin Kuzminski <marcin@python-works.com>
parents:
3703
diff
changeset
|
160 [stale] |
9f5a4e785823
Updated docs regarding visual settings
Marcin Kuzminski <marcin@python-works.com>
parents:
3703
diff
changeset
|
161 [dead] |
9f5a4e785823
Updated docs regarding visual settings
Marcin Kuzminski <marcin@python-works.com>
parents:
3703
diff
changeset
|
162 [lang => lang] |
9f5a4e785823
Updated docs regarding visual settings
Marcin Kuzminski <marcin@python-works.com>
parents:
3703
diff
changeset
|
163 [license => License] |
9f5a4e785823
Updated docs regarding visual settings
Marcin Kuzminski <marcin@python-works.com>
parents:
3703
diff
changeset
|
164 [requires => Repo] |
9f5a4e785823
Updated docs regarding visual settings
Marcin Kuzminski <marcin@python-works.com>
parents:
3703
diff
changeset
|
165 [recommends => Repo] |
9f5a4e785823
Updated docs regarding visual settings
Marcin Kuzminski <marcin@python-works.com>
parents:
3703
diff
changeset
|
166 [see => URI] |