rhodecode-enterprise-ce Commit - r2926:2123969c

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 powerfull code-review system. It works on http/https and

10

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

11

has a few unique features like:

11

has a few unique features like:

12

~~- plugable architecture~~

13

- plugable architecture

13

- advanced permission system with IP restrictions

14

- advanced permission system with IP restrictions

14

- rich set of authentication plugins including LDAP,

15

- rich set of authentication plugins including LDAP,

15

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

16

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

16

- live code-review chat

17

- live code-review chat

17

- full web based file editing

18

- full web based file editing

18

- unified multi vcs support

19

- unified multi vcs support

19

- snippets (gist) system

20

- snippets (gist) system

20

- integration with all 3rd party issue trackers

21

- integration with all 3rd party issue trackers

21

22

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

23

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

23

integrable with existing external systems.

24

integrable with existing external systems.

24

25

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

26

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

26

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

27

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

27

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

28

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

28

29

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

30

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

30

31

Installation

32

Installation

32

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

33

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

33

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

34

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

34

for more details

35

for more details

35

36

37

Source code

38

Source code

38

-----------

39

-----------

39

40

The latest sources can be obtained from official RhodeCode instance

41

The latest sources can be obtained from official RhodeCode instance

41

https://code.rhodecode.com

42

https://code.rhodecode.com

42

43

44

Contributions

45

Contributions

45

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

46

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

46

47

RhodeCode is open-source; contributions are welcome!

48

RhodeCode is open-source; contributions are welcome!

48

49

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

50

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

50

also available at

51

also available at

51

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

52

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

52

53

For additional information about collaboration tools, our issue tracker,

54

For additional information about collaboration tools, our issue tracker,

54

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

55

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

55

56

57

RhodeCode Features

58

RhodeCode Features

58

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

59

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

59

60

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

61

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

61

62

License

63

License

63

-------

64

-------

64

65

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

66

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

66

Please see LICENSE.txt file for details.

67

Please see LICENSE.txt file for details.

67

68

69

Getting help

70

Getting help

70

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

71

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

71

72

Listed bellow are various support resources that should help.

73

Listed bellow are various support resources that should help.

73

74

.. note::

75

.. note::

75

76

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

77

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

77

the **troubleshooting section**

78

the **troubleshooting section**

78

79

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

80

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

80

81

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

82

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

82

83

- Join #rhodecode on FreeNode (irc.freenode.net)

84

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

84

or use http://webchat.freenode.net/?channels=rhodecode for web access to irc.

85

86

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

86

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

87

news and other interesting stuff about RhodeCode.

87

news and other interesting stuff about RhodeCode.

88

89

90

Online documentation

90

Online documentation

91

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

91

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

92

93

Online documentation for the current version of RhodeCode is available at

93

Online documentation for the current version of RhodeCode is available at

94

- http://rhodecode.com/docs

94

- http://rhodecode.com/docs

95

96

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

96

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

97

98

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

98

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

99

100

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

100

(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:

101

have sphinx_ installed you can install it via the command:

102

``pip install sphinx``)

102

``pip install sphinx``)

103

104

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

104

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

105

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

105

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

106

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

106

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

107

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

107

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

108

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

108

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

109

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

109

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

110

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

110

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

111

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

111

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

112

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

112

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

113

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

113

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

114

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

114

.. _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 powerfull code-review system. It works on http/https and
+            pull requests and powerful code-review system. It works on http/https and
             has a few unique features like:
              - plugable architecture
              - advanced permission system with IP restrictions
              - rich set of authentication plugins including LDAP,
                ActiveDirectory, Atlassian Crowd, Http-Headers, Pam, Token-Auth.
              - live code-review chat
              - full web based file editing
              - unified multi vcs support
              - snippets (gist) system
              - 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>`_
-            - Search our community portal `Community portal <https://community.rhodecode.com>`_
+            - Official Slack Community Channel `RhodeCode Slack <https://rhodecode.com/join>`_
-            - Join #rhodecode on FreeNode (irc.freenode.net)
+            - Search our community portal `Community portal <https://community.rhodecode.com>`_
-              or use http://webchat.freenode.net/?channels=rhodecode for web access to irc.
             - 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