u/pc/rhodecode-enterprise-ce-fork-pc Commit - r3276:7bbad8f3

1

=========

1

=========

2

RhodeCode

2

RhodeCode

3

=========

3

=========

4

5

About

5

About

6

-----

6

-----

7

8

``RhodeCode`` is a fast and powerful management tool for Mercurial_ and GIT_

8

``RhodeCode`` is a fast and powerful management tool for Mercurial_ and GIT_

9

and Subversion_ with a built in push/pull server, full text search,

9

and Subversion_ with a built in push/pull server, full text search,

10

pull requests and powerful code-review system. It works on http/https and

10

pull requests and powerful code-review system. It works on http/https, SSH and

11

has a few unique features like:

11

has a few unique features like:

12

13

- plugable architecture

13

- plugable architecture from Pyramid web-framework.

14

- advanced permission system with IP restrictions

14

- advanced permission system with IP restrictions, inheritation, and user-groups.

15

- rich set of authentication plugins including LDAP,

15

- rich set of authentication plugins including LDAP, ActiveDirectory, SAML 2.0,

16

~~ActiveDirectory,~~ Atlassian Crowd, Http-Headers, Pam, Token-Auth.

16

Atlassian Crowd, Http-Headers, Pam, Token-Auth, OAuth.

17

- live code-review chat

17

- live code-review chat, and reviewer rules.

18

- full web based file editing

18

- full web based file editing.

19

- unified multi vcs support

19

- unified multi vcs support.

20

- snippets (gist) system

20

- snippets (gist) system.

21

- integration with all 3rd party issue trackers

21

- integration framework for Slack, CI systems, Webhooks.

22

- integration with all 3rd party issue trackers.

23

22

24

23

RhodeCode also provides rich API, and multiple event hooks so it's easy

25

RhodeCode also provides rich API, and multiple event hooks so it's easy

24

integrable with existing external systems.

26

integrable with existing external systems.

25

27

26

RhodeCode is similar in some respects to gitlab_, github_ or bitbucket_,

28

RhodeCode is similar in some respects to gitlab_, github_ or bitbucket_,

27

however RhodeCode can be run as standalone hosted application on your own server.

29

however RhodeCode can be run as standalone hosted application on your own server.

28

RhodeCode can be installed on \*nix or Windows systems.

30

RhodeCode can be installed on \*nix or Windows systems.

29

31

30

RhodeCode uses `PEP386 versioning <http://www.python.org/dev/peps/pep-0386/>`_

32

RhodeCode uses `PEP386 versioning <http://www.python.org/dev/peps/pep-0386/>`_

31

33

32

Installation

34

Installation

33

------------

35

------------

34

Please visit https://docs.rhodecode.com/RhodeCode-Control/tasks/install-cli.html

36

Please visit https://docs.rhodecode.com/RhodeCode-Control/tasks/install-cli.html

35

for more details

37

for more details

36

38

37

39

38

Source code

40

Source code

39

-----------

41

-----------

40

42

41

The latest sources can be obtained from official RhodeCode instance

43

The latest sources can be obtained from official RhodeCode instance

42

https://code.rhodecode.com

44

https://code.rhodecode.com

43

45

44

46

45

Contributions

47

Contributions

46

-------------

48

-------------

47

49

48

RhodeCode is open-source; contributions are welcome!

50

RhodeCode is open-source; contributions are welcome!

49

51

50

Please see the contribution documentation inside of the docs folder, which is

52

Please see the contribution documentation inside of the docs folder, which is

51

also available at

53

also available at

52

https://docs.rhodecode.com/RhodeCode-Enterprise/contributing/contributing.html

54

https://docs.rhodecode.com/RhodeCode-Enterprise/contributing/contributing.html

53

55

54

For additional information about collaboration tools, our issue tracker,

56

For additional information about collaboration tools, our issue tracker,

55

licensing, and contribution credit, visit https://rhodecode.com/open-source

57

licensing, and contribution credit, visit https://rhodecode.com/open-source

56

58

