docs: updated docs build for 5.0.X

Makefile

@@ -1,192 +1,192 b''
 # required for pushd to work..
 SHELL = /bin/bash
 
 
 # set by: PATH_TO_OUTDATED_PACKAGES=/some/path/outdated_packages.py
 OUTDATED_PACKAGES = ${PATH_TO_OUTDATED_PACKAGES}
 
 .PHONY: clean
 ## Cleanup compiled and cache py files
 clean:
 	make test-clean
 	find . -type f \( -iname '*.c' -o -iname '*.pyc' -o -iname '*.so' -o -iname '*.orig' \) -exec rm '{}' ';'
 	find . -type d -name "build" -prune -exec rm -rf '{}' ';'
 
 
 .PHONY: test
 ## run test-clean and tests
 test:
 	make test-clean
 	make test-only
 
 
 .PHONY: test-clean
 ## run test-clean and tests
 test-clean:
 	rm -rf coverage.xml htmlcov junit.xml pylint.log result
 	find . -type d -name "__pycache__" -prune -exec rm -rf '{}' ';'
 	find . -type f \( -iname '.coverage.*' \) -exec rm '{}' ';'
 
 
 .PHONY: test-only
 ## Run tests only without cleanup
 test-only:
 	PYTHONHASHSEED=random \
 	py.test -x -vv -r xw -p no:sugar \
 	--cov-report=term-missing --cov-report=html \
 	--cov=rhodecode rhodecode
 
 
 .PHONY: test-only-mysql
 ## run tests against mysql
 test-only-mysql:
 	PYTHONHASHSEED=random \
 	py.test -x -vv -r xw -p no:sugar \
 	--cov-report=term-missing --cov-report=html \
     --ini-config-override='{"app:main": {"sqlalchemy.db1.url": "mysql://root:qweqwe@localhost/rhodecode_test?charset=utf8"}}' \
     --cov=rhodecode rhodecode
 
 
 .PHONY: test-only-postgres
 ## run tests against postgres
 test-only-postgres:
 	PYTHONHASHSEED=random \
 	py.test -x -vv -r xw -p no:sugar \
 	--cov-report=term-missing --cov-report=html \
     --ini-config-override='{"app:main": {"sqlalchemy.db1.url": "postgresql://postgres:qweqwe@localhost/rhodecode_test"}}' \
     --cov=rhodecode rhodecode
 
 .PHONY: ruff-check
 ## run a ruff analysis
 ruff-check:
 	ruff check --ignore F401 --ignore I001 --ignore E402 --ignore E501 --ignore F841 --exclude rhodecode/lib/dbmigrate --exclude .eggs  --exclude .dev .
 
 
 .PHONY: docs
 ## build docs
 docs:
