##// END OF EJS Templates
rhodecode-enterprise-ce
RSS
docs: update readme
marcink -
r3983:bf7b3c3e default
parent child Browse files
Show More
Show file before | Show file after | Hide comments
@@ -1,116 +1,121 b''
1 =========
1 =========
2 RhodeCode
2 RhodeCode
3 =========
3 =========
4
4
5 About
5 About
6 -----
6 -----
7
7
8 ``RhodeCode`` is a fast and powerful management tool for Mercurial_ and GIT_
8 ``RhodeCode`` is a fast and powerful source code management tool for
9 and Subversion_ with a built in push/pull server, full text search,
9 Mercurial_, GIT_ and Subversion_. It's main features are:
10 pull requests and powerful code-review system. It works on http/https, SSH and
10
11 has a few unique features like:
12
11
13 - plugable architecture from Pyramid web-framework.
12 - built in push/pull server
14 - advanced permission system with IP restrictions, inheritation, and user-groups.
13 - SSH with key management support
14 - full text search.
15 - plugable authentication.
16 - pull requests and powerful code-review system.
17 - advanced permission system with IP restrictions, permission inheritation, and user-groups.
15 - rich set of authentication plugins including LDAP, ActiveDirectory, SAML 2.0,
18 - rich set of authentication plugins including LDAP, ActiveDirectory, SAML 2.0,
16 Atlassian Crowd, Http-Headers, Pam, Token-Auth, OAuth.
19 Atlassian Crowd, Http-Headers, Pam, Token-Auth, OAuth.
17 - live code-review chat, and reviewer rules.
20 - live code-review chat, and reviewer rules.
18 - full web based file editing.
21 - full web based file editing.
19 - unified multi vcs support.
22 - unified multi vcs support.
20 - snippets (gist) system.
23 - snippets (gist) system.
21 - integration framework for Slack, CI systems, Webhooks.
24 - artfacts store for binaries.
25 - integration framework for Slack, CI systems, Webhooks, Jira, Redmine etc.
22 - integration with all 3rd party issue trackers.
26 - integration with all 3rd party issue trackers.
23
27
24
28
25 RhodeCode also provides rich API, and multiple event hooks so it's easy
29 RhodeCode also provides rich API, and multiple event hooks so it's easy
26 integrable with existing external systems.
30 integrable with existing external systems.
27
31
28 RhodeCode is similar in some respects to gitlab_, github_ or bitbucket_,
32 RhodeCode is similar in some respects to gitlab_, github_ or bitbucket_,
29 however RhodeCode can be run as standalone hosted application on your own server.
33 however RhodeCode can be run as standalone hosted application on your own server.
30 RhodeCode can be installed on \*nix or Windows systems.
34 RhodeCode can be installed on \*nix or Windows systems.
31
35
32 RhodeCode uses `PEP386 versioning <http://www.python.org/dev/peps/pep-0386/>`_
36 RhodeCode uses `PEP386 versioning <http://www.python.org/dev/peps/pep-0386/>`_
33
37
34 Installation
38 Installation
35 ------------
39 ------------
36 Please visit https://docs.rhodecode.com/RhodeCode-Control/tasks/install-cli.html
40 Please visit https://docs.rhodecode.com/RhodeCode-Control/tasks/install-cli.html
37 for more details
41 for more details
38
42
39
43
40 Source code
44 Source code
41 -----------
45 -----------
42
46
43 The latest sources can be obtained from official RhodeCode instance
47 The latest sources can be obtained from official RhodeCode instance
44 https://code.rhodecode.com
48 https://code.rhodecode.com/rhodecode-enterprise-ce
49 https://code.rhodecode.com/rhodecode-vcsserver
45
50
46
51
47 Contributions
52 Contributions
48 -------------
53 -------------
49
54
50 RhodeCode is open-source; contributions are welcome!
55 RhodeCode is open-source; contributions are welcome!
51
56
52 Please see the contribution documentation inside of the docs folder, which is
57 Please see the contribution documentation inside of the docs folder, which is
53 also available at
58 also available at
54 https://docs.rhodecode.com/RhodeCode-Enterprise/contributing/contributing.html
59 https://docs.rhodecode.com/RhodeCode-Enterprise/contributing/contributing.html
55
60
56 For additional information about collaboration tools, our issue tracker,
61 For additional information about collaboration tools, our issue tracker,
57 licensing, and contribution credit, visit https://rhodecode.com/open-source
62 licensing, and contribution credit, visit https://rhodecode.com/open-source
58
63
59
64
60 RhodeCode Features
65 RhodeCode Features
61 ------------------
66 ------------------
62
67
63 Check out all features of RhodeCode at https://rhodecode.com/features
68 Check out all features of RhodeCode at https://rhodecode.com/features
64
69
65 License
70 License
66 -------
71 -------
67
72
68 ``RhodeCode`` is dual-licensed with AGPLv3 and commercial license.
73 ``RhodeCode`` is dual-licensed with AGPLv3 and commercial license.
69 Please see LICENSE.txt file for details.
74 Please see LICENSE.txt file for details.
70
75
71
76
72 Getting help
77 Getting help
73 ------------
78 ------------
74
79
75 Listed bellow are various support resources that should help.
80 Listed bellow are various support resources that should help.
76
81
77 .. note::
82 .. note::
78
83
79 Please try to read the documentation before posting any issues, especially
84 Please try to read the documentation before posting any issues, especially
80 the **troubleshooting section**
85 the **troubleshooting section**
81
86
82 - Official issue tracker `RhodeCode Issue tracker <https://issues.rhodecode.com>`_
87 - Official issue tracker `RhodeCode Issue tracker <https://issues.rhodecode.com>`_
83
88
84 - Official Slack Community Channel `RhodeCode Slack <https://rhodecode.com/join>`_
89 - Official Slack Community Channel `RhodeCode Slack <https://rhodecode.com/join>`_
85
90
86 - Search our community portal `Community portal <https://community.rhodecode.com>`_
91 - Search our community portal `Community portal <https://community.rhodecode.com>`_
87
92
88 - You can also follow RhodeCode on twitter **@RhodeCode** where we often post
93 - You can also follow RhodeCode on twitter **@RhodeCode** where we often post
89 news and other interesting stuff about RhodeCode.
94 news and other interesting stuff about RhodeCode.
90
95
91
96
92 Online documentation
97 Online documentation
93 --------------------
98 --------------------
94
99
95 Online documentation for the current version of RhodeCode is available at
100 Online documentation for the current version of RhodeCode is available at
96 - http://rhodecode.com/docs
101 - http://rhodecode.com/docs
97
102
98 You may also build the documentation for yourself - go into ``docs/`` and run::
103 You may also build the documentation for yourself - go into ``docs/`` and run::
99
104
100 nix-build default.nix -o result && make clean html
105 nix-build default.nix -o result && make clean html
101
106
102 (You need to have sphinx_ installed to build the documentation. If you don't
107 (You need to have sphinx_ installed to build the documentation. If you don't
103 have sphinx_ installed you can install it via the command:
108 have sphinx_ installed you can install it via the command:
104 ``pip install sphinx``)
109 ``pip install sphinx``)
105
110
106 .. _virtualenv: http://pypi.python.org/pypi/virtualenv
111 .. _virtualenv: http://pypi.python.org/pypi/virtualenv
107 .. _python: http://www.python.org/
112 .. _python: http://www.python.org/
108 .. _sphinx: http://sphinx.pocoo.org/
113 .. _sphinx: http://sphinx.pocoo.org/
109 .. _mercurial: http://mercurial.selenic.com/
114 .. _mercurial: http://mercurial.selenic.com/
110 .. _bitbucket: http://bitbucket.org/
115 .. _bitbucket: http://bitbucket.org/
111 .. _github: http://github.com/
116 .. _github: http://github.com/
112 .. _gitlab: http://gitlab.com/
117 .. _gitlab: http://gitlab.com/
113 .. _subversion: http://subversion.tigris.org/
118 .. _subversion: http://subversion.tigris.org/
114 .. _git: http://git-scm.com/
119 .. _git: http://git-scm.com/
115 .. _celery: http://celeryproject.org/
120 .. _celery: http://celeryproject.org/
116 .. _vcs: http://pypi.python.org/pypi/vcs
121 .. _vcs: http://pypi.python.org/pypi/vcs
General Comments 0
You need to be logged in to leave comments. Login now