57

59

58

RhodeCode Features

60

RhodeCode Features

59

------------------

61

------------------

60

62

61

Check out all features of RhodeCode at https://rhodecode.com/features

63

Check out all features of RhodeCode at https://rhodecode.com/features

62

64

63

License

65

License

64

-------

66

-------

65

67

66

``RhodeCode`` is dual-licensed with AGPLv3 and commercial license.

68

``RhodeCode`` is dual-licensed with AGPLv3 and commercial license.

67

Please see LICENSE.txt file for details.

69

Please see LICENSE.txt file for details.

68

70

69

71

70

Getting help

72

Getting help

71

------------

73

------------

72

74

73

Listed bellow are various support resources that should help.

75

Listed bellow are various support resources that should help.

74

76

75

.. note::

77

.. note::

76

78

77

Please try to read the documentation before posting any issues, especially

79

Please try to read the documentation before posting any issues, especially

78

the **troubleshooting section**

80

the **troubleshooting section**

79

81

80

- Official issue tracker `RhodeCode Issue tracker <https://issues.rhodecode.com>`_

82

- Official issue tracker `RhodeCode Issue tracker <https://issues.rhodecode.com>`_

81

83

82

- Official Slack Community Channel `RhodeCode Slack <https://rhodecode.com/join>`_

84

- Official Slack Community Channel `RhodeCode Slack <https://rhodecode.com/join>`_

83

85

84

- Search our community portal `Community portal <https://community.rhodecode.com>`_

86

- Search our community portal `Community portal <https://community.rhodecode.com>`_

85

87

86

- You can also follow RhodeCode on twitter **@RhodeCode** where we often post

88

- You can also follow RhodeCode on twitter **@RhodeCode** where we often post

87

news and other interesting stuff about RhodeCode.

89

news and other interesting stuff about RhodeCode.

88

90

89

91

90

Online documentation

92

Online documentation

91

--------------------

93

--------------------

92

94

93

Online documentation for the current version of RhodeCode is available at

95

Online documentation for the current version of RhodeCode is available at

94

- http://rhodecode.com/docs

96

- http://rhodecode.com/docs

95

97

96

You may also build the documentation for yourself - go into ``docs/`` and run::

98

You may also build the documentation for yourself - go into ``docs/`` and run::

97

99

98

nix-build default.nix -o result && make clean html

100

nix-build default.nix -o result && make clean html

99

101

100

(You need to have sphinx_ installed to build the documentation. If you don't

102

(You need to have sphinx_ installed to build the documentation. If you don't

101

have sphinx_ installed you can install it via the command:

103

have sphinx_ installed you can install it via the command:

102

``pip install sphinx``)

104

``pip install sphinx``)

103

105

104

.. _virtualenv: http://pypi.python.org/pypi/virtualenv

106

.. _virtualenv: http://pypi.python.org/pypi/virtualenv

105

.. _python: http://www.python.org/

107

.. _python: http://www.python.org/

106

.. _sphinx: http://sphinx.pocoo.org/

108

.. _sphinx: http://sphinx.pocoo.org/

107

.. _mercurial: http://mercurial.selenic.com/

109

.. _mercurial: http://mercurial.selenic.com/

108

.. _bitbucket: http://bitbucket.org/

110

.. _bitbucket: http://bitbucket.org/

109

.. _github: http://github.com/

111

.. _github: http://github.com/

110

.. _gitlab: http://gitlab.com/

112

.. _gitlab: http://gitlab.com/

111

.. _subversion: http://subversion.tigris.org/

113

.. _subversion: http://subversion.tigris.org/

112

.. _git: http://git-scm.com/

114

.. _git: http://git-scm.com/

113

.. _celery: http://celeryproject.org/

115

.. _celery: http://celeryproject.org/

114

.. _vcs: http://pypi.python.org/pypi/vcs

116

.. _vcs: http://pypi.python.org/pypi/vcs

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages

             =========
             RhodeCode
             =========
             About
             -----
             ``RhodeCode`` is a fast and powerful management tool for Mercurial_ and GIT_
             and Subversion_ with a built in push/pull server, full text search,
