Show More
@@ -1,172 +1,168 b'' | |||||
1 | .. _system-overview-ref: |
|
1 | .. _system-overview-ref: | |
2 |
|
2 | |||
3 | System Overview |
|
3 | System Overview | |
4 | =============== |
|
4 | =============== | |
5 |
|
5 | |||
6 | Latest Version |
|
6 | Latest Version | |
7 | -------------- |
|
7 | -------------- | |
8 |
|
8 | |||
9 | * |release| on Unix and Windows systems. |
|
9 | * |release| on Unix and Windows systems. | |
10 |
|
10 | |||
11 | System Architecture |
|
11 | System Architecture | |
12 | ------------------- |
|
12 | ------------------- | |
13 |
|
13 | |||
14 | The following diagram shows a typical production architecture. |
|
14 | The following diagram shows a typical production architecture. | |
15 |
|
15 | |||
16 | .. image:: ../images/architecture-diagram.png |
|
16 | .. image:: ../images/architecture-diagram.png | |
17 | :align: center |
|
17 | :align: center | |
18 |
|
18 | |||
19 | Supported Operating Systems |
|
19 | Supported Operating Systems | |
20 | --------------------------- |
|
20 | --------------------------- | |
21 |
|
21 | |||
22 | Linux |
|
22 | Linux | |
23 | ^^^^^ |
|
23 | ^^^^^ | |
24 |
|
24 | |||
25 | * Ubuntu 14.04+ |
|
25 | * Ubuntu 14.04+ | |
26 | * CentOS 6.2, 7 and 8 |
|
26 | * CentOS 6.2, 7 and 8 | |
27 | * RHEL 6.2, 7 and 8 |
|
27 | * RHEL 6.2, 7 and 8 | |
28 | * Debian 7.8 |
|
28 | * Debian 7.8 | |
29 | * RedHat Fedora |
|
29 | * RedHat Fedora | |
30 | * Arch Linux |
|
30 | * Arch Linux | |
31 | * SUSE Linux |
|
31 | * SUSE Linux | |
32 |
|
32 | |||
33 | Windows |
|
33 | Windows | |
34 | ^^^^^^^ |
|
34 | ^^^^^^^ | |
35 |
|
35 | |||
36 | * Windows Vista Ultimate 64bit |
|
36 | * Windows Vista Ultimate 64bit | |
37 | * Windows 7 Ultimate 64bit |
|
37 | * Windows 7 Ultimate 64bit | |
38 | * Windows 8 Professional 64bit |
|
38 | * Windows 8 Professional 64bit | |
39 | * Windows 8.1 Enterprise 64bit |
|
39 | * Windows 8.1 Enterprise 64bit | |
40 | * Windows Server 2008 64bit |
|
40 | * Windows Server 2008 64bit | |
41 | * Windows Server 2008-R2 64bit |
|
41 | * Windows Server 2008-R2 64bit | |
42 | * Windows Server 2012 64bit |
|
42 | * Windows Server 2012 64bit | |
43 |
|
43 | |||
44 | Supported Databases |
|
44 | Supported Databases | |
45 | ------------------- |
|
45 | ------------------- | |
46 |
|
46 | |||
47 | * SQLite |
|
47 | * SQLite | |
48 | * MySQL |
|
48 | * MySQL | |
49 | * MariaDB |
|
49 | * MariaDB | |
50 | * PostgreSQL |
|
50 | * PostgreSQL | |
51 |
|
51 | |||
52 | Supported Browsers |
|
52 | Supported Browsers | |
53 | ------------------ |
|
53 | ------------------ | |
54 |
|
54 | |||
55 | * Chrome |
|
55 | * Chrome | |
56 | * Safari |
|
56 | * Safari | |
57 | * Firefox |
|
57 | * Firefox | |
58 | * Internet Explorer 10 & 11 |
|
58 | * Internet Explorer 10 & 11 | |
59 |
|
59 | |||
60 | System Requirements |
|
60 | System Requirements | |
61 | ------------------- |
|
61 | ------------------- | |
62 |
|
62 | |||
63 | |RCE| performs best on machines with ultra-fast hard disks. Generally disk |
|
63 | |RCE| performs best on machines with ultra-fast hard disks. Generally disk | |
64 | performance is more important than CPU performance. In a corporate production |
|
64 | performance is more important than CPU performance. In a corporate production | |
65 | environment handling 1000s of users and |repos| you should deploy on a 12+ |
|
65 | environment handling 1000s of users and |repos| you should deploy on a 12+ | |
66 | core 64GB RAM server. In short, the more RAM the better. |
|
66 | core 64GB RAM server. In short, the more RAM the better. | |
67 |
|
67 | |||
68 |
|
68 | |||
69 | For example: |
|
69 | For example: | |
70 |
|
70 | |||
71 | - for team of 1 - 5 active users you can run on 1GB RAM machine with 1CPU |
|
71 | - for team of 1 - 5 active users you can run on 1GB RAM machine with 1CPU | |
72 | - above 250 active users, |RCE| needs at least 8GB of memory. |
|
72 | - above 250 active users, |RCE| needs at least 8GB of memory. | |
73 | Number of CPUs is less important, but recommended to have at least 2-3 CPUs |
|
73 | Number of CPUs is less important, but recommended to have at least 2-3 CPUs | |
74 |
|
74 | |||
75 |
|
75 | |||
76 | .. _config-rce-files: |
|
76 | .. _config-rce-files: | |
77 |
|
77 | |||
78 | Configuration Files |
|
78 | Configuration Files | |
79 | ------------------- |
|
79 | ------------------- | |
80 |
|
80 | |||
81 | * :file:`config/_shared/rhodecode.ini` |
|
81 | * :file:`config/_shared/rhodecode.ini` | |
82 | * :file:`/home/{user}/.rccontrol/{instance-id}/search_mapping.ini` |
|
82 | * :file:`/home/{user}/.rccontrol/{instance-id}/search_mapping.ini` | |
83 | * :file:`/home/{user}/.rccontrol/{vcsserver-id}/vcsserver.ini` |
|
83 | * :file:`/home/{user}/.rccontrol/{vcsserver-id}/vcsserver.ini` | |
84 | * :file:`/home/{user}/.rccontrol/supervisor/supervisord.ini` |
|
84 | * :file:`/home/{user}/.rccontrol/supervisor/supervisord.ini` | |
85 | * :file:`/home/{user}/.rccontrol.ini` |
|
85 | * :file:`/home/{user}/.rccontrol.ini` | |
86 | * :file:`/home/{user}/.rhoderc` |
|
86 | * :file:`/home/{user}/.rhoderc` | |
87 | * :file:`/home/{user}/.rccontrol/cache/MANIFEST` |
|
87 | * :file:`/home/{user}/.rccontrol/cache/MANIFEST` | |
88 |
|
88 | |||
89 | For more information, see the :ref:`config-files` section. |
|
89 | For more information, see the :ref:`config-files` section. | |
90 |
|
90 | |||
91 | Log Files |
|
91 | Log Files | |
92 | --------- |
|
92 | --------- | |
93 |
|
93 | |||
94 | * :file:`/home/{user}/.rccontrol/{instance-id}/enterprise.log` |
|
94 | * :file:`/home/{user}/.rccontrol/{instance-id}/enterprise.log` | |
95 | * :file:`/home/{user}/.rccontrol/{vcsserver-id}/vcsserver.log` |
|
95 | * :file:`/home/{user}/.rccontrol/{vcsserver-id}/vcsserver.log` | |
96 | * :file:`/home/{user}/.rccontrol/supervisor/supervisord.log` |
|
96 | * :file:`/home/{user}/.rccontrol/supervisor/supervisord.log` | |
97 | * :file:`/tmp/rccontrol.log` |
|
97 | * :file:`/tmp/rccontrol.log` | |
98 | * :file:`/tmp/rhodecode_tools.log` |
|
98 | * :file:`/tmp/rhodecode_tools.log` | |
99 |
|
99 | |||
100 | Storage Files |
|
100 | Storage Files | |
101 | ------------- |
|
101 | ------------- | |
102 |
|
102 | |||
103 | * :file:`/home/{user}/.rccontrol/{instance-id}/data/index/{index-file.toc}` |
|
103 | * :file:`/home/{user}/.rccontrol/{instance-id}/data/index/{index-file.toc}` | |
104 | * :file:`/home/{user}/repos/.rc_gist_store` |
|
104 | * :file:`/home/{user}/repos/.rc_gist_store` | |
105 | * :file:`/home/{user}/.rccontrol/{instance-id}/rhodecode.db` |
|
105 | * :file:`/home/{user}/.rccontrol/{instance-id}/rhodecode.db` | |
106 | * :file:`/opt/rhodecode/store/{unique-hash}` |
|
106 | * :file:`/opt/rhodecode/store/{unique-hash}` | |
107 |
|
107 | |||
108 | Default Repositories Location |
|
108 | Default Repositories Location | |
109 | ----------------------------- |
|
109 | ----------------------------- | |
110 |
|
110 | |||
111 | * :file:`/home/{user}/repos` |
|
111 | * :file:`/home/{user}/repos` | |
112 |
|
112 | |||
113 | Connection Methods |
|
113 | Connection Methods | |
114 | ------------------ |
|
114 | ------------------ | |
115 |
|
115 | |||
116 | * HTTPS |
|
116 | * HTTPS | |
117 | * SSH |
|
117 | * SSH | |
118 | * |RCE| API |
|
118 | * |RCE| API | |
119 |
|
119 | |||
120 | Internationalization Support |
|
120 | Internationalization Support | |
121 | ---------------------------- |
|
121 | ---------------------------- | |
122 |
|
122 | |||
123 | Currently available in the following languages, see `Transifex`_ for the |
|
123 | Currently available in the following languages, see `Transifex`_ for the | |
124 | latest details. If you want a new language added, please contact us. To |
|
124 | latest details. If you want a new language added, please contact us. To | |
125 | configure your language settings, see the :ref:`set-lang` section. |
|
125 | configure your language settings, see the :ref:`set-lang` section. | |
126 |
|
126 | |||
127 | .. hlist:: |
|
127 | .. hlist:: | |
128 |
|
128 | |||
129 | * Belorussian |
|
129 | * Belorussian | |
130 | * Chinese |
|
130 | * Chinese | |
131 | * French |
|
131 | * French | |
132 | * German |
|
132 | * German | |
133 | * Italian |
|
133 | * Italian | |
134 | * Japanese |
|
134 | * Japanese | |
135 | * Portuguese |
|
135 | * Portuguese | |
136 | * Polish |
|
136 | * Polish | |
137 | * Russian |
|
137 | * Russian | |
138 | * Spanish |
|
138 | * Spanish | |
139 |
|
139 | |||
140 | Licencing Information |
|
140 | Licencing Information | |
141 | --------------------- |
|
141 | --------------------- | |
142 |
|
142 | |||
143 | * See licencing information `here`_ |
|
143 | * See licencing information `here`_ | |
144 |
|
144 | |||
145 | Peer-to-peer Failover Support |
|
145 | Peer-to-peer Failover Support | |
146 | ----------------------------- |
|
146 | ----------------------------- | |
147 |
|
147 | |||
148 | * Yes |
|
148 | * Yes | |
149 |
|
149 | |||
150 | Additional Binaries |
|
|||
151 | ------------------- |
|
|||
152 |
|
||||
153 | * Yes, see :ref:`rhodecode-nix-ref` for full details. |
|
|||
154 |
|
150 | |||
155 | Remote Connectivity |
|
151 | Remote Connectivity | |
156 | ------------------- |
|
152 | ------------------- | |
157 |
|
153 | |||
158 | * Available |
|
154 | * Available | |
159 |
|
155 | |||
160 | Executable Files |
|
156 | Executable Files | |
161 | ---------------- |
|
157 | ---------------- | |
162 |
|
158 | |||
163 | Windows: :file:`RhodeCode-installer-{version}.exe` |
|
159 | Windows: :file:`RhodeCode-installer-{version}.exe` | |
164 |
|
160 | |||
165 | Deprecated Support |
|
161 | Deprecated Support | |
166 | ------------------ |
|
162 | ------------------ | |
167 |
|
163 | |||
168 | - Internet Explorer 8 support deprecated since version 3.7.0. |
|
164 | - Internet Explorer 8 support deprecated since version 3.7.0. | |
169 | - Internet Explorer 9 support deprecated since version 3.8.0. |
|
165 | - Internet Explorer 9 support deprecated since version 3.8.0. | |
170 |
|
166 | |||
171 | .. _here: https://rhodecode.com/licenses/ |
|
167 | .. _here: https://rhodecode.com/licenses/ | |
172 | .. _Transifex: https://explore.transifex.com/rhodecode/RhodeCode/ |
|
168 | .. _Transifex: https://explore.transifex.com/rhodecode/RhodeCode/ |
@@ -1,243 +1,13 b'' | |||||
1 | .. _dev-setup: |
|
1 | .. _dev-setup: | |
2 |
|
2 | |||
3 | =================== |
|
3 | =================== | |
4 | Development setup |
|
4 | Development setup | |
5 | =================== |
|
5 | =================== | |
6 |
|
6 | |||
7 |
|
7 | #TODO | ||
8 | RhodeCode Enterprise runs inside a Nix managed environment. This ensures build |
|
|||
9 | environment dependencies are correctly declared and installed during setup. |
|
|||
10 | It also enables atomic upgrades, rollbacks, and multiple instances of RhodeCode |
|
|||
11 | Enterprise running with isolation. |
|
|||
12 |
|
||||
13 | To set up RhodeCode Enterprise inside the Nix environment, use the following steps: |
|
|||
14 |
|
||||
15 |
|
||||
16 |
|
||||
17 | Setup Nix Package Manager |
|
|||
18 | ------------------------- |
|
|||
19 |
|
||||
20 | To install the Nix Package Manager, please run:: |
|
|||
21 |
|
||||
22 | $ curl https://releases.nixos.org/nix/nix-2.3.4/install | sh |
|
|||
23 |
|
||||
24 | or go to https://nixos.org/nix/ and follow the installation instructions. |
|
|||
25 | Once this is correctly set up on your system, you should be able to use the |
|
|||
26 | following commands: |
|
|||
27 |
|
||||
28 | * `nix-env` |
|
|||
29 |
|
||||
30 | * `nix-shell` |
|
|||
31 |
|
||||
32 |
|
||||
33 | .. tip:: |
|
|||
34 |
|
||||
35 | Update your channels frequently by running ``nix-channel --update``. |
|
|||
36 |
|
||||
37 | .. note:: |
|
|||
38 |
|
||||
39 | To uninstall nix run the following: |
|
|||
40 |
|
||||
41 | remove the . "$HOME/.nix-profile/etc/profile.d/nix.sh" line in your ~/.profile or ~/.bash_profile |
|
|||
42 | rm -rf $HOME/{.nix-channels,.nix-defexpr,.nix-profile,.config/nixpkgs} |
|
|||
43 | sudo rm -rf /nix |
|
|||
44 |
|
||||
45 | Switch nix to the latest STABLE channel |
|
|||
46 | --------------------------------------- |
|
|||
47 |
|
||||
48 | run:: |
|
|||
49 |
|
||||
50 | nix-channel --add https://nixos.org/channels/nixos-20.03 nixpkgs |
|
|||
51 |
|
||||
52 | Followed by:: |
|
|||
53 |
|
||||
54 | nix-channel --update |
|
|||
55 | nix-env -i nix-2.3.4 |
|
|||
56 |
|
||||
57 |
|
||||
58 | Install required binaries |
|
|||
59 | ------------------------- |
|
|||
60 |
|
||||
61 | We need some handy tools first. |
|
|||
62 |
|
||||
63 | run:: |
|
|||
64 |
|
||||
65 | nix-env -i nix-prefetch-hg |
|
|||
66 | nix-env -i nix-prefetch-git |
|
|||
67 |
|
||||
68 |
|
||||
69 | Speed up JS build by installing PhantomJS |
|
|||
70 | ----------------------------------------- |
|
|||
71 |
|
||||
72 | PhantomJS will be downloaded each time nix-shell is invoked. To speed this by |
|
|||
73 | setting already downloaded version do this:: |
|
|||
74 |
|
||||
75 | nix-env -i phantomjs-2.1.1 |
|
|||
76 |
|
||||
77 | # and set nix bin path |
|
|||
78 | export PATH=$PATH:~/.nix-profile/bin |
|
|||
79 |
|
||||
80 |
|
||||
81 | Clone the required repositories |
|
|||
82 | ------------------------------- |
|
|||
83 |
|
||||
84 | After Nix is set up, clone the RhodeCode Enterprise Community Edition and |
|
|||
85 | RhodeCode VCSServer repositories into the same directory. |
|
|||
86 | RhodeCode currently is using Mercurial Version Control System, please make sure |
|
|||
87 | you have it installed before continuing. |
|
|||
88 |
|
||||
89 | To obtain the required sources, use the following commands:: |
|
|||
90 |
|
||||
91 | mkdir rhodecode-develop && cd rhodecode-develop |
|
|||
92 | hg clone -u default https://code.rhodecode.com/rhodecode-enterprise-ce |
|
|||
93 | hg clone -u default https://code.rhodecode.com/rhodecode-vcsserver |
|
|||
94 |
|
||||
95 | .. note:: |
|
|||
96 |
|
||||
97 | If you cannot clone the repository, please contact us via support@rhodecode.com |
|
|||
98 |
|
||||
99 |
|
||||
100 | Install some required libraries |
|
|||
101 | ------------------------------- |
|
|||
102 |
|
||||
103 | There are some required drivers and dev libraries that we need to install to |
|
|||
104 | test RhodeCode under different types of databases. For example in Ubuntu we |
|
|||
105 | need to install the following. |
|
|||
106 |
|
||||
107 | required libraries:: |
|
|||
108 |
|
||||
109 | # svn related |
|
|||
110 | sudo apt-get install libapr1-dev libaprutil1-dev |
|
|||
111 | sudo apt-get install libsvn-dev |
|
|||
112 | # libcurl required too |
|
|||
113 | sudo apt-get install libcurl4-openssl-dev |
|
|||
114 | # mysql/pg server for development, optional |
|
|||
115 | sudo apt-get install mysql-server libmysqlclient-dev |
|
|||
116 | sudo apt-get install postgresql postgresql-contrib libpq-dev |
|
|||
117 |
|
||||
118 |
|
||||
119 |
|
||||
120 | Enter the Development Shell |
|
|||
121 | --------------------------- |
|
|||
122 |
|
||||
123 | The final step is to start the development shells. To do this, run the |
|
|||
124 | following command from inside the cloned repository:: |
|
|||
125 |
|
||||
126 | # first, the vcsserver |
|
|||
127 | cd ~/rhodecode-vcsserver |
|
|||
128 | nix-shell |
|
|||
129 |
|
||||
130 | # then enterprise sources |
|
|||
131 | cd ~/rhodecode-enterprise-ce |
|
|||
132 | nix-shell |
|
|||
133 |
|
||||
134 | .. note:: |
|
|||
135 |
|
||||
136 | On the first run, this will take a while to download and optionally compile |
|
|||
137 | a few things. The following runs will be faster. The development shell works |
|
|||
138 | fine on both MacOS and Linux platforms. |
|
|||
139 |
|
||||
140 |
|
||||
141 | Create config.nix for development |
|
|||
142 | --------------------------------- |
|
|||
143 |
|
||||
144 | In order to run proper tests and setup linking across projects, a config.nix |
|
|||
145 | file needs to be setup:: |
|
|||
146 |
|
||||
147 | # create config |
|
|||
148 | mkdir -p ~/.nixpkgs |
|
|||
149 | touch ~/.nixpkgs/config.nix |
|
|||
150 |
|
||||
151 | # put the below content into the ~/.nixpkgs/config.nix file |
|
|||
152 | # adjusts, the path to where you cloned your repositories. |
|
|||
153 |
|
||||
154 | { |
|
|||
155 | rc = { |
|
|||
156 | sources = { |
|
|||
157 | rhodecode-vcsserver = "/home/dev/rhodecode-vcsserver"; |
|
|||
158 | rhodecode-enterprise-ce = "/home/dev/rhodecode-enterprise-ce"; |
|
|||
159 | rhodecode-enterprise-ee = "/home/dev/rhodecode-enterprise-ee"; |
|
|||
160 | }; |
|
|||
161 | }; |
|
|||
162 | } |
|
|||
163 |
|
||||
164 |
|
||||
165 |
|
||||
166 | Creating a Development Configuration |
|
|||
167 | ------------------------------------ |
|
|||
168 |
|
||||
169 | To create a development environment for RhodeCode Enterprise, |
|
|||
170 | use the following steps: |
|
|||
171 |
|
||||
172 | 1. Create a copy of vcsserver config: |
|
|||
173 | `cp ~/rhodecode-vcsserver/configs/development.ini ~/rhodecode-vcsserver/configs/dev.ini` |
|
|||
174 | 2. Create a copy of rhodocode config: |
|
|||
175 | `cp ~/rhodecode-enterprise-ce/configs/development.ini ~/rhodecode-enterprise-ce/configs/dev.ini` |
|
|||
176 | 3. Adjust the configuration settings to your needs if needed. |
|
|||
177 |
|
||||
178 | .. note:: |
|
|||
179 |
|
||||
180 | It is recommended to use the name `dev.ini` since it's included in .hgignore file. |
|
|||
181 |
|
||||
182 |
|
||||
183 | Setup the Development Database |
|
|||
184 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
|
|||
185 |
|
||||
186 | To create a development database, use the following example. This is a one |
|
|||
187 | time operation executed from the nix-shell of rhodecode-enterprise-ce sources :: |
|
|||
188 |
|
||||
189 | rc-setup-app dev.ini \ |
|
|||
190 | --user=admin --password=secret \ |
|
|||
191 | --email=admin@example.com \ |
|
|||
192 | --repos=~/my_dev_repos |
|
|||
193 |
|
||||
194 |
|
||||
195 | Compile CSS and JavaScript |
|
|||
196 | ^^^^^^^^^^^^^^^^^^^^^^^^^^ |
|
|||
197 |
|
||||
198 | To use the application's frontend and prepare it for production deployment, |
|
|||
199 | you will need to compile the CSS and JavaScript with Grunt. |
|
|||
200 | This is easily done from within the nix-shell using the following command:: |
|
|||
201 |
|
||||
202 | make web-build |
|
|||
203 |
|
||||
204 | When developing new features you will need to recompile following any |
|
|||
205 | changes made to the CSS or JavaScript files when developing the code:: |
|
|||
206 |
|
||||
207 | grunt watch |
|
|||
208 |
|
||||
209 | This prepares the development (with comments/whitespace) versions of files. |
|
|||
210 |
|
||||
211 | Start the Development Servers |
|
|||
212 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
|
|||
213 |
|
||||
214 | From the rhodecode-vcsserver directory, start the development server in another |
|
|||
215 | nix-shell, using the following command:: |
|
|||
216 |
|
||||
217 | pserve configs/dev.ini |
|
|||
218 |
|
||||
219 | In the adjacent nix-shell which you created for your development server, you may |
|
|||
220 | now start CE with the following command:: |
|
|||
221 |
|
||||
222 |
|
||||
223 | pserve --reload configs/dev.ini |
|
|||
224 |
|
||||
225 | .. note:: |
|
|||
226 |
|
||||
227 | `--reload` flag will automatically reload the server when source file changes. |
|
|||
228 |
|
||||
229 |
|
||||
230 | Run the Environment Tests |
|
|||
231 | ^^^^^^^^^^^^^^^^^^^^^^^^^ |
|
|||
232 |
|
||||
233 | Please make sure that the tests are passing to verify that your environment is |
|
|||
234 | set up correctly. RhodeCode uses py.test to run tests. |
|
|||
235 | While your instance is running, start a new nix-shell and simply run |
|
|||
236 | ``make test`` to run the basic test suite. |
|
|||
237 |
|
||||
238 |
|
8 | |||
239 | Need Help? |
|
9 | Need Help? | |
240 | ^^^^^^^^^^ |
|
10 | ^^^^^^^^^^ | |
241 |
|
11 | |||
242 | Join us on Slack via https://rhodecode.com/join or post questions in our |
|
12 | Join us on Slack via https://rhodecode.com/join or post questions in our | |
243 | Community Portal at https://community.rhodecode.com |
|
13 | Community Portal at https://community.rhodecode.com |
@@ -1,93 +1,92 b'' | |||||
1 | |RCE| |
|
1 | |RCE| | |
2 | ===== |
|
2 | ===== | |
3 |
|
3 | |||
4 | |RCE| is a high-performance source code management and collaboration system. |
|
4 | |RCE| is a high-performance source code management and collaboration system. | |
5 | It enables you to develop projects securely behind the firewall while |
|
5 | It enables you to develop projects securely behind the firewall while | |
6 | providing collaboration tools that work with |git|, |hg|, |
|
6 | providing collaboration tools that work with |git|, |hg|, | |
7 | and |svn| |repos|. The user interface allows you to create, edit, |
|
7 | and |svn| |repos|. The user interface allows you to create, edit, | |
8 | and commit files and |repos| while managing their security permissions. |
|
8 | and commit files and |repos| while managing their security permissions. | |
9 |
|
9 | |||
10 | |RCE| provides the following features: |
|
10 | |RCE| provides the following features: | |
11 |
|
11 | |||
12 | * Source code management. |
|
12 | * Source code management. | |
13 | * Extended permissions management. |
|
13 | * Extended permissions management. | |
14 | * Integrated code collaboration tools. |
|
14 | * Integrated code collaboration tools. | |
15 | * Integrated code review and notifications. |
|
15 | * Integrated code review and notifications. | |
16 | * Scalability provided by multi-node setup. |
|
16 | * Scalability provided by multi-node setup. | |
17 | * Fully programmable automation API. |
|
17 | * Fully programmable automation API. | |
18 | * Web-based hook management. |
|
18 | * Web-based hook management. | |
19 | * Native |svn| support. |
|
19 | * Native |svn| support. | |
20 | * Migration from existing databases. |
|
20 | * Migration from existing databases. | |
21 | * |RCE| SDK. |
|
21 | * |RCE| SDK. | |
22 | * Built-in analytics |
|
22 | * Built-in analytics | |
23 | * Built in integrations including: Slack, Webhooks (used for Jenkins/TeamCity and other CIs), Jira, Redmine, Hipchat |
|
23 | * Built in integrations including: Slack, Webhooks (used for Jenkins/TeamCity and other CIs), Jira, Redmine, Hipchat | |
24 | * Pluggable authentication system. |
|
24 | * Pluggable authentication system. | |
25 | * Support for AD, |LDAP|, Crowd, CAS, PAM. |
|
25 | * Support for AD, |LDAP|, Crowd, CAS, PAM. | |
26 | * Support for external authentication via Oauth Google, Github, Bitbucket, Twitter. |
|
26 | * Support for external authentication via Oauth Google, Github, Bitbucket, Twitter. | |
27 | * Debug modes of operation. |
|
27 | * Debug modes of operation. | |
28 | * Private and public gists. |
|
28 | * Private and public gists. | |
29 | * Gists with limited lifetimes and within instance only sharing. |
|
29 | * Gists with limited lifetimes and within instance only sharing. | |
30 | * Fully integrated code search function. |
|
30 | * Fully integrated code search function. | |
31 | * Always on SSL connectivity. |
|
31 | * Always on SSL connectivity. | |
32 |
|
32 | |||
33 | .. only:: html |
|
33 | .. only:: html | |
34 |
|
34 | |||
35 | Table of Contents |
|
35 | Table of Contents | |
36 | ----------------- |
|
36 | ----------------- | |
37 |
|
37 | |||
38 | .. toctree:: |
|
38 | .. toctree:: | |
39 | :maxdepth: 1 |
|
39 | :maxdepth: 1 | |
40 | :caption: Admin Documentation |
|
40 | :caption: Admin Documentation | |
41 |
|
41 | |||
42 | install/quick-start |
|
42 | install/quick-start | |
43 | install/install-database |
|
43 | install/install-database | |
44 | install/install-steps |
|
44 | install/install-steps | |
45 | admin/system-overview |
|
45 | admin/system-overview | |
46 | nix/default-env |
|
|||
47 | admin/system-admin |
|
46 | admin/system-admin | |
48 | admin/user-admin |
|
47 | admin/user-admin | |
49 | admin/repo-admin |
|
48 | admin/repo-admin | |
50 | admin/security-tips |
|
49 | admin/security-tips | |
51 | auth/auth |
|
50 | auth/auth | |
52 | issue-trackers/issue-trackers |
|
51 | issue-trackers/issue-trackers | |
53 | admin/lab-settings |
|
52 | admin/lab-settings | |
54 |
|
53 | |||
55 | .. toctree:: |
|
54 | .. toctree:: | |
56 | :maxdepth: 1 |
|
55 | :maxdepth: 1 | |
57 | :caption: Feature Documentation |
|
56 | :caption: Feature Documentation | |
58 |
|
57 | |||
59 | collaboration/collaboration |
|
58 | collaboration/collaboration | |
60 | collaboration/review-notifications |
|
59 | collaboration/review-notifications | |
61 | collaboration/pull-requests |
|
60 | collaboration/pull-requests | |
62 | code-review/code-review |
|
61 | code-review/code-review | |
63 | integrations/integrations |
|
62 | integrations/integrations | |
64 |
|
63 | |||
65 | .. toctree:: |
|
64 | .. toctree:: | |
66 | :maxdepth: 1 |
|
65 | :maxdepth: 1 | |
67 | :caption: User Documentation |
|
66 | :caption: User Documentation | |
68 |
|
67 | |||
69 | usage/basic-usage |
|
68 | usage/basic-usage | |
70 | tutorials/tutorials |
|
69 | tutorials/tutorials | |
71 |
|
70 | |||
72 | .. toctree:: |
|
71 | .. toctree:: | |
73 | :maxdepth: 1 |
|
72 | :maxdepth: 1 | |
74 | :caption: Developer Documentation |
|
73 | :caption: Developer Documentation | |
75 |
|
74 | |||
76 | api/api |
|
75 | api/api | |
77 | tools/rhodecode-tools |
|
76 | tools/rhodecode-tools | |
78 | extensions/extensions-hooks |
|
77 | extensions/extensions-hooks | |
79 | contributing/contributing |
|
78 | contributing/contributing | |
80 |
|
79 | |||
81 | .. toctree:: |
|
80 | .. toctree:: | |
82 | :maxdepth: 2 |
|
81 | :maxdepth: 2 | |
83 |
:caption: RhodeCode |
|
82 | :caption: RhodeCode RCstack Documentation | |
84 |
|
83 | |||
85 |
RhodeCode Installer <https://docs.rhodecode.com/ |
|
84 | RhodeCode RCstack Installer <https://docs.rhodecode.com/rcstack/> | |
86 |
|
85 | |||
87 | .. toctree:: |
|
86 | .. toctree:: | |
88 | :maxdepth: 1 |
|
87 | :maxdepth: 1 | |
89 | :caption: About |
|
88 | :caption: About | |
90 |
|
89 | |||
91 | known-issues/known-issues |
|
90 | known-issues/known-issues | |
92 | release-notes/release-notes |
|
91 | release-notes/release-notes | |
93 | admin/glossary |
|
92 | admin/glossary |
@@ -1,121 +1,24 b'' | |||||
1 | .. _quick-start: |
|
1 | .. _quick-start: | |
2 |
|
2 | |||
3 | Quick Start Installation Guide |
|
3 | Quick Start Installation Guide | |
4 | ============================== |
|
4 | ============================== | |
5 |
|
5 | |||
6 | .. important:: |
|
6 | Since version 5.0.0 Rhodecode runs in Docker, and to get |RCE| up and running, | |
7 |
|
7 | you need to use RCstack installer - <https://docs.rhodecode.com/rcstack/install/installation.html/> | ||
8 | These are quick start instructions. To optimize your |RCE|, |
|
|||
9 | |RCC|, and |RCT| usage, read the more detailed instructions in our guides. |
|
|||
10 | For detailed installation instructions, see |
|
|||
11 | :ref:`RhodeCode Control Documentation <control:rcc>` |
|
|||
12 |
|
||||
13 | .. tip:: |
|
|||
14 |
|
||||
15 | If using a non-SQLite database, install and configure the database, create |
|
|||
16 | a new user, and grant permissions. You will be prompted for this user's |
|
|||
17 | credentials during |RCE| installation. See the relevant database |
|
|||
18 | documentation for more details. |
|
|||
19 |
|
||||
20 | To get |RCE| up and running, run through the below steps: |
|
|||
21 |
|
||||
22 | 1. Download the latest |RCC| installer from `rhodecode.com/download`_. |
|
|||
23 | If you don't have an account, sign up at `rhodecode.com/register`_. |
|
|||
24 |
|
||||
25 | 2. Run the |RCC| installer and accept the End User Licence using the |
|
|||
26 | following example: |
|
|||
27 |
|
||||
28 | .. code-block:: bash |
|
|||
29 |
|
||||
30 | $ chmod +x RhodeCode-installer-linux-* |
|
|||
31 | $ ./RhodeCode-installer-linux-* |
|
|||
32 |
|
||||
33 | Do you accept the RhodeCode Control license? |
|
|||
34 | Press [Y] to accept license and [V] to view license text: y |
|
|||
35 |
|
||||
36 |
|
||||
37 | .. important:: |
|
|||
38 |
|
||||
39 | We recommend running RhodeCode as a non-root user, such as `rhodecode`; |
|
|||
40 | this user must have a proper home directory. |
|
|||
41 | Either log in as that user to install the software, or do it as root |
|
|||
42 | with `sudo -i -u rhodecode ./RhodeCode-installer-linux-*` |
|
|||
43 |
|
||||
44 |
|
||||
45 | 3. Install a VCS Server, and configure it to start at boot. |
|
|||
46 |
|
||||
47 | .. code-block:: bash |
|
|||
48 |
|
||||
49 | $ rccontrol install VCSServer |
|
|||
50 |
|
8 | |||
51 | Agree to the licence agreement? [y/N]: y |
|
9 | Please refer to RCstack documentation for | |
52 | IP to start the server on [127.0.0.1]: |
|
|||
53 | Port for the server to start [10005]: |
|
|||
54 | Creating new instance: vcsserver-1 |
|
|||
55 | Installing RhodeCode VCSServer |
|
|||
56 | Configuring RhodeCode VCS Server ... |
|
|||
57 | Supervisord state is: RUNNING |
|
|||
58 | Added process group vcsserver-1 |
|
|||
59 |
|
||||
60 |
|
||||
61 | 4. Install |RCEE| or |RCCE|. If using MySQL or PostgreSQL, during |
|
|||
62 | installation you'll be asked for your database credentials, so have them at hand. |
|
|||
63 | Mysql or Postgres needs to be running and a new database needs to be created. |
|
|||
64 | You don't need any credentials or to create a database for SQLite. |
|
|||
65 |
|
||||
66 | .. code-block:: bash |
|
|||
67 | :emphasize-lines: 11-16 |
|
|||
68 |
|
||||
69 | $ rccontrol install Community |
|
|||
70 |
|
||||
71 | or |
|
|||
72 |
|
||||
73 | $ rccontrol install Enterprise |
|
|||
74 |
|
10 | |||
75 | Username [admin]: username |
|
|||
76 | Password (min 6 chars): |
|
|||
77 | Repeat for confirmation: |
|
|||
78 | Email: your@mail.com |
|
|||
79 | Respositories location [/home/brian/repos]: |
|
|||
80 | IP to start the Enterprise server on [127.0.0.1]: |
|
|||
81 | Port for the Enterprise server to use [10004]: |
|
|||
82 | Database type - [s]qlite, [m]ysql, [p]ostresql: |
|
|||
83 | PostgreSQL selected |
|
|||
84 | Database host [127.0.0.1]: |
|
|||
85 | Database port [5432]: |
|
|||
86 | Database username: db-user-name |
|
|||
87 | Database password: somepassword |
|
|||
88 | Database name: example-db-name |
|
|||
89 |
|
||||
90 | 5. Check the status of your installation. You |RCEE|/|RCCE| instance runs |
|
|||
91 | on the URL displayed in the status message. |
|
|||
92 |
|
||||
93 | .. code-block:: bash |
|
|||
94 |
|
||||
95 | $ rccontrol status |
|
|||
96 |
|
||||
97 | - NAME: enterprise-1 |
|
|||
98 | - STATUS: RUNNING |
|
|||
99 | - TYPE: Enterprise |
|
|||
100 | - VERSION: 4.1.0 |
|
|||
101 | - URL: http://127.0.0.1:10003 |
|
|||
102 |
|
||||
103 | - NAME: vcsserver-1 |
|
|||
104 | - STATUS: RUNNING |
|
|||
105 | - TYPE: VCSServer |
|
|||
106 | - VERSION: 4.1.0 |
|
|||
107 | - URL: http://127.0.0.1:10001 |
|
|||
108 |
|
11 | |||
109 | .. note:: |
|
12 | .. note:: | |
110 |
|
13 | |||
111 | Recommended post quick start install instructions: |
|
14 | Recommended post quick start install instructions: | |
112 |
|
15 | |||
113 | * Read the documentation |
|
16 | * Read the documentation | |
114 | * Carry out the :ref:`rhodecode-post-instal-ref` |
|
17 | * Carry out the :ref:`rhodecode-post-instal-ref` | |
115 | * Set up :ref:`indexing-ref` |
|
18 | * Set up :ref:`indexing-ref` | |
116 | * Familiarise yourself with the :ref:`rhodecode-admin-ref` section. |
|
19 | * Familiarise yourself with the :ref:`rhodecode-admin-ref` section. | |
117 |
|
20 | |||
118 | .. _rhodecode.com: https://rhodecode.com/ |
|
21 | .. _rhodecode.com: https://rhodecode.com/ | |
119 | .. _rhodecode.com/register: https://rhodecode.com/register/ |
|
22 | .. _rhodecode.com/register: https://rhodecode.com/register/ | |
120 | .. _rhodecode.com/download: https://rhodecode.com/download/ |
|
23 | .. _rhodecode.com/download: https://rhodecode.com/download/ | |
121 |
|
24 |
General Comments 0
You need to be logged in to leave comments.
Login now