##// END OF EJS Templates
Updated docs
marcink -
r3939:584ec42a beta
parent child Browse files
Show More
@@ -1,157 +1,166 b''
1 .. _general:
1 .. _general:
2
2
3 =======================
3 =======================
4 General RhodeCode usage
4 General RhodeCode usage
5 =======================
5 =======================
6
6
7
7
8 Repository deleting
8 Repository deleting
9 -------------------
9 -------------------
10
10
11 Currently when admin/owner deletes a repository, RhodeCode does not physically
11 Currently when admin/owner deletes a repository, RhodeCode does not physically
12 delete a repository from filesystem, it renames it in a special way so it's
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,
13 not possible to push,clone or access repository. It's worth a notice that,
14 even if someone will be given administrative access to RhodeCode and will
14 even if someone will be given administrative access to RhodeCode and will
15 delete a repository You can easy restore such action by restoring `rm__<date>`
15 delete a repository You can easy restore such action by restoring `rm__<date>`
16 from the repository name, and internal repository storage (.hg/.git). There
16 from the repository name, and internal repository storage (.hg/.git). There
17 is also a special command for cleaning such archived repos::
17 is also a special command for cleaning such archived repos::
18
18
19 paster cleanup-repos --older-than=30d production.ini
19 paster cleanup-repos --older-than=30d production.ini
20
20
21 This command will scan for archived repositories that are older than 30d,
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)
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
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.
24 it's recommended that you run such command via crontab.
25
25
26 Follow current branch in file view
26 Follow current branch in file view
27 ----------------------------------
27 ----------------------------------
28
28
29 In file view when this checkbox is checked the << and >> arrows will jump
29 In file view when this checkbox is checked the << and >> arrows will jump
30 to changesets within the same branch currently viewing. So for example
30 to changesets within the same branch currently viewing. So for example
31 if someone is viewing files at 'beta' branch and marks `follow current branch`
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
32 checkbox the << and >> buttons will only show him revisions for 'beta' branch
33
33
34
34
35 Compare view from changelog
35 Compare view from changelog
36 ---------------------------
36 ---------------------------
37
37
38 Checkboxes in compare view allow users to view combined compare view. You can
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).
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
40 Clicking more than one checkbox will activate a link in top saying
41 `Show selected changesets <from-rev> -> <to-rev>` clicking this will bring
41 `Show selected changesets <from-rev> -> <to-rev>` clicking this will bring
42 compare view. In this view also it's possible to switch to combined compare.
42 compare view. In this view also it's possible to switch to combined compare.
43
43
44 Compare view is also available from the journal on pushes having more than
44 Compare view is also available from the journal on pushes having more than
45 one changeset
45 one changeset
46
46
47
47
48 Non changeable repository urls
48 Non changeable repository urls
49 ------------------------------
49 ------------------------------
50
50
51 Due to complicated nature of repository grouping, often urls of repositories
51 Due to complicated nature of repository grouping, often urls of repositories
52 can change.
52 can change.
53
53
54 example::
54 example::
55
55
56 #before
56 #before
57 http://server.com/repo_name
57 http://server.com/repo_name
58 # after insertion to test_group group the url will be
58 # after insertion to test_group group the url will be
59 http://server.com/test_group/repo_name
59 http://server.com/test_group/repo_name
60
60
61 This can be an issue for build systems and any other hardcoded scripts, moving
61 This can be an issue for build systems and any other hardcoded scripts, moving
62 repository to a group leads to a need for changing external systems. To
62 repository to a group leads to a need for changing external systems. To
63 overcome this RhodeCode introduces a non changable replacement url. It's
63 overcome this RhodeCode introduces a non changable replacement url. It's
64 simply an repository ID prefixed with `_` above urls are also accessible as::
64 simply an repository ID prefixed with `_` above urls are also accessible as::
65
65
66 http://server.com/_<ID>
66 http://server.com/_<ID>
67
67
68 Since ID are always the same moving the repository will not affect such url.
68 Since ID are always the same moving the repository will not affect such url.
69 the _<ID> syntax can be used anywhere in the system so urls with repo_name
69 the _<ID> syntax can be used anywhere in the system so urls with repo_name
70 for changelogs, files and other can be exchanged with _<ID> syntax.
70 for changelogs, files and other can be exchanged with _<ID> syntax.
71
71
72
72
73 Mailing
73 Mailing
74 -------
74 -------
75
75
76 When administrator will fill up the mailing settings in .ini files
76 When administrator will fill up the mailing settings in .ini files
77 RhodeCode will send mails on user registration, or when RhodeCode errors occur
77 RhodeCode will send mails on user registration, or when RhodeCode errors occur
78 on errors the mails will have a detailed traceback of error.
78 on errors the mails will have a detailed traceback of error.
79
79
80
80
81 Mails are also sent for code comments. If someone comments on a changeset
81 Mails are also sent for code comments. If someone comments on a changeset
82 mail is sent to all participants, the person who commited the changeset
82 mail is sent to all participants, the person who commited the changeset
83 (if present in RhodeCode), and to all people mentioned with @mention system.
83 (if present in RhodeCode), and to all people mentioned with @mention system.
84
84
85
85
86 Trending source files
86 Trending source files
87 ---------------------
87 ---------------------
88
88
89 Trending source files are calculated based on pre defined dict of known
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
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
91 custom files it's possible to add new types in `LANGUAGES_EXTENSIONS_MAP` dict
92 located in `/rhodecode/lib/celerylib/tasks.py`
92 located in `/rhodecode/lib/celerylib/tasks.py`
93
93
94
94
95 Cloning remote repositories
95 Cloning remote repositories
96 ---------------------------
96 ---------------------------
97
97
98 RhodeCode has an ability to clone remote repos from given remote locations.
98 RhodeCode has an ability to clone remote repos from given remote locations.
99 Currently it support following options:
99 Currently it support following options:
100
100
101 - hg -> hg clone
101 - hg -> hg clone
102 - svn -> hg clone
102 - svn -> hg clone
103 - git -> git clone
103 - git -> git clone
104
104
105
105
106 .. note::
106 .. note::
107
107
108 - *`svn -> hg` cloning requires `hgsubversion` library to be installed.*
108 - *`svn -> hg` cloning requires `hgsubversion` library to be installed.*
109
109
110 If you need to clone repositories that are protected via basic auth, you
110 If you need to clone repositories that are protected via basic auth, you
111 might pass the url with stored credentials inside eg.
111 might pass the url with stored credentials inside eg.
112 `http://user:passw@remote.server/repo`, RhodeCode will try to login and clone
112 `http://user:passw@remote.server/repo`, RhodeCode will try to login and clone
113 using given credentials. Please take a note that they will be stored as
113 using given credentials. Please take a note that they will be stored as
114 plaintext inside the database. RhodeCode will remove auth info when showing the
114 plaintext inside the database. RhodeCode will remove auth info when showing the
115 clone url in summary page.
115 clone url in summary page.
116
116
117
117
118
118
119 Visual settings in admin pannel
119 Visual settings in admin pannel
120 -------------------------------
120 -------------------------------
121
121
122
122
123 Visualisation settings in RhodeCode settings view are extra customizations
123 Visualisation settings in RhodeCode settings view are extra customizations
124 of server behavior. There are 3 main section in the settings.
124 of server behavior. There are 3 main section in the settings.
125
125
126 General
126 General
127 ~~~~~~~
127 ~~~~~~~
128
128
129 `Use repository extra fields` option allows to set a custom fields for each
129 `Use repository extra fields` option allows to set a custom fields for each
130 repository in the system. Each new field consists of 3 attributes `field key`,
130 repository in the system. Each new field consists of 3 attributes `field key`,
131 `field label`, `field description`. Example usage of such fields would be to
131 `field label`, `field description`. Example usage of such fields would be to
132 define company specific information into repositories eg. defining repo_manager
132 define company specific information into repositories eg. defining repo_manager
133 key that would add give info about a manager of each repository. There's no
133 key that would add give info about a manager of each repository. There's no
134 limit for adding custom fields. Newly created fields are accessible via API.
134 limit for adding custom fields. Newly created fields are accessible via API.
135
135
136 `Show RhodeCode version` option toggles displaying exact RhodeCode version in
137 the footer
138
139
140 Dashboard items
141 ~~~~~~~~~~~~~~~
142
143 Number if items in main page dashboard before pagination is displayed
144
136
145
137 Icons
146 Icons
138 ~~~~~
147 ~~~~~
139
148
140 Show public repo icon / Show private repo icon on repositories - defines if
149 Show public repo icon / Show private repo icon on repositories - defines if
141 public/private icons should be shown in the UI.
150 public/private icons should be shown in the UI.
142
151
143
152
144 Meta-Tagging
153 Meta-Tagging
145 ~~~~~~~~~~~~
154 ~~~~~~~~~~~~
146
155
147 With this option enabled, special metatags that are recognisible by RhodeCode
156 With this option enabled, special metatags that are recognisible by RhodeCode
148 will be turned into colored tags. Currently available tags are::
157 will be turned into colored tags. Currently available tags are::
149
158
150 [featured]
159 [featured]
151 [stale]
160 [stale]
152 [dead]
161 [dead]
153 [lang => lang]
162 [lang => lang]
154 [license => License]
163 [license => License]
155 [requires => Repo]
164 [requires => Repo]
156 [recommends => Repo]
165 [recommends => Repo]
157 [see => URI]
166 [see => URI]
General Comments 0
You need to be logged in to leave comments. Login now