-            pull requests and powerful code-review system. It works on http/https and
+            pull requests and powerful code-review system. It works on http/https, SSH and
             has a few unique features like:
-             - plugable architecture
+            - plugable architecture from Pyramid web-framework.
-             - advanced permission system with IP restrictions
+            - advanced permission system with IP restrictions, inheritation, and user-groups.
-             - rich set of authentication plugins including LDAP,
+            - rich set of authentication plugins including LDAP, ActiveDirectory, SAML 2.0,
-               ActiveDirectory, Atlassian Crowd, Http-Headers, Pam, Token-Auth.
+              Atlassian Crowd, Http-Headers, Pam, Token-Auth, OAuth.
-             - live code-review chat
+            - live code-review chat, and reviewer rules.
-             - full web based file editing
+            - full web based file editing.
-             - unified multi vcs support
+            - unified multi vcs support.
-             - snippets (gist) system
+            - snippets (gist) system.
-             - integration with all 3rd party issue trackers
+            - integration framework for Slack, CI systems, Webhooks.
+            - integration with all 3rd party issue trackers.
             RhodeCode also provides rich API, and multiple event hooks so it's easy
             integrable with existing external systems.
             RhodeCode is similar in some respects to gitlab_, github_ or bitbucket_,
             however RhodeCode can be run as standalone hosted application on your own server.
             RhodeCode can be installed on \*nix or Windows systems.
             RhodeCode uses `PEP386 versioning <http://www.python.org/dev/peps/pep-0386/>`_
             Installation
             ------------
             Please visit https://docs.rhodecode.com/RhodeCode-Control/tasks/install-cli.html
             for more details
             Source code
             -----------
             The latest sources can be obtained from official RhodeCode instance
             https://code.rhodecode.com
             Contributions
             -------------
             RhodeCode is open-source; contributions are welcome!
             Please see the contribution documentation inside of the docs folder, which is
             also available at
             https://docs.rhodecode.com/RhodeCode-Enterprise/contributing/contributing.html
             For additional information about collaboration tools, our issue tracker,
             licensing, and contribution credit, visit https://rhodecode.com/open-source
             RhodeCode Features
             ------------------
             Check out all features of RhodeCode at https://rhodecode.com/features
             License
             -------
             ``RhodeCode`` is dual-licensed with AGPLv3 and commercial license.
             Please see LICENSE.txt file for details.
             Getting help
             ------------
             Listed bellow are various support resources that should help.
             .. note::
                Please try to read the documentation before posting any issues, especially
                the **troubleshooting section**
             - Official issue tracker `RhodeCode Issue tracker <https://issues.rhodecode.com>`_
             - Official Slack Community Channel `RhodeCode Slack <https://rhodecode.com/join>`_
             - Search our community portal `Community portal <https://community.rhodecode.com>`_
             - You can also follow RhodeCode on twitter **@RhodeCode** where we often post
               news and other interesting stuff about RhodeCode.
             Online documentation
             --------------------
             Online documentation for the current version of RhodeCode is available at
              - http://rhodecode.com/docs
             You may also build the documentation for yourself - go into ``docs/`` and run::
                 nix-build default.nix -o result && make clean html
             (You need to have sphinx_ installed to build the documentation. If you don't
             have sphinx_ installed you can install it via the command:
             ``pip install sphinx``)
             .. _virtualenv: http://pypi.python.org/pypi/virtualenv
             .. _python: http://www.python.org/
             .. _sphinx: http://sphinx.pocoo.org/
             .. _mercurial: http://mercurial.selenic.com/
             .. _bitbucket: http://bitbucket.org/
             .. _github: http://github.com/
             .. _gitlab: http://gitlab.com/
             .. _subversion: http://subversion.tigris.org/
             .. _git: http://git-scm.com/
             .. _celery: http://celeryproject.org/
             .. _vcs: http://pypi.python.org/pypi/vcs