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