-	(cd docs; docker run --rm -v $(PWD):/project --workdir=/project/docs sphinx-doc-build-rc make clean html)
+	(cd docs; docker run --rm -v $(PWD):/project --workdir=/project/docs sphinx-doc-build-rc make clean html SPHINXOPTS="-W")
 
 
 .PHONY: docs-clean
 ## Cleanup docs
 docs-clean:
 	(cd docs; docker run --rm -v $(PWD):/project --workdir=/project/docs sphinx-doc-build-rc make clean)
 
 
 .PHONY: docs-cleanup
 ## Cleanup docs
 docs-cleanup:
 	(cd docs; docker run --rm -v $(PWD):/project --workdir=/project/docs sphinx-doc-build-rc make cleanup)
 
 
 .PHONY: web-build
 ## Build JS packages static/js
 web-build:
 	docker run -it --rm -v $(PWD):/project --workdir=/project rhodecode/static-files-build:16 -c "npm install && /project/node_modules/.bin/grunt"
 	# run static file check
 	./rhodecode/tests/scripts/static-file-check.sh rhodecode/public/
 	rm -rf node_modules
 
 
 .PHONY: pip-packages
 ## Show outdated packages
 pip-packages:
 	python ${OUTDATED_PACKAGES}
 
 
 .PHONY: build
 ## Build sdist/egg
 build:
 	python -m build
 
 
 .PHONY: dev-sh
 ## make dev-sh
 dev-sh:
 	sudo echo "deb [trusted=yes] https://apt.fury.io/rsteube/ /" | sudo tee -a "/etc/apt/sources.list.d/fury.list"
 	sudo apt-get update
 	sudo apt-get install -y zsh carapace-bin
 	rm -rf /home/rhodecode/.oh-my-zsh
 	curl https://raw.githubusercontent.com/robbyrussell/oh-my-zsh/master/tools/install.sh | sh
 	echo "source <(carapace _carapace)" > /home/rhodecode/.zsrc
 	PROMPT='%(?.%F{green}√.%F{red}?%?)%f %B%F{240}%1~%f%b %# ' zsh
 
 
 .PHONY: dev-cleanup
 ## Cleanup: pip freeze | grep -v "^-e" | grep -v "@" | xargs pip uninstall -y
 dev-cleanup:
 	pip freeze | grep -v "^-e" | grep -v "@" | xargs pip uninstall -y
 	rm -rf /tmp/*
 
 
 .PHONY: dev-env
 ## make dev-env based on the requirements files and install develop of packages
 dev-env:
 	pip install build virtualenv
 	pushd ../rhodecode-vcsserver/ && make dev-env && popd
 	pip wheel --wheel-dir=/home/rhodecode/.cache/pip/wheels -r requirements.txt -r requirements_rc_tools.txt -r requirements_test.txt -r requirements_debug.txt
 	pip install --no-index --find-links=/home/rhodecode/.cache/pip/wheels -r requirements.txt -r requirements_rc_tools.txt -r requirements_test.txt -r requirements_debug.txt
 	pip install -e .
 
 
 .PHONY: sh
 ## shortcut for make dev-sh dev-env
 sh:
 	make dev-env
 	make dev-sh
 
 
 .PHONY: dev-srv
 ## run develop server instance, docker exec -it $(docker ps -q --filter 'name=dev-enterprise-ce') /bin/bash
 dev-srv:
 	pserve --reload .dev/dev.ini
 
 
 .PHONY: dev-srv-g
 ## run gunicorn multi process workers
 dev-srv-g:
 	gunicorn --paste .dev/dev.ini --bind=0.0.0.0:10020 --config=.dev/gunicorn_config.py --timeout=120 --reload
 
 
 # Default command on calling make
 .DEFAULT_GOAL := show-help
 
 .PHONY: show-help
 show-help:
 	@echo "$$(tput bold)Available rules:$$(tput sgr0)"
 	@echo
 	@sed -n -e "/^## / { \
 		h; \
 		s/.*//; \
 		:doc" \
 		-e "H; \
 		n; \
 		s/^## //; \
 		t doc" \
 		-e "s/:.*//; \
 		G; \
 		s/\\n## /---/; \
 		s/\\n/ /g; \
 		p; \
 	}" ${MAKEFILE_LIST} \
 	| LC_ALL='C' sort --ignore-case \
 	| awk -F '---' \
 		-v ncol=$$(tput cols) \
 		-v indent=19 \
 		-v col_on="$$(tput setaf 6)" \
 		-v col_off="$$(tput sgr0)" \
 	'{ \
 		printf "%s%*s%s ", col_on, -indent, $$1, col_off; \
 		n = split($$2, words, " "); \
 		line_length = ncol - indent; \
 		for (i = 1; i <= n; i++) { \
 			line_length -= length(words[i]) + 1; \
 			if (line_length <= 0) { \
 				line_length = ncol - indent - length(words[i]) - 1; \
 				printf "\n%*s ", -indent, " "; \
 			} \
 			printf "%s ", words[i]; \
 		} \
 		printf "\n"; \
 	}'

docs/admin/system_admin/tuning/tuning-gunicorn.rst

