Show More
@@ -1,173 +1,174 b'' | |||||
1 | .. _general: |
|
1 | .. _general: | |
2 |
|
2 | |||
3 | ======================= |
|
3 | ======================= | |
4 | General Kallithea usage |
|
4 | General Kallithea usage | |
5 | ======================= |
|
5 | ======================= | |
6 |
|
6 | |||
7 |
|
7 | |||
8 | Repository deletion |
|
8 | Repository deletion | |
9 | ------------------- |
|
9 | ------------------- | |
10 |
|
10 | |||
11 | When an admin or owner deletes a repository, Kallithea does |
|
11 | When an admin or owner deletes a repository, Kallithea does | |
12 | not physically delete said repository from the filesystem, but instead |
|
12 | not physically delete said repository from the filesystem, but instead | |
13 | renames it in a special way so that it is not possible to push, clone |
|
13 | renames it in a special way so that it is not possible to push, clone | |
14 | or access the repository. |
|
14 | or access the repository. | |
15 |
|
15 | |||
16 | There is a special command for cleaning up such archived repositories:: |
|
16 | There is a special command for cleaning up such archived repositories:: | |
17 |
|
17 | |||
18 | kallithea-cli repo-purge-deleted -c my.ini --older-than=30d |
|
18 | kallithea-cli repo-purge-deleted -c my.ini --older-than=30d | |
19 |
|
19 | |||
20 | This command scans for archived repositories that are older than |
|
20 | This command scans for archived repositories that are older than | |
21 | 30 days, displays them, and asks if you want to delete them (unless given |
|
21 | 30 days, displays them, and asks if you want to delete them (unless given | |
22 | the ``--no-ask`` flag). If you host a large amount of repositories with |
|
22 | the ``--no-ask`` flag). If you host a large amount of repositories with | |
23 | forks that are constantly being deleted, it is recommended that you run this |
|
23 | forks that are constantly being deleted, it is recommended that you run this | |
24 | command via crontab. |
|
24 | command via crontab. | |
25 |
|
25 | |||
26 | It is worth noting that even if someone is given administrative access to |
|
26 | It is worth noting that even if someone is given administrative access to | |
27 | Kallithea and deletes a repository, you can easily restore such an action by |
|
27 | Kallithea and deletes a repository, you can easily restore such an action by | |
28 | renaming the repository directory, removing the ``rm__<date>`` prefix. |
|
28 | renaming the repository directory, removing the ``rm__<date>`` prefix. | |
29 |
|
29 | |||
30 |
|
30 | |||
31 | File view: follow current branch |
|
31 | File view: follow current branch | |
32 | -------------------------------- |
|
32 | -------------------------------- | |
33 |
|
33 | |||
34 | In the file view, left and right arrows allow to jump to the previous and next |
|
34 | In the file view, left and right arrows allow to jump to the previous and next | |
35 | revision. Depending on the way revisions were created in the repository, this |
|
35 | revision. Depending on the way revisions were created in the repository, this | |
36 | could jump to a different branch. When the checkbox ``Follow current branch`` |
|
36 | could jump to a different branch. When the checkbox ``Follow current branch`` | |
37 | is checked, these arrows will only jump to revisions on the same branch as the |
|
37 | is checked, these arrows will only jump to revisions on the same branch as the | |
38 | currently visible revision. So for example, if someone is viewing files in the |
|
38 | currently visible revision. So for example, if someone is viewing files in the | |
39 | ``beta`` branch and marks the `Follow current branch` checkbox, the < and > |
|
39 | ``beta`` branch and marks the `Follow current branch` checkbox, the < and > | |
40 | arrows will only show revisions on the ``beta`` branch. |
|
40 | arrows will only show revisions on the ``beta`` branch. | |
41 |
|
41 | |||
42 |
|
42 | |||
43 | Changelog features |
|
43 | Changelog features | |
44 | ------------------ |
|
44 | ------------------ | |
45 |
|
45 | |||
46 | The core feature of a repository's ``changelog`` page is to show the revisions |
|
46 | The core feature of a repository's ``changelog`` page is to show the revisions | |
47 | in a repository. However, there are several other features available from the |
|
47 | in a repository. However, there are several other features available from the | |
48 | changelog. |
|
48 | changelog. | |
49 |
|
49 | |||
50 | Branch filter |
|
50 | Branch filter | |
51 | By default, the changelog shows revisions from all branches in the |
|
51 | By default, the changelog shows revisions from all branches in the | |
52 | repository. Use the branch filter to restrict to a given branch. |
|
52 | repository. Use the branch filter to restrict to a given branch. | |
53 |
|
53 | |||
54 | Viewing a changeset |
|
54 | Viewing a changeset | |
55 | A particular changeset can be opened by clicking on either the changeset |
|
55 | A particular changeset can be opened by clicking on either the changeset | |
56 | hash or the commit message, or by ticking the checkbox and clicking the |
|
56 | hash or the commit message, or by ticking the checkbox and clicking the | |
57 | ``Show selected changeset`` button at the top. |
|
57 | ``Show selected changeset`` button at the top. | |
58 |
|
58 | |||
59 | Viewing all changes between two changesets |
|
59 | Viewing all changes between two changesets | |
60 | To get a list of all changesets between two selected changesets, along with |
|
60 | To get a list of all changesets between two selected changesets, along with | |
61 | the changes in each one of them, tick the checkboxes of the first and |
|
61 | the changes in each one of them, tick the checkboxes of the first and | |
62 | last changeset in the desired range and click the ``Show selected changesets`` |
|
62 | last changeset in the desired range and click the ``Show selected changesets`` | |
63 | button at the top. You can only show the range between the first and last |
|
63 | button at the top. You can only show the range between the first and last | |
64 | checkbox (no cherry-picking). |
|
64 | checkbox (no cherry-picking). | |
65 |
|
65 | |||
66 | From that page, you can proceed to viewing the overall delta between the |
|
66 | From that page, you can proceed to viewing the overall delta between the | |
67 | selected changesets, by clicking the ``Compare revisions`` button. |
|
67 | selected changesets, by clicking the ``Compare revisions`` button. | |
68 |
|
68 | |||
69 | Creating a pull request |
|
69 | Creating a pull request | |
70 | You can create a new pull request for the changes of a particular changeset |
|
70 | You can create a new pull request for the changes of a particular changeset | |
71 | (and its ancestors) by selecting it and clicking the ``Open new pull request |
|
71 | (and its ancestors) by selecting it and clicking the ``Open new pull request | |
72 | for selected changesets`` button. |
|
72 | for selected changesets`` button. | |
73 |
|
73 | |||
74 |
|
74 | |||
75 | Permanent repository URLs |
|
75 | Permanent repository URLs | |
76 | ------------------------- |
|
76 | ------------------------- | |
77 |
|
77 | |||
78 | Due to the complicated nature of repository grouping, URLs of repositories |
|
78 | Due to the complicated nature of repository grouping, URLs of repositories | |
79 | can often change. For example, a repository originally accessible from:: |
|
79 | can often change. For example, a repository originally accessible from:: | |
80 |
|
80 | |||
81 | http://kallithea.example.com/repo_name |
|
81 | http://kallithea.example.com/repo_name | |
82 |
|
82 | |||
83 | would get a new URL after moving it to test_group:: |
|
83 | would get a new URL after moving it to test_group:: | |
84 |
|
84 | |||
85 | http://kallithea.example.com/test_group/repo_name |
|
85 | http://kallithea.example.com/test_group/repo_name | |
86 |
|
86 | |||
87 | Such moving of a repository to a group can be an issue for build systems and |
|
87 | Such moving of a repository to a group can be an issue for build systems and | |
88 | other scripts where the repository paths are hardcoded. To mitigate this, |
|
88 | other scripts where the repository paths are hardcoded. To mitigate this, | |
89 | Kallithea provides permanent URLs using the repository ID prefixed with an |
|
89 | Kallithea provides permanent URLs using the repository ID prefixed with an | |
90 | underscore. In all Kallithea URLs, for example those for the changelog and the |
|
90 | underscore. In all Kallithea URLs, for example those for the changelog and the | |
91 | file view, a repository name can be replaced by this ``_ID`` string. Since IDs |
|
91 | file view, a repository name can be replaced by this ``_ID`` string. Since IDs | |
92 | are always the same, moving the repository to a different group will not affect |
|
92 | are always the same, moving the repository to a different group will not affect | |
93 | such URLs. |
|
93 | such URLs. | |
94 |
|
94 | |||
95 | In the example, the repository could also be accessible as:: |
|
95 | In the example, the repository could also be accessible as:: | |
96 |
|
96 | |||
97 | http://kallithea.example.com/_<ID> |
|
97 | http://kallithea.example.com/_<ID> | |
98 |
|
98 | |||
99 | The ID of a given repository can be shown from the repository ``Summary`` page, |
|
99 | The ID of a given repository can be shown from the repository ``Summary`` page, | |
100 | by selecting the ``Show by ID`` button next to ``Clone URL``. |
|
100 | by selecting the ``Show by ID`` button next to ``Clone URL``. | |
101 |
|
101 | |||
102 |
|
102 | |||
103 | Email notifications |
|
103 | Email notifications | |
104 | ------------------- |
|
104 | ------------------- | |
105 |
|
105 | |||
106 | With email settings properly configured in the Kallithea |
|
106 | With email settings properly configured in the Kallithea | |
107 | configuration file, Kallithea will send emails on user registration and when |
|
107 | configuration file, Kallithea will send emails on user registration and when | |
108 | errors occur. |
|
108 | errors occur. | |
109 |
|
109 | |||
110 | Emails are also sent for comments on changesets. In this case, an email is sent |
|
110 | Emails are also sent for comments on changesets. In this case, an email is sent | |
111 | to the committer of the changeset (if known to Kallithea), to all reviewers of |
|
111 | to the committer of the changeset (if known to Kallithea), to all reviewers of | |
112 | the pull request (if applicable) and to all people mentioned in the comment |
|
112 | the pull request (if applicable) and to all people mentioned in the comment | |
113 | using @mention notation. |
|
113 | using @mention notation. | |
114 |
|
114 | |||
115 |
|
115 | |||
116 | Trending source files |
|
116 | Trending source files | |
117 | --------------------- |
|
117 | --------------------- | |
118 |
|
118 | |||
119 | Trending source files are calculated based on a predefined dictionary of known |
|
119 | Trending source files are calculated based on a predefined dictionary of known | |
120 | types and extensions. If an extension is missing or you would like to scan |
|
120 | types and extensions. If an extension is missing or you would like to scan | |
121 | custom files, it is possible to extend the ``LANGUAGES_EXTENSIONS_MAP`` |
|
121 | custom files, it is possible to add additional file extensions with | |
122 | dictionary located in ``kallithea/config/conf.py`` with new types. |
|
122 | ``EXTRA_MAPPINGS`` in your custom Kallithea extensions.py file. See | |
|
123 | :ref:`customization`. | |||
123 |
|
124 | |||
124 |
|
125 | |||
125 | Cloning remote repositories |
|
126 | Cloning remote repositories | |
126 | --------------------------- |
|
127 | --------------------------- | |
127 |
|
128 | |||
128 | Kallithea has the ability to clone repositories from given remote locations. |
|
129 | Kallithea has the ability to clone repositories from given remote locations. | |
129 |
|
130 | |||
130 | If you need to clone repositories that are protected via basic authentication, |
|
131 | If you need to clone repositories that are protected via basic authentication, | |
131 | you can pass the credentials in the URL, e.g. |
|
132 | you can pass the credentials in the URL, e.g. | |
132 | ``http://user:passw@remote.example.com/repo``. Kallithea will then try to login and |
|
133 | ``http://user:passw@remote.example.com/repo``. Kallithea will then try to login and | |
133 | clone using the given credentials. Please note that the given credentials will |
|
134 | clone using the given credentials. Please note that the given credentials will | |
134 | be stored as plaintext inside the database. However, the authentication |
|
135 | be stored as plaintext inside the database. However, the authentication | |
135 | information will not be shown in the clone URL on the summary page. |
|
136 | information will not be shown in the clone URL on the summary page. | |
136 |
|
137 | |||
137 |
|
138 | |||
138 | Specific features configurable in the Admin settings |
|
139 | Specific features configurable in the Admin settings | |
139 | ---------------------------------------------------- |
|
140 | ---------------------------------------------------- | |
140 |
|
141 | |||
141 | In general, the Admin settings should be self-explanatory and will not be |
|
142 | In general, the Admin settings should be self-explanatory and will not be | |
142 | described in more detail in this documentation. However, there are a few |
|
143 | described in more detail in this documentation. However, there are a few | |
143 | features that merit further explanation. |
|
144 | features that merit further explanation. | |
144 |
|
145 | |||
145 | Repository extra fields |
|
146 | Repository extra fields | |
146 | ^^^^^^^^^^^^^^^^^^^^^^^ |
|
147 | ^^^^^^^^^^^^^^^^^^^^^^^ | |
147 |
|
148 | |||
148 | In the *Visual* tab, there is an option "Use repository extra |
|
149 | In the *Visual* tab, there is an option "Use repository extra | |
149 | fields", which allows to set custom fields for each repository in the system. |
|
150 | fields", which allows to set custom fields for each repository in the system. | |
150 |
|
151 | |||
151 | Once enabled site-wide, the custom fields can be edited per-repository under |
|
152 | Once enabled site-wide, the custom fields can be edited per-repository under | |
152 | *Options* | *Settings* | *Extra Fields*. |
|
153 | *Options* | *Settings* | *Extra Fields*. | |
153 |
|
154 | |||
154 | Example usage of such fields would be to define company-specific information |
|
155 | Example usage of such fields would be to define company-specific information | |
155 | into repositories, e.g., defining a ``repo_manager`` key that would give info |
|
156 | into repositories, e.g., defining a ``repo_manager`` key that would give info | |
156 | about a manager of each repository. There's no limit for adding custom fields. |
|
157 | about a manager of each repository. There's no limit for adding custom fields. | |
157 | Newly created fields are accessible via the API. |
|
158 | Newly created fields are accessible via the API. | |
158 |
|
159 | |||
159 | Meta tagging |
|
160 | Meta tagging | |
160 | ^^^^^^^^^^^^ |
|
161 | ^^^^^^^^^^^^ | |
161 |
|
162 | |||
162 | In the *Visual* tab, option "Stylify recognised meta tags" will cause Kallithea |
|
163 | In the *Visual* tab, option "Stylify recognised meta tags" will cause Kallithea | |
163 | to turn certain text fragments in repository and repository group |
|
164 | to turn certain text fragments in repository and repository group | |
164 | descriptions into colored tags. Currently recognised tags are:: |
|
165 | descriptions into colored tags. Currently recognised tags are:: | |
165 |
|
166 | |||
166 | [featured] |
|
167 | [featured] | |
167 | [stale] |
|
168 | [stale] | |
168 | [dead] |
|
169 | [dead] | |
169 | [lang => lang] |
|
170 | [lang => lang] | |
170 | [license => License] |
|
171 | [license => License] | |
171 | [requires => Repo] |
|
172 | [requires => Repo] | |
172 | [recommends => Repo] |
|
173 | [recommends => Repo] | |
173 | [see => URI] |
|
174 | [see => URI] |
General Comments 0
You need to be logged in to leave comments.
Login now