##// END OF EJS Templates
docs: updated docs build for 5.0.X
super-admin -
r5344:206a16d7 stable
parent child Browse files
Show More
@@ -65,7 +65,7 b' ruff-check:'
65 65 .PHONY: docs
66 66 ## build docs
67 67 docs:
68 (cd docs; docker run --rm -v $(PWD):/project --workdir=/project/docs sphinx-doc-build-rc make clean html)
68 (cd docs; docker run --rm -v $(PWD):/project --workdir=/project/docs sphinx-doc-build-rc make clean html SPHINXOPTS="-W")
69 69
70 70
71 71 .PHONY: docs-clean
@@ -18,7 +18,7 b' To do this, use the following steps:'
18 18
19 19 1. Open the :file:`home/{user}/.rccontrol/{instance-id}/rhodecode.ini` file.
20 20 2. In the ``[server:main]`` section, change the number of Gunicorn
21 ``workers`` using the following default formula :math:`(2 * Cores) + 1`.
21 ``workers`` using the following default formula `(2 * Cores) + 1`.
22 22 We however not recommend using more than 8-12 workers per server. It's better
23 23 to start using the :ref:`scale-horizontal-cluster` in case that performance
24 24 with 8-12 workers is not enough.
@@ -55,7 +55,7 b' 4. Change the VCSServer workers too. Ope'
55 55 :file:`home/{user}/.rccontrol/{instance-id}/vcsserver.ini` file.
56 56
57 57 5. In the ``[server:main]`` section, increase the number of Gunicorn
58 ``workers`` using the following formula :math:`(2 * Cores) + 1`.
58 ``workers`` using the following formula `(2 * Cores) + 1`.
59 59
60 60 .. code-block:: ini
61 61
@@ -103,6 +103,7 b' rst_epilog = """'
103 103 .. |repo| replace:: repository
104 104 .. |repos| replace:: repositories
105 105 .. |RCC| replace:: RhodeCode Control
106 .. |RCS| replace:: RhodeCode rcstack
106 107 .. |RCE| replace:: RhodeCode Enterprise
107 108 .. |RCCE| replace:: RhodeCode Community
108 109 .. |RCEE| replace:: RhodeCode Enterprise
@@ -199,7 +200,7 b' html_favicon = "images/favicon.ico"'
199 200 # Add any paths that contain custom static files (such as style sheets) here,
200 201 # relative to this directory. They are copied after the builtin static files,
201 202 # so a file named "default.css" will overwrite the builtin "default.css".
202 html_static_path = ["static/css/add.css"]
203 html_static_path = ['_static']
203 204
204 205 # Add any extra paths that contain custom files (such as robots.txt or
205 206 # .htaccess) here, relative to this directory. These files are copied
@@ -43,7 +43,6 b' and commit files and |repos| while manag'
43 43 install/install-database
44 44 install/install-steps
45 45 admin/system-overview
46 nix/default-env
47 46 admin/system-admin
48 47 admin/user-admin
49 48 admin/repo-admin
@@ -80,14 +79,14 b' and commit files and |repos| while manag'
80 79
81 80 .. toctree::
82 81 :maxdepth: 2
83 :caption: RhodeCode Control Documentation
82 :caption: RhodeCode rcstack Documentation
84 83
85 RhodeCode Installer <https://docs.rhodecode.com/RhodeCode-Control/>
84 RhodeCode Installer <https://docs.rhodecode.com/rcstack/>
86 85
87 86 .. toctree::
88 87 :maxdepth: 1
89 88 :caption: About
90 89
90 release-notes/release-notes
91 91 known-issues/known-issues
92 release-notes/release-notes
93 92 admin/glossary
@@ -1,4 +1,4 b''
1 .. _rhodecode-post-instal-ref:
1 .. _rhodecode-post-install-ref:
2 2
3 3 Post Installation Tasks
4 4 =======================
@@ -9,6 +9,5 b' the information in these sections to con'
9 9 .. toctree::
10 10
11 11 setup-email
12 database-string
13 12 configure-celery
14 13 migrate-repos
@@ -8,110 +8,80 b' Quick Start Installation Guide'
8 8 These are quick start instructions. To optimize your |RCE|,
9 9 |RCC|, and |RCT| usage, read the more detailed instructions in our guides.
10 10 For detailed installation instructions, see
11 :ref:`RhodeCode Control Documentation <control:rcc>`
12
13 .. tip::
11 :ref:`RhodeCode rcstack Documentation <rcstack:installation>`
14 12
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.
13
19 14
20 15 To get |RCE| up and running, run through the below steps:
21 16
22 1. Download the latest |RCC| installer from `rhodecode.com/download`_.
17 1. Register to get the latest |RCC| installer instruction from `rhodecode.com/download`_.
23 18 If you don't have an account, sign up at `rhodecode.com/register`_.
24 19
25 2. Run the |RCC| installer and accept the End User Licence using the
20 2. Run the |RCS| installer and start init process.
26 21 following example:
27 22
28 23 .. code-block:: bash
29 24
30 $ chmod +x RhodeCode-installer-linux-*
31 $ ./RhodeCode-installer-linux-*
25 mkdir docker-rhodecode && cd docker-rhodecode
26 curl -L -s -o rcstack https://dls.rhodecode.com/get-rcstack && chmod +x rcstack
32 27
33 Do you accept the RhodeCode Control license?
34 Press [Y] to accept license and [V] to view license text: y
28 ./rcstack init
35 29
36 30
37 31 .. important::
38 32
39 33 We recommend running RhodeCode as a non-root user, such as `rhodecode`;
40 this user must have a proper home directory.
34 this user must have a proper home directory and sudo permissions (to start Docker)
41 35 Either log in as that user to install the software, or do it as root
42 with `sudo -i -u rhodecode ./RhodeCode-installer-linux-*`
36 with `sudo -i -u rhodecode ./rcstack init`
43 37
44 38
45 3. Install a VCS Server, and configure it to start at boot.
39 3. Follow instructions on |RCS| documentation pages
40
41 :ref:`Quick install tutorial <rcstack:quick_installation>`
42
43 4. Check stack status
44
45 .. code-block:: bash
46
47 ./rcstack status
48
49
50 Output should look similar to this:
46 51
47 52 .. code-block:: bash
48 53
49 $ rccontrol install VCSServer
50
51 Agree to the licence agreement? [y/N]: y
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
54 ---
55 CONTAINER ID IMAGE STATUS NAMES PORTS
56 ef54fc528e3a traefik:v2.9.5 Up 2 hours rc_cluster_router-traefik-1 0.0.0.0:80->80/tcp, :::80->80/tcp
57 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
58 2be52ba58ffe rhodecode/rhodecode-ee:4.28.0 Up 2 hours (healthy) rc_cluster_apps-vcsserver-1
59 7cd730ad3263 rhodecode/rhodecode-ee:4.28.0 Up 2 hours (healthy) rc_cluster_apps-celery-1
60 dfa231342c87 rhodecode/rhodecode-ee:4.28.0 Up 2 hours (healthy) rc_cluster_apps-celery-beat-1
61 d3d76ce2de96 rhodecode/rhodecode-ee:4.28.0 Up 2 hours (healthy) rc_cluster_apps-sshd-1
62 daaac329414b rhodecode/rhodecode-ee:4.28.0 Up 2 hours (healthy) rc_cluster_apps-svn-1
63 7b8504fb9acb nginx:1.23.2 Up 2 hours (healthy) rc_cluster_services-nginx-1 80/tcp
64 7279c25feb6b elasticsearch:6.8.23 Up 2 hours (healthy) rc_cluster_services-elasticsearch-1 9200/tcp, 9300/tcp
65 19fb93587493 redis:7.0.5 Up 2 hours (healthy) rc_cluster_services-redis-1 6379/tcp
66 fb77fb6496c6 channelstream/channelstream:0.7.1 Up 2 hours (healthy) rc_cluster_services-channelstream-1 8000/tcp
67 cb6c5c022f5b postgres:14.6 Up 2 hours (healthy) rc_cluster_services-database-1 5432/tcp
74 68
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
69 At this point you should be able to access:
89 70
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
71 - RhodeCode instance at your domain entered, e.g http://rhodecode.local, the default access
72 credentials are generated and stored inside .runtime.env.
73 For example::
96 74
97 - NAME: enterprise-1
98 - STATUS: RUNNING
99 - TYPE: Enterprise
100 - VERSION: 4.1.0
101 - URL: http://127.0.0.1:10003
75 RHODECODE_USER_NAME=admin
76 RHODECODE_USER_PASS=super-secret-password
102 77
103 - NAME: vcsserver-1
104 - STATUS: RUNNING
105 - TYPE: VCSServer
106 - VERSION: 4.1.0
107 - URL: http://127.0.0.1:10001
108 78
109 79 .. note::
110 80
111 81 Recommended post quick start install instructions:
112 82
113 83 * Read the documentation
114 * Carry out the :ref:`rhodecode-post-instal-ref`
84 * Carry out the :ref:`rhodecode-post-install-ref`
115 85 * Set up :ref:`indexing-ref`
116 86 * Familiarise yourself with the :ref:`rhodecode-admin-ref` section.
117 87
1 NO CONTENT: file was removed
1 NO CONTENT: file was removed
1 NO CONTENT: file was removed
1 NO CONTENT: file was removed
General Comments 0
You need to be logged in to leave comments. Login now