@@ -1,118 +1,118 b''
 .. _increase-gunicorn:
 
 Configure Gunicorn Workers
 --------------------------
 
 
 |RCE| comes with `Gunicorn`_ which is a Python WSGI HTTP Server for UNIX.
 
 To improve |RCE| performance you can increase the number of `Gunicorn`_  workers.
 This allows to handle more connections concurrently, and provide better
 responsiveness and performance.
 
 By default during installation |RCC|  tries to detect how many CPUs are
 available in the system, and set the number workers based on that information.
 However sometimes it's better to manually set the number of workers.
 
 To do this, use the following steps:
 
 1. Open the :file:`home/{user}/.rccontrol/{instance-id}/rhodecode.ini` file.
 2. In the ``[server:main]`` section, change the number of Gunicorn
-   ``workers`` using the following default formula :math:`(2 * Cores) + 1`.
+   ``workers`` using the following default formula `(2 * Cores) + 1`.
    We however not recommend using more than 8-12 workers per server. It's better
    to start using the :ref:`scale-horizontal-cluster` in case that performance
    with 8-12 workers is not enough.
 
 .. code-block:: ini
 
     ; Sets the number of process workers. More workers means more concurrent connections
     ; RhodeCode can handle at the same time. Each additional worker also it increases
     ; memory usage as each has it's own set of caches.
     ; Recommended value is (2 * NUMBER_OF_CPUS + 1), eg 2CPU = 5 workers, but no more
     ; than 8-10 unless for really big deployments .e.g 700-1000 users.
     ; `instance_id = *` must be set in the [app:main] section below (which is the default)
     ; when using more than 1 worker.
     workers = 6
 
     ; Type of worker class, one of `sync`, `gevent`
     ; Use `gevent` for rhodecode
     worker_class = gevent
 
     ; The maximum number of simultaneous clients per worker. Valid only for gevent
     worker_connections = 10
 
 
 3. In the ``[app:main]`` section, set the ``instance_id`` property to ``*``.
 
 .. code-block:: ini
 
     # In the [app:main] section
     [app:main]
     # You must set `instance_id = *`
     instance_id = *
 
 4. Change the VCSServer workers too. Open the
    :file:`home/{user}/.rccontrol/{instance-id}/vcsserver.ini` file.
 
 5. In the ``[server:main]`` section, increase the number of Gunicorn
-   ``workers`` using the following formula :math:`(2 * Cores) + 1`.
+   ``workers`` using the following formula `(2 * Cores) + 1`.
 
 .. code-block:: ini
 
     ; Sets the number of process workers. More workers means more concurrent connections
     ; RhodeCode can handle at the same time. Each additional worker also it increases
     ; memory usage as each has it's own set of caches.
     ; Recommended value is (2 * NUMBER_OF_CPUS + 1), eg 2CPU = 5 workers, but no more
     ; than 8-10 unless for really big deployments .e.g 700-1000 users.
     ; `instance_id = *` must be set in the [app:main] section below (which is the default)
     ; when using more than 1 worker.
     workers = 8
 
     ; Type of worker class, one of `sync`, `gevent`
     ; Use `sync` for vcsserver
     worker_class = sync
 
 
 6. Save your changes.
 7. Restart your |RCE| instances, using the following command:
 
 .. code-block:: bash
 
     $ rccontrol restart '*'
 
 
 Gunicorn Gevent Backend
 -----------------------
 
 Gevent is an asynchronous worker type for Gunicorn. It allows accepting multiple
 connections on a single `Gunicorn`_  worker. This means you can handle 100s
 of concurrent clones, or API calls using just few workers. A setting called
 `worker_connections` defines on how many connections each worker can
 handle using `Gevent`.
 
 
 To enable `Gevent` on |RCE| do the following:
 
 
 1. Open the :file:`home/{user}/.rccontrol/{instance-id}/rhodecode.ini` file.
 2. In the ``[server:main]`` section, change `worker_class` for Gunicorn.
 
 
 .. code-block:: ini
 
     ; Type of worker class, one of `sync`, `gevent`
     ; Use `gevent` for rhodecode
     worker_class = gevent
 
     ; The maximum number of simultaneous clients per worker. Valid only for gevent
     worker_connections = 30
 
 
 .. note::
 
     `Gevent` is currently only supported for Enterprise/Community instances.
     VCSServer doesn't support gevent.
 
 
 
 .. _Gunicorn: http://gunicorn.org/

