##// END OF EJS Templates
readme: fixed rendering
super-admin -
Show More
@@ -40,11 +40,11 b' Metrics'
40
40
41 To get started with RhodeCode get the new shell installer called rccontrol
41 To get started with RhodeCode get the new shell installer called rccontrol
42
42
43 ```shell
43 ```
44 mkdir docker-rhodecode && cd docker-rhodecode
44 mkdir docker-rhodecode && cd docker-rhodecode
45 curl -o rccontrol https://code.rhodecode.com/rhodecode-enterprise-docker/raw/master/scripts/rccontrol/rccontrol && chmod +x rccontrol
45 curl -o rccontrol https://code.rhodecode.com/rhodecode-enterprise-docker/raw/master/scripts/rccontrol/rccontrol && chmod +x rccontrol
46 ./rccontrol get-started
46 ./rccontrol get-started
47 ```
47 ```
48
48
49 ## Pre requisites
49 ## Pre requisites
50
50
@@ -89,24 +89,24 b' Those are step-by-step installation/run steps.'
89
89
90 Check stack status
90 Check stack status
91
91
92 ./rccontrol status --simple
92 ./rccontrol status
93
93
94 Output should look similar like this:
94 Output should look similar like this:
95
95
96 ---
96 ---
97 CONTAINER ID IMAGE STATUS NAMES PORTS
97 CONTAINER ID IMAGE STATUS NAMES PORTS
98 ef54fc528e3a traefik:v2.9.5 Up 19 hours rc_cluster_router-traefik-1 0.0.0.0:80->80/tcp, :::80->80/tcp, 0.0.0.0:443->443/tcp, :::443->443/tcp, 0.0.0.0:9022->9022/tcp, :::9022->9022/tcp
98 ef54fc528e3a traefik:v2.9.5 Up 2 hours rc_cluster_router-traefik-1 0.0.0.0:80->80/tcp, :::80->80/tcp
99 f3ea0539e8b0 rhodecode/rhodecode-ee:4.28.0 Up About a minute (healthy) rc_cluster_apps-rhodecode-1 0.0.0.0:10020->10020/tcp, :::10020->10020/tcp
99 f3ea0539e8b0 rhodecode/rhodecode-ee:4.28.0 Up 2 hours (healthy) rc_cluster_apps-rhodecode-1 0.0.0.0:10020->10020/tcp, :::10020->10020/tcp
100 2be52ba58ffe rhodecode/rhodecode-ee:4.28.0 Up About a minute (healthy) rc_cluster_apps-vcsserver-1
100 2be52ba58ffe rhodecode/rhodecode-ee:4.28.0 Up 2 hours (healthy) rc_cluster_apps-vcsserver-1
101 7cd730ad3263 rhodecode/rhodecode-ee:4.28.0 Up About a minute rc_cluster_apps-celery-1
101 7cd730ad3263 rhodecode/rhodecode-ee:4.28.0 Up 2 hours (healthy) rc_cluster_apps-celery-1
102 dfa231342c87 rhodecode/rhodecode-ee:4.28.0 Up About a minute rc_cluster_apps-celery-beat-1
102 dfa231342c87 rhodecode/rhodecode-ee:4.28.0 Up 2 hours (healthy) rc_cluster_apps-celery-beat-1
103 d3d76ce2de96 rhodecode/rhodecode-ee:4.28.0 Up About a minute rc_cluster_apps-sshd-1
103 d3d76ce2de96 rhodecode/rhodecode-ee:4.28.0 Up 2 hours (healthy) rc_cluster_apps-sshd-1
104 daaac329414b rhodecode/rhodecode-ee:4.28.0 Up About a minute (healthy) rc_cluster_apps-svn-1
104 daaac329414b rhodecode/rhodecode-ee:4.28.0 Up 2 hours (healthy) rc_cluster_apps-svn-1
105 7b8504fb9acb nginx:1.23.2 Up About a minute (healthy) rc_cluster_services-nginx-1 80/tcp
105 7b8504fb9acb nginx:1.23.2 Up 2 hours (healthy) rc_cluster_services-nginx-1 80/tcp
106 7279c25feb6b elasticsearch:6.8.23 Up About a minute (healthy) rc_cluster_services-elasticsearch-1 9200/tcp, 9300/tcp
106 7279c25feb6b elasticsearch:6.8.23 Up 2 hours (healthy) rc_cluster_services-elasticsearch-1 9200/tcp, 9300/tcp
107 19fb93587493 redis:7.0.5 Up About a minute (healthy) rc_cluster_services-redis-1 6379/tcp
107 19fb93587493 redis:7.0.5 Up 2 hours (healthy) rc_cluster_services-redis-1 6379/tcp
108 fb77fb6496c6 channelstream/channelstream:0.7.1 Up About a minute (healthy) rc_cluster_services-channelstream-1 8000/tcp
108 fb77fb6496c6 channelstream/channelstream:0.7.1 Up 2 hours (healthy) rc_cluster_services-channelstream-1 8000/tcp
109 cb6c5c022f5b postgres:14.6 Up About a minute (healthy) rc_cluster_services-database-1 5432/tcp
109 cb6c5c022f5b postgres:14.6 Up 2 hours (healthy) rc_cluster_services-database-1 5432/tcp
110
110
111 # Standalone cluster build from installer
111 # Standalone cluster build from installer
112
112
@@ -124,14 +124,14 b' Follow these steps to build and run the RhodeCode Cluster via Docker-compose.'
124 Please use the `--version-name VERSION_NAME` flag to adjust RhodeCode version if needed.
124 Please use the `--version-name VERSION_NAME` flag to adjust RhodeCode version if needed.
125 (e.g. --version-name "4.24.1")
125 (e.g. --version-name "4.24.1")
126
126
127 ```shell
127 ```
128 ./rccontrol get-build-artifacts
128 ./rccontrol get-build-artifacts
129 ```
129 ```
130
130
131 This will download required installer files and put them into the `.cache` directory.
131 This will download required installer files and put them into the `.cache` directory.
132 This directory should look similar to that after downloads have finish:
132 This directory should look similar to that after downloads have finish:
133
133
134 ```shell
134 ```
135 drwxr-xr-x 8 rcdev rcdev 256B Feb 8 13:35 .
135 drwxr-xr-x 8 rcdev rcdev 256B Feb 8 13:35 .
136 drwxr-xr-x 14 rcdev rcdev 448B Feb 8 10:40 ..
136 drwxr-xr-x 14 rcdev rcdev 448B Feb 8 10:40 ..
137 -rw-r--r-- 1 rcdev rcdev 0B Feb 8 20:44 .dirkeep
137 -rw-r--r-- 1 rcdev rcdev 0B Feb 8 20:44 .dirkeep
@@ -162,14 +162,14 b' Follow these steps to build and run the RhodeCode Cluster via Docker-compose.'
162 Start by fetching required installer binaries.
162 Start by fetching required installer binaries.
163 Only local-archive is required to be present, installer is disregarded for source build
163 Only local-archive is required to be present, installer is disregarded for source build
164
164
165 ```shell
165 ```
166 ./rccontrol get-build-artifacts
166 ./rccontrol get-build-artifacts
167 ```
167 ```
168
168
169 This will download required installer files and put them into the `.cache` directory.
169 This will download required installer files and put them into the `.cache` directory.
170 This directory should look similar to that after downloads have finish:
170 This directory should look similar to that after downloads have finish:
171
171
172 ```shell
172 ```
173 drwxr-xr-x 8 rcdev rcdev 256B Feb 8 13:35 .
173 drwxr-xr-x 8 rcdev rcdev 256B Feb 8 13:35 .
174 drwxr-xr-x 14 rcdev rcdev 448B Feb 8 10:40 ..
174 drwxr-xr-x 14 rcdev rcdev 448B Feb 8 10:40 ..
175 -rw-r--r-- 1 rcdev rcdev 0B Feb 8 20:44 .dirkeep
175 -rw-r--r-- 1 rcdev rcdev 0B Feb 8 20:44 .dirkeep
@@ -183,7 +183,8 b' Follow these steps to build and run the RhodeCode Cluster via Docker-compose.'
183 3) get source code needed to create a build
183 3) get source code needed to create a build
184
184
185 This step will create source code copies into the `.source/` path. So it will look like this:
185 This step will create source code copies into the `.source/` path. So it will look like this:
186 ```shell
186
187 ```
187 -rw-r--r-- 1 docker docker 0 Nov 25 12:27 .dirkeep
188 -rw-r--r-- 1 docker docker 0 Nov 25 12:27 .dirkeep
188 drwxr-xr-x 1 docker docker 1184 Nov 25 12:27 rhodecode-enterprise-ce
189 drwxr-xr-x 1 docker docker 1184 Nov 25 12:27 rhodecode-enterprise-ce
189 drwxr-xr-x 1 docker docker 1120 Nov 25 12:27 rhodecode-enterprise-ee
190 drwxr-xr-x 1 docker docker 1120 Nov 25 12:27 rhodecode-enterprise-ee
@@ -199,14 +200,14 b' Follow these steps to build and run the RhodeCode Cluster via Docker-compose.'
199
200
200 Run this to fetch the sources
201 Run this to fetch the sources
201
202
202 ```shell
203 ```
203 ./rccontrol get-build-source --revision=default --auth-token=xxxx --server-url=https://code.rhodecode.com/sources
204 ./rccontrol get-build-source --revision=default --auth-token=xxxx --server-url=https://code.rhodecode.com/sources
204 ```
205 ```
205
206
206
207
207 4) Create the build
208 4) Create the build
208
209
209 ```shell
210 ```
210 ./rccontrol build-source --version-name 4.28.0.REL.2022.12.12
211 ./rccontrol build-source --version-name 4.28.0.REL.2022.12.12
211 ```
212 ```
212
213
@@ -254,7 +255,7 b' build the docker image.'
254
255
255 _Disk space problems?_
256 _Disk space problems?_
256
257
257 ```shell
258 ```
258 docker system df
259 docker system df
259 docker builder prune -f
260 docker builder prune -f
260 # optionally
261 # optionally
@@ -265,7 +266,7 b' docker image prune -a'
265
266
266 1) start with running the required database for the build stage in the background.
267 1) start with running the required database for the build stage in the background.
267
268
268 ```shell
269 ```
269 docker-compose up --detach database
270 docker-compose up --detach database
270 ```
271 ```
271
272
@@ -276,14 +277,14 b' docker image prune -a'
276 This will build the rhodecode base image used for rhodecode, vcsserver, celery, ssh, svn
277 This will build the rhodecode base image used for rhodecode, vcsserver, celery, ssh, svn
277 Then it will build all other components required.
278 Then it will build all other components required.
278
279
279 ```shell
280 ```
280 docker-compose build rhodecode
281 docker-compose build rhodecode
281 docker-compose build
282 docker-compose build
282 ```
283 ```
283
284
284 4) Once we build all required containers, we can run the whole stack using `docker-compose up`
285 4) Once we build all required containers, we can run the whole stack using `docker-compose up`
285
286
286 ```shell
287 ```
287 docker-compose up
288 docker-compose up
288 ```
289 ```
289
290
@@ -295,7 +296,7 b' localhost can be changed to the server IP where docker is running.'
295
296
296 In case for bigger setups docker-compose can scale more rhodecode/vcsserver workers:
297 In case for bigger setups docker-compose can scale more rhodecode/vcsserver workers:
297
298
298 ```shell
299 ```
299 docker-compose up --scale vcsserver=3 rhodecode=3
300 docker-compose up --scale vcsserver=3 rhodecode=3
300 ```
301 ```
301
302
@@ -313,7 +314,7 b' just `docker-compose` command it needs to be replaced with `docker-compose -f do'
313
314
314 For example to override the installer build with the source `rhodecode` based image, and also setting proper version, run:
315 For example to override the installer build with the source `rhodecode` based image, and also setting proper version, run:
315
316
316 ```shell
317 ```
317 RC_VERSION="4.28.0.SRC.2022.12.12.1" docker-compose -f docker-compose-apps.yaml -f docker-compose.source.yaml build --no-cache --progress=plain rhodecode
318 RC_VERSION="4.28.0.SRC.2022.12.12.1" docker-compose -f docker-compose-apps.yaml -f docker-compose.source.yaml build --no-cache --progress=plain rhodecode
318 ```
319 ```
319
320
@@ -325,7 +326,7 b' Build docker RhodeCode `Community` without any dependencies (redis, external db)'
325 simple sqlite database and file based caches.
326 simple sqlite database and file based caches.
326 This is a fully running instance good for small use with 3-5 users.
327 This is a fully running instance good for small use with 3-5 users.
327
328
328 ```shell
329 ```
329 docker build -t rhodecode/rhodecode-ce:4.23.2 -f rhodecode.dockerfile \
330 docker build -t rhodecode/rhodecode-ce:4.23.2 -f rhodecode.dockerfile \
330 -e RHODECODE_TYPE=Community \
331 -e RHODECODE_TYPE=Community \
331 -e RHODECODE_VERSION=4.23.2 \
332 -e RHODECODE_VERSION=4.23.2 \
@@ -344,7 +345,7 b' To Build against existing running Postgres or MySQL you can specify:'
344
345
345
346
346 To copy over the data into volumes use such command:
347 To copy over the data into volumes use such command:
347 ```shell
348 ```
348 docker run -v logvolume:/data --name data_vol busybox true
349 docker run -v logvolume:/data --name data_vol busybox true
349 docker cp . data_vol:/data
350 docker cp . data_vol:/data
350 docker rm data_vol
351 docker rm data_vol
@@ -361,7 +362,7 b' password: secret4'
361 We've not built our image using specific version. It's time to run it:
362 We've not built our image using specific version. It's time to run it:
362 We specify the run.ini by selecting config option we have locally
363 We specify the run.ini by selecting config option we have locally
363
364
364 ```shell
365 ```
365 docker run \
366 docker run \
366 --name rhodecode-container \
367 --name rhodecode-container \
367 --publish 10020:10020 \
368 --publish 10020:10020 \
@@ -374,18 +375,18 b' docker run \\'
374
375
375 Enter container
376 Enter container
376
377
377 ```shell
378 ```
378 docker exec -it rhodecode-container /bin/bash
379 docker exec -it rhodecode-container /bin/bash
379 ```
380 ```
380
381
381 Enter interactive shell
382 Enter interactive shell
382
383
383 ```shell
384 ```
384 docker exec -it rhodecode-container /usr/local/bin/rhodecode_bin/bin/rc-ishell /etc/rhodecode/conf/rhodecode.ini
385 docker exec -it rhodecode-container /usr/local/bin/rhodecode_bin/bin/rc-ishell /etc/rhodecode/conf/rhodecode.ini
385 ```
386 ```
386
387
387 Run Database migrations
388 Run Database migrations
388 ```shell
389 ```
389 docker exec -it rhodecode-container /usr/local/bin/rhodecode_bin/bin/rc-upgrade-db /etc/rhodecode/conf/rhodecode.ini --force-yes
390 docker exec -it rhodecode-container /usr/local/bin/rhodecode_bin/bin/rc-upgrade-db /etc/rhodecode/conf/rhodecode.ini --force-yes
390 ```
391 ```
391
392
General Comments 0
You need to be logged in to leave comments. Login now