engineering/unrhodecode
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

chore: backmerge stable into master to make sure branches dont diverge

Browse source
This commit is contained in:
Andrii V 2025-06-23 14:25:17 +02:00
commit 7c67709da5
16 changed files with 180 additions and 227 deletions
Download patch file Download diff file Expand all files Collapse all files

185
docs/Makefile
View file

@ -1,183 +1,20 @@
# Makefile for Sphinx documentation
# Minimal makefile for Sphinx documentation
#
# You can set these variables from the command line.
# You can set these variables from the command line, and also
# from the environment for the first two.
SPHINXOPTS ?=
SPHINXBUILD ?= sphinx-build
SOURCEDIR = source
SOURCEDIR = .
BUILDDIR = _build
# User-friendly check for sphinx-build
ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
endif
# Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
# the i18n builder cannot share the environment and doctrees with the others
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
# Put it first so that "make" without argument is like "make help".
help:
@echo "Please use \`make <target>' where <target> is one of"
@echo " html to make standalone HTML files"
@echo " dirhtml to make HTML files named index.html in directories"
@echo " singlehtml to make a single large HTML file"
@echo " pickle to make pickle files"
@echo " json to make JSON files"
@echo " htmlhelp to make HTML files and a HTML help project"
@echo " qthelp to make HTML files and a qthelp project"
@echo " devhelp to make HTML files and a Devhelp project"
@echo " epub to make an epub"
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
@echo " latexpdf to make LaTeX files and run them through pdflatex"
@echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
@echo " text to make text files"
@echo " man to make manual pages"
@echo " texinfo to make Texinfo files"
@echo " info to make Texinfo files and run them through makeinfo"
@echo " gettext to make PO message catalogs"
@echo " changes to make an overview of all changed/added/deprecated items"
@echo " xml to make Docutils-native XML files"
@echo " pseudoxml to make pseudoxml-XML files for display purposes"
@echo " linkcheck to check all external links for integrity"
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
clean:
rm -rf $(BUILDDIR)/*
.PHONY: help Makefile
cleanup:
@echo "cleaning build dir"
rm -rf $(BUILDDIR)/*
@echo "cleaning result symlink"
rm -v result
html:
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
dirhtml:
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
singlehtml:
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
@echo
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
pickle:
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
@echo
@echo "Build finished; now you can process the pickle files."
json:
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
@echo
@echo "Build finished; now you can process the JSON files."
htmlhelp:
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
@echo
@echo "Build finished; now you can run HTML Help Workshop with the" \
".hhp project file in $(BUILDDIR)/htmlhelp."
qthelp:
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
@echo
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/RhodeCodeInstaller.qhcp"
@echo "To view the help file:"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/RhodeCodeInstaller.qhc"
devhelp:
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
@echo
@echo "Build finished."
@echo "To view the help file:"
@echo "# mkdir -p $$HOME/.local/share/devhelp/RhodeCodeInstaller"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/RhodeCodeInstaller"
@echo "# devhelp"
epub:
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
@echo
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
latex:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
@echo "Run \`make' in that directory to run these through (pdf)latex" \
"(use \`make latexpdf' here to do that automatically)."
latexpdf:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo "Running LaTeX files through pdflatex..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
latexpdfja:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo "Running LaTeX files through platex and dvipdfmx..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
text:
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
@echo
@echo "Build finished. The text files are in $(BUILDDIR)/text."
man:
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
@echo
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
texinfo:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
@echo "Run \`make' in that directory to run these through makeinfo" \
"(use \`make info' here to do that automatically)."
info:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo "Running Texinfo files through makeinfo..."
make -C $(BUILDDIR)/texinfo info
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
gettext:
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
@echo
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
changes:
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
@echo
@echo "The overview file is in $(BUILDDIR)/changes."
linkcheck:
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
@echo
@echo "Link check complete; look for any errors in the above output " \
"or in $(BUILDDIR)/linkcheck/output.txt."
doctest:
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
@echo "Testing of doctests in the sources finished, look at the " \
"results in $(BUILDDIR)/doctest/output.txt."
xml:
$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
@echo
@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
pseudoxml:
$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
@echo
@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

0
docs/_static/.keep vendored Normal file
View file

11
docs/_templates/page.html vendored
View file

@ -87,7 +87,7 @@
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
</label>
</div>
<article role="main">
<article role="main" id="furo-main-content">
{% block content %}{{ body }}{% endblock %}
</article>
</div>
@ -141,6 +141,9 @@
{% trans %}<a href="https://www.sphinx-doc.org/">Sphinx</a> and {% endtrans -%}
<a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
{% endif -%}
{%- if last_updated -%}
<div class="last-updated">
{% trans last_updated=last_updated|e -%}
@ -149,7 +152,7 @@
</div>
<div style="border-top: 0">
Got documentation defects and suggestions? <a href="https://community.rhodecode.com">Submit docs issues</a>
Got documentation defects and suggestions? <a href="https://community.rhodecode.com/new-topic?title=documentation%20issue&body=Please%20describe%20the%20issue&category=support&tags=docs-issue">Submit docs issues</a>
</div>
{%- endif %}
@ -172,6 +175,9 @@
</svg>
</a>
{%- endif -%}
{#- Show GitHub repository home -#}
{%- if READTHEDOCS and display_github and github_user != "None" and github_repo != "None" -%}
{%- endif -%}
{%- endif %}
</div>
{%- endif %}
@ -200,5 +206,4 @@
</aside>
</div>
</div>
{%- endblock %}

34
docs/_templates/sidebar/brand.html vendored Normal file
View file

@ -0,0 +1,34 @@
{#-
Hi there!
You might be interested in https://pradyunsg.me/furo/customisation/sidebar/
Although if you're reading this, chances are that you're either familiar
enough with Sphinx that you know what you're doing, or landed here from that
documentation page.
Hope your day's going well. :)
-#}
<a class="sidebar-brand{% if logo %} centered{% endif %}" href="{{ pathto(master_doc) }}">
{% block brand_content %}
{%- if logo_url %}
<div class="sidebar-logo-container">
<img class="sidebar-logo" src="{{ logo_url }}" alt="Logo"/>
</div>
{%- endif %}
{%- if theme_light_logo and theme_dark_logo %}
<div class="sidebar-logo-container">
<img class="sidebar-logo only-light" src="{{ pathto('_static/' + theme_light_logo, 1) }}" alt="Light Logo"/>
<img class="sidebar-logo only-dark" src="{{ pathto('_static/' + theme_dark_logo, 1) }}" alt="Dark Logo"/>
</div>
{%- endif %}
{% if not theme_sidebar_hide_name %}
<span class="sidebar-brand-text">
RhodeCode <br/>
Enterprise {{ release }} docs
</span>
{%- endif %}
{% endblock brand_content %}
</a>

4
docs/admin/system_admin/tuning/tuning-gunicorn.rst
View file

@ -18,7 +18,7 @@ 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.
@ -55,7 +55,7 @@ To do this, use the following steps:
: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

3
docs/conf.py
View file

@ -103,6 +103,7 @@ rst_epilog = """
.. |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
@ -199,7 +200,7 @@ 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

8
docs/index.rst
View file

@ -89,10 +89,16 @@ and commit files and |repos| while managing their security permissions.
extensions/extensions-hooks
contributing/contributing
.. toctree::
:maxdepth: 2
:caption: RhodeCode rcstack Documentation
RhodeCode Installer <https://docs.rhodecode.com/rcstack/>
.. toctree::
:maxdepth: 1
:caption: About
known-issues/known-issues
release-notes/release-notes
known-issues/known-issues
admin/glossary

37
docs/install/database-string.rst
View file

@ -1,37 +0,0 @@
.. _config-database:
Make Database Changes
---------------------
.. important::
If you do change the |repo| database that |RCEE| uses, then you will need to
upgrade the database, and also remap and rescan the |repos|. More detailed
information is available in the
:ref:`Alternative upgrade documentation <control:install-port>`.
If you need to change database connection details for a |RCEE| instance,
use the following steps:
1. Open the :file:`rhodecode.ini` file for the instance you wish to edit. The
default location is
:file:`home/{user}/.rccontrol/{instance-id}/rhodecode.ini`
2. When you open the file, find the database configuration section,
and use the below example to change the
connection details:
.. code-block:: ini
#########################################################
### DB CONFIGS - EACH DB WILL HAVE IT'S OWN CONFIG ###
#########################################################
# Default SQLite config
sqlalchemy.db1.url = sqlite:////home/brian/.rccontrol/enterprise-1/rhodecode.db
# Use this example for a PostgreSQL
sqlalchemy.db1.url = postgresql://postgres:qwe@localhost/rhodecode
# see sqlalchemy docs for other advanced settings
sqlalchemy.db1.echo = false
sqlalchemy.db1.pool_recycle = 3600

3
docs/install/install-steps.rst
View file

@ -1,4 +1,4 @@
.. _rhodecode-post-instal-ref:
.. _rhodecode-post-install-ref:
Post Installation Tasks
=======================
@ -9,6 +9,5 @@ the information in these sections to configure your instance of |RCE|.
.. toctree::
setup-email
database-string
configure-celery
migrate-repos

77
docs/install/quick-start.rst
View file

@ -3,10 +3,79 @@
Quick Start Installation Guide
==============================
Since version 5.0.0 Rhodecode runs in Docker, and to get |RCE| up and running,
you need to use RCstack installer - https://docs.rhodecode.com/rcstack/install/installation.html
.. 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 rcstack Documentation <rcstack:installation>`
To get |RCE| up and running, run through the below steps:
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 |RCS| installer and start init process.
following example:
.. code-block:: bash
mkdir docker-rhodecode && cd docker-rhodecode
curl -L -s -o rcstack https://dls.rhodecode.com/get-rcstack && chmod +x rcstack
./rcstack init
.. important::
We recommend running RhodeCode as a non-root user, such as `rhodecode`;
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 ./rcstack init`
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
---
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
At this point you should be able to access:
- RhodeCode instance at your domain entered, e.g http://rhodecode.local, the default access
credentials are generated and stored inside .runtime.env.
For example::
RHODECODE_USER_NAME=admin
RHODECODE_USER_PASS=super-secret-password
Please follow RCstack documentation steps to set up your |RCE| installation.
.. note::
@ -14,7 +83,7 @@ Please follow RCstack documentation steps to set up your |RCE| installation.
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.

1
docs/release-notes/release-notes-5.0.0.rst
View file

@ -4,6 +4,7 @@
Release Date
^^^^^^^^^^^^
- 2024-05-14

37
docs/release-notes/release-notes-5.5.3.rst Normal file
View file

@ -0,0 +1,37 @@
|RCE| 5.5.3 |RNS|
-----------------
Release Date
^^^^^^^^^^^^
- 2025-05-16
New Features
^^^^^^^^^^^^
General
^^^^^^^
Security
^^^^^^^^
Performance
^^^^^^^^^^^
Fixes
^^^^^
- Fixed another issue with auth configuration for Jira integration
Upgrade notes
^^^^^^^^^^^^^
- RhodeCode 5.5.3 is unscheduled bugfix release.

1
docs/release-notes/release-notes.rst
View file

@ -10,6 +10,7 @@ Release Notes
:maxdepth: 1
release-notes-5.6.0.rst
release-notes-5.5.3.rst
release-notes-5.5.2.rst
release-notes-5.5.1.rst
release-notes-5.5.0.rst