docs/conf.py

@@ -1,347 +1,348 b''
 # Configuration file for the Sphinx documentation builder.
 #
 # For the full list of built-in configuration values, see the documentation:
 # https://www.sphinx-doc.org/en/master/usage/configuration.html
 
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
 import os
 import sys
 import datetime
 
 # sphinx injects tags magically during build, we re-define it here to make linters happy
 tags = tags  # noqa
 
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 sys.path.insert(0, os.path.abspath("."))
 
 
 def _get_version():
     with open("../rhodecode/VERSION") as f:
         return f.read().strip()
 
 
 now = datetime.datetime.today()
 
 # The full project version, used as the replacement for |release| and e.g. in the HTML templates.
 # For example, for the Python documentation, this may be something like 2.6.0rc1.
 # If you don’t need the separation provided between version and release, just set them both to the same value.
 release = _get_version()
 
 # The major project version, used as the replacement for |version|.
 # For example, for the Python documentation, this may be something like 2.6.
 version = ".".join(release.split(".", 2)[:2])  # First two parts of release
 
 
 # General information about the project.
 project = "RhodeCode Enterprise"
 copyright = f"2010-{now.year}, RhodeCode GmbH"
 author = "RhodeCode GmbH"
 
 # -- General configuration ------------------------------------------------
 
 # If your documentation needs a minimal Sphinx version, state it here.
 # needs_sphinx = '1.0'
 
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
     "sphinx.ext.autodoc",
     "sphinx.ext.intersphinx",
     "sphinx.ext.todo",
     "sphinx.ext.imgmath",
 ]
 
 intersphinx_mapping = {
     "enterprise": ("https://docs.rhodecode.com/RhodeCode-Enterprise/", None),
     "rcstack": ("https://docs.rhodecode.com/rcstack/", None),
     "control": ("https://docs.rhodecode.com/RhodeCode-Control/", None),
 }
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]
 
 # The suffix of source filenames.
 source_suffix = ".rst"
 
 # The encoding of source files.
 # source_encoding = 'utf-8-sig'
 
 # The master toctree document.
 master_doc = "index"
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
 # language = None
 
 rst_epilog = """
 .. |async| replace:: asynchronous
 .. |AE| replace:: Appenlight
 .. |authtoken| replace:: Authentication Token
 .. |authtokens| replace:: **Auth Tokens**
 .. |RCCEshort| replace:: Community
 .. |RCEEshort| replace:: Enterprise
 .. |git| replace:: Git
 .. |hg| replace:: Mercurial
 .. |svn| replace:: Subversion
 .. |LDAP| replace:: LDAP / Active Directory
 .. |os| replace:: operating system
 .. |OS| replace:: Operating System
 .. |PY| replace:: Python
 .. |pr| replace:: pull request
 .. |prs| replace:: pull requests
 .. |psf| replace:: Python Software Foundation
 .. |repo| replace:: repository
 .. |repos| replace:: repositories
 .. |RCC| replace:: RhodeCode Control
+.. |RCS| replace:: RhodeCode rcstack
 .. |RCE| replace:: RhodeCode Enterprise
 .. |RCCE| replace:: RhodeCode Community
 .. |RCEE| replace:: RhodeCode Enterprise
 .. |RCX| replace:: RhodeCode Extensions
 .. |RCT| replace:: RhodeCode Tools
 .. |RCEBOLD| replace:: **RhodeCode Enterprise**
 .. |RCEITALICS| replace:: `RhodeCode Enterprise`
 .. |RNS| replace:: Release Notes
 """
 
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:
 # today = ''
 # Else, today_fmt is used as the format for a strftime call.
 # today_fmt = '%B %d, %Y'
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 exclude_patterns = [
     # Special directories
     "_build",
     "result",
     # Other RST files
     "admin/rhodecode-backup.rst",
     "issue-trackers/redmine.rst",
     "known-issues/error-msg-guide.rst",
     "tutorials/docs-build.rst",
     "integrations/example-ext.py",
     "collaboration/supported-workflows.rst",
 ]
 
 
 # The reST default role (used for this markup: `text`) to use for all
 # documents.
 # default_role = None
 
 # If true, '()' will be appended to :func: etc. cross-reference text.
 # add_function_parentheses = True
 
 # If true, the current module name will be prepended to all description
 # unit titles (such as .. function::).
 # add_module_names = True
 
 # If true, sectionauthor and moduleauthor directives will be shown in the
 # output. They are ignored by default.
 # show_authors = False
 
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = "sphinx"
 
 # A list of ignored prefixes for module index sorting.
 # modindex_common_prefix = []
 
 # If true, keep warnings as "system message" paragraphs in the built documents.
 keep_warnings = tags.has("dev")
 
 
 # -- Options for HTML output ----------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 html_theme = "furo"
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
 # documentation.
 # html_theme_options = {}
 
 
 # Add any paths that contain custom themes here, relative to this directory.
 # html_theme_path = []
 
 # The name for this set of Sphinx documents.  If None, it defaults to
 # "<project> v<release> documentation".
 # html_title = None
 
 # A shorter title for the navigation bar.  Default is the same as html_title.
 # html_short_title = None
 
 # The name of an image file (relative to this directory) to place at the top
 # of the sidebar.
 # html_logo = None
 
 
 #html_sidebars = {
 #    "**": ["globaltoc.html"],
 #}
 
 # The name of an image file (within the static path) to use as favicon of the
 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
 # pixels large.
 html_favicon = "images/favicon.ico"
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ["static/css/add.css"]
+html_static_path = ['_static']
 
 # Add any extra paths that contain custom files (such as robots.txt or
 # .htaccess) here, relative to this directory. These files are copied
 # directly to the root of the documentation.
 # html_extra_path = []
 
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.
 html_last_updated_fmt = " %H:%m %b %d, %Y"
 
 # If true, SmartyPants will be used to convert quotes and dashes to
 # typographically correct entities.
 # html_use_smartypants = True
 
 # Custom sidebar templates, maps document names to template names.
 # html_sidebars = {}
 
 # Additional templates that should be rendered to pages, maps page names to
 # template names.
 # html_additional_pages = {}
 
 # If false, no module index is generated.
 # html_domain_indices = True
 
 # If false, no index is generated.
 # html_use_index = True
 
 # If true, the index is split into individual pages for each letter.
 # html_split_index = False
 
 # If true, links to the reST sources are added to the pages.
 # html_show_sourcelink = True
 
 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
 html_show_sphinx = False
 
 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
 # html_show_copyright = True
 
 # If true, an OpenSearch description file will be output, and all pages will
 # contain a <link> tag referring to it.  The value of this option must be the
 # base URL from which the finished HTML is served.
 # html_use_opensearch = ''
 
 # This is the file name suffix for HTML files (e.g. ".xhtml").
 # html_file_suffix = None
 
 # Output file base name for HTML help builder.
 htmlhelp_basename = "rhodecode-enterprise"
 
 
 # -- Options for LaTeX output ---------------------------------------------
 
 latex_elements = {
     "classoptions": ",oneside",
     "babel": "\\usepackage[english]{babel}",
     # The paper size ('letterpaper' or 'a4paper').
     #'papersize': 'letterpaper',
     # The font size ('10pt', '11pt' or '12pt').
     #'pointsize': '10pt',
     # Additional stuff for the LaTeX preamble.
     #'preamble': '',
 }
 
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
     (
         "index",
         "RhodeCodeEnterprise.tex",
         "RhodeCode Enterprise",
         "RhodeCode GmbH",
         "manual",
     ),
 ]
 
 # The name of an image file (relative to this directory) to place at the top of
 # the title page.
 # latex_logo = None
 
 # For "manual" documents, if this is true, then toplevel headings are parts,
 # not chapters.
 # latex_use_parts = False
 
 # If true, show page references after internal links.
 latex_show_pagerefs = True
 
 # If true, show URL addresses after external links.
 latex_show_urls = "footnote"
 
 # Documents to append as an appendix to all manuals.
 # latex_appendices = []
 
 # If false, no module index is generated.
 # latex_domain_indices = True
 
 # Mode for literal blocks wider than the frame. Can be
 # overflow, shrink or truncate
 pdf_fit_mode = "truncate"
 
 
 # -- Options for manual page output ---------------------------------------
 
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
     ("index", "rhodecodeenterprise", "RhodeCode Enterprise", ["RhodeCode GmbH"], 1)
 ]
 
 # If true, show URL addresses after external links.
 # man_show_urls = False
 
 
 # -- Options for Texinfo output -------------------------------------------
 
 # Grouping the document tree into Texinfo files. List of tuples
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
     (
         "index",
         "RhodeCodeEnterprise",
         "RhodeCode Enterprise",
         "RhodeCode Docs Team",
         "RhodeCodeEnterprise",
         "RhodeCode Docs Project",
         "Miscellaneous",
     ),
 ]
 
 # Documents to append as an appendix to all manuals.
 # texinfo_appendices = []
 
 # If false, no module index is generated.
 # texinfo_domain_indices = True
 
 # How to display URL addresses: 'footnote', 'no', or 'inline'.
 # texinfo_show_urls = 'footnote'
 
 # If true, do not generate a @detailmenu in the "Top" node's menu.
 # texinfo_no_detailmenu = False
 
 # We want to see todo notes in case of a pre-release build of the documentation
 todo_include_todos = tags.has("dev")

docs/index.rst

@@ -1,93 +1,92 b''
 |RCE|
 =====
 
 |RCE| is a high-performance source code management and collaboration system.
 It enables you to develop projects securely behind the firewall while
 providing collaboration tools that work with |git|, |hg|,
 and |svn| |repos|. The user interface allows you to create, edit,
 and commit files and |repos| while managing their security permissions.
 
 |RCE| provides the following features:
 
 * Source code management.
 * Extended permissions management.
 * Integrated code collaboration tools.
 * Integrated code review and notifications.
 * Scalability provided by multi-node setup.
 * Fully programmable automation API.
 * Web-based hook management.
 * Native |svn| support.
 * Migration from existing databases.
 * |RCE| SDK.
 * Built-in analytics
 * Built in integrations including: Slack, Webhooks (used for Jenkins/TeamCity and other CIs), Jira, Redmine, Hipchat
 * Pluggable authentication system.
 * Support for AD, |LDAP|, Crowd, CAS, PAM.
 * Support for external authentication via Oauth Google, Github, Bitbucket, Twitter.
 * Debug modes of operation.
 * Private and public gists.
 * Gists with limited lifetimes and within instance only sharing.
 * Fully integrated code search function.
 * Always on SSL connectivity.
 
 .. only:: html
 
    Table of Contents
    -----------------
 
 .. toctree::
    :maxdepth: 1
    :caption: Admin Documentation
 
    install/quick-start
    install/install-database
    install/install-steps
    admin/system-overview
-   nix/default-env
    admin/system-admin
    admin/user-admin
    admin/repo-admin
    admin/security-tips
    auth/auth
    issue-trackers/issue-trackers
    admin/lab-settings
 
 .. toctree::
    :maxdepth: 1
    :caption: Feature Documentation
 
    collaboration/collaboration
    collaboration/review-notifications
    collaboration/pull-requests
    code-review/code-review
    integrations/integrations
 
 .. toctree::
    :maxdepth: 1
    :caption: User Documentation
 
    usage/basic-usage
    tutorials/tutorials
 
 .. toctree::
    :maxdepth: 1
    :caption: Developer Documentation
 
    api/api
    tools/rhodecode-tools
    extensions/extensions-hooks
    contributing/contributing
 
 .. toctree::
    :maxdepth: 2
-   :caption: RhodeCode Control Documentation
+   :caption: RhodeCode rcstack Documentation
 
-   RhodeCode Installer <https://docs.rhodecode.com/RhodeCode-Control/>
+   RhodeCode Installer <https://docs.rhodecode.com/rcstack/>
 
 .. toctree::
    :maxdepth: 1
    :caption: About
 
+   release-notes/release-notes
    known-issues/known-issues
-   release-notes/release-notes
    admin/glossary

docs/install/install-steps.rst

@@ -1,14 +1,13 b''
-.. _rhodecode-post-instal-ref:
+.. _rhodecode-post-install-ref:
 
 Post Installation Tasks
 =======================
 
 The following tasks are the most common post installation requirements. Use
 the information in these sections to configure your instance of |RCE|.
 
 .. toctree::
 
    setup-email
-   database-string
    configure-celery
    migrate-repos

docs/install/quick-start.rst

@@ -1,122 +1,92 b''
 .. _quick-start:
 
 Quick Start Installation Guide
 ==============================
 
 .. important::
 
     These are quick start instructions. To optimize your |RCE|,
     |RCC|, and |RCT| usage, read the more detailed instructions in our guides.
     For detailed installation instructions, see
-    :ref:`RhodeCode Control Documentation <control:rcc>`
-
-.. tip::
+    :ref:`RhodeCode rcstack Documentation <rcstack:installation>`
 
-   If using a non-SQLite database, install and configure the database, create
-   a new user, and grant permissions. You will be prompted for this user's
-   credentials during |RCE| installation. See the relevant database
-   documentation for more details.
+
 
 To get |RCE| up and running, run through the below steps:
 
-1. Download the latest |RCC| installer from `rhodecode.com/download`_.
+1. Register to get the latest |RCC| installer instruction from `rhodecode.com/download`_.
    If you don't have an account, sign up at `rhodecode.com/register`_.
 
-2. Run the |RCC| installer and accept the End User Licence using the
+2. Run the |RCS| installer and start init process.
    following example:
 
 .. code-block:: bash
 
-    $ chmod +x RhodeCode-installer-linux-*
-    $ ./RhodeCode-installer-linux-*
+    mkdir docker-rhodecode && cd docker-rhodecode
+    curl -L -s -o rcstack https://dls.rhodecode.com/get-rcstack && chmod +x rcstack
 
-    Do you accept the RhodeCode Control license?
-    Press [Y] to accept license and [V] to view license text: y
+   ./rcstack init
 
 
 .. important::
 
    We recommend running RhodeCode as a non-root user, such as `rhodecode`;
-   this user must have a proper home directory.
+   this user must have a proper home directory and sudo permissions (to start Docker)
    Either log in as that user to install the software, or do it as root
-   with `sudo -i -u rhodecode ./RhodeCode-installer-linux-*`
+   with `sudo -i -u rhodecode ./rcstack init`
 
 
-3. Install a VCS Server, and configure it to start at boot.
+3. Follow instructions on |RCS| documentation pages
+
+   :ref:`Quick install tutorial <rcstack:quick_installation>`
+
+4. Check stack status
+
+.. code-block:: bash
+
+    ./rcstack status
+
+
+Output should look similar to this:
 
 .. code-block:: bash
 
-    $ rccontrol install VCSServer
-
-    Agree to the licence agreement? [y/N]: y
-    IP to start the server on [127.0.0.1]:
-    Port for the server to start [10005]:
-    Creating new instance: vcsserver-1
-    Installing RhodeCode VCSServer
-    Configuring RhodeCode VCS Server ...
-    Supervisord state is: RUNNING
-    Added process group vcsserver-1
-
-
-4. Install |RCEE| or |RCCE|. If using MySQL or PostgreSQL, during
-   installation you'll be asked for your database credentials, so have them at hand.
-   Mysql or Postgres needs to be running and a new database needs to be created.
-   You don't need any credentials or to create a database for SQLite.
-
-.. code-block:: bash
-   :emphasize-lines: 11-16
-
-    $ rccontrol install Community
-
-    or
-
-    $ rccontrol install Enterprise
+    ---
+    CONTAINER ID   IMAGE                                   STATUS                        NAMES                                 PORTS
+    ef54fc528e3a   traefik:v2.9.5                          Up 2 hours             rc_cluster_router-traefik-1           0.0.0.0:80->80/tcp, :::80->80/tcp
+    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
+    2be52ba58ffe   rhodecode/rhodecode-ee:4.28.0           Up 2 hours (healthy)   rc_cluster_apps-vcsserver-1
+    7cd730ad3263   rhodecode/rhodecode-ee:4.28.0           Up 2 hours (healthy)   rc_cluster_apps-celery-1
+    dfa231342c87   rhodecode/rhodecode-ee:4.28.0           Up 2 hours (healthy)   rc_cluster_apps-celery-beat-1
+    d3d76ce2de96   rhodecode/rhodecode-ee:4.28.0           Up 2 hours (healthy)   rc_cluster_apps-sshd-1
+    daaac329414b   rhodecode/rhodecode-ee:4.28.0           Up 2 hours (healthy)   rc_cluster_apps-svn-1
+    7b8504fb9acb   nginx:1.23.2                            Up 2 hours (healthy)   rc_cluster_services-nginx-1           80/tcp
+    7279c25feb6b   elasticsearch:6.8.23                    Up 2 hours (healthy)   rc_cluster_services-elasticsearch-1   9200/tcp, 9300/tcp
+    19fb93587493   redis:7.0.5                             Up 2 hours (healthy)   rc_cluster_services-redis-1           6379/tcp
+    fb77fb6496c6   channelstream/channelstream:0.7.1       Up 2 hours (healthy)   rc_cluster_services-channelstream-1   8000/tcp
+    cb6c5c022f5b   postgres:14.6                           Up 2 hours (healthy)   rc_cluster_services-database-1        5432/tcp
 
-    Username [admin]: username
-    Password (min 6 chars):
-    Repeat for confirmation:
-    Email: [e-mail]
-    Respositories location [/home/brian/repos]:
-    IP to start the Enterprise server on [127.0.0.1]:
-    Port for the Enterprise server to use [10004]:
-    Database type - [s]qlite, [m]ysql, [p]ostresql:
-    PostgreSQL selected
-    Database host [127.0.0.1]:
-    Database port [5432]:
-    Database username: db-user-name
-    Database password: somepassword
-    Database name: example-db-name
+At this point you should be able to access:
 
-5. Check the status of your installation. You |RCEE|/|RCCE| instance runs
-   on the URL displayed in the status message.
-
-.. code-block:: bash
-
-    $ rccontrol status
+- RhodeCode instance at your domain entered, e.g http://rhodecode.local, the default access
+  credentials are generated and stored inside .runtime.env.
+  For example::
 
-    - NAME: enterprise-1
-    - STATUS: RUNNING
-    - TYPE: Enterprise
-    - VERSION: 4.1.0
-    - URL: http://127.0.0.1:10003
+    RHODECODE_USER_NAME=admin
+    RHODECODE_USER_PASS=super-secret-password
 
-    - NAME: vcsserver-1
-    - STATUS: RUNNING
-    - TYPE: VCSServer
-    - VERSION: 4.1.0
-    - URL: http://127.0.0.1:10001
 
 .. note::
 
    Recommended post quick start install instructions:
 
    * Read the documentation
-   * Carry out the :ref:`rhodecode-post-instal-ref`
+   * Carry out the :ref:`rhodecode-post-install-ref`
    * Set up :ref:`indexing-ref`
    * Familiarise yourself with the :ref:`rhodecode-admin-ref` section.
 
 .. _rhodecode.com/download/: https://rhodecode.com/download/
 .. _rhodecode.com: https://rhodecode.com/
 .. _rhodecode.com/register: https://rhodecode.com/register/
 .. _rhodecode.com/download: https://rhodecode.com/download/