From ef74fe98e9d4804743001c32339b8242489ebde9 Mon Sep 17 00:00:00 2001 From: RhodeCode Admin Date: Sun, 13 Jul 2025 04:44:02 +0200 Subject: [PATCH] docs: remove more rccontrol sections --- docs/admin/system-overview.rst | 2 +- .../apache/apache-conf-example.rst | 4 +- .../system_admin/config-files-overview.rst | 2 +- .../system_admin/gunicorn-ssl-support.rst | 2 +- docs/admin/system_admin/indexing.rst | 2 +- .../system_admin/svn-path-permissions.rst | 2 +- .../system_admin/tuning/tuning-gunicorn.rst | 4 +- docs/admin/system_admin/vcs-server.rst | 18 +- docs/auth/ssh-connection.rst | 2 +- docs/conf.py | 6 +- docs/install/config-database.rst | 30 +++ docs/install/configure-celery.rst | 2 +- docs/tools/tools-overview.rst | 27 +-- docs/tutorials/deploy-from-host.rst | 178 +----------------- 14 files changed, 61 insertions(+), 220 deletions(-) create mode 100644 docs/install/config-database.rst diff --git a/docs/admin/system-overview.rst b/docs/admin/system-overview.rst index 23cf79da..e40ff0df 100644 --- a/docs/admin/system-overview.rst +++ b/docs/admin/system-overview.rst @@ -80,7 +80,7 @@ Configuration Files * :file:`config/_shared/rhodecode.ini` * :file:`/home/{user}/.rccontrol/{instance-id}/search_mapping.ini` -* :file:`/home/{user}/.rccontrol/{vcsserver-id}/vcsserver.ini` +* :file:`config/_shared/vcsserver.ini` * :file:`/home/{user}/.rccontrol/supervisor/supervisord.ini` * :file:`/home/{user}/.rccontrol.ini` * :file:`/home/{user}/.rhoderc` diff --git a/docs/admin/system_admin/apache/apache-conf-example.rst b/docs/admin/system_admin/apache/apache-conf-example.rst index 0925e54e..ca9909fd 100644 --- a/docs/admin/system_admin/apache/apache-conf-example.rst +++ b/docs/admin/system_admin/apache/apache-conf-example.rst @@ -72,8 +72,8 @@ Below config if for an Apache Reverse Proxy configuration. # Increase headers size for large Mercurial headers sent with many branches LimitRequestLine 16380 - # Url to running RhodeCode instance. This is shown as `- URL:` when - # running rccontrol status. + # Url to running RhodeCode instance. This is shown as `running hostname:` when + # running ./rcstack status ProxyPass / http://127.0.0.1:10002/ connectiontimeout=7200 timeout=7200 Keepalive=On ProxyPassReverse / http://127.0.0.1:10002/ diff --git a/docs/admin/system_admin/config-files-overview.rst b/docs/admin/system_admin/config-files-overview.rst index 380fc6ce..69b1a2ff 100644 --- a/docs/admin/system_admin/config-files-overview.rst +++ b/docs/admin/system_admin/config-files-overview.rst @@ -33,7 +33,7 @@ sections. \- **vcsserver.ini** Default location: - :file:`/home/{user}/.rccontrol/{vcsserver-id}/vcsserver.ini` + :file:`config/_shared/vcsserver.ini` The VCS Server handles the connection between your |repos| and |RCE|. See the :ref:`vcs-server` section for configuration options and more diff --git a/docs/admin/system_admin/gunicorn-ssl-support.rst b/docs/admin/system_admin/gunicorn-ssl-support.rst index 10ee5689..5d8fd47d 100644 --- a/docs/admin/system_admin/gunicorn-ssl-support.rst +++ b/docs/admin/system_admin/gunicorn-ssl-support.rst @@ -10,7 +10,7 @@ without a need to use HTTP server like Nginx or Apache. To Configure SSL support directly with :term:`Gunicorn` you need to simply add the key and certificate paths to your configuration file. -1. Open the :file:`home/{user}/.rccontrol/{instance-id}/rhodecode.ini` file. +1. Open the:file:`config/_shared/rhodecode.ini` file. 2. In the ``[server:main]`` section, add two new variables called `certfile` and `keyfile`. diff --git a/docs/admin/system_admin/indexing.rst b/docs/admin/system_admin/indexing.rst index 42de3a1a..9a60673b 100644 --- a/docs/admin/system_admin/indexing.rst +++ b/docs/admin/system_admin/indexing.rst @@ -325,7 +325,7 @@ Please check query language examples in the search field for some advanced query 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` + :file:`config/_shared/rhodecode.ini` 2. Find the search configuration section and change it to: diff --git a/docs/admin/system_admin/svn-path-permissions.rst b/docs/admin/system_admin/svn-path-permissions.rst index 19aff10b..03afdbdc 100644 --- a/docs/admin/system_admin/svn-path-permissions.rst +++ b/docs/admin/system_admin/svn-path-permissions.rst @@ -14,7 +14,7 @@ Configuring RhodeCode 1. To configure path based permissions first we need to use a customized mod_dav_svn.conf. - Open :file:`home/{user}/.rccontrol/{instance-id}/rhodecode.ini` file. + Open:file:`config/_shared/rhodecode.ini` file. And find `svn.proxy.config_template` setting. Now set a new path to read the template from. For example: diff --git a/docs/admin/system_admin/tuning/tuning-gunicorn.rst b/docs/admin/system_admin/tuning/tuning-gunicorn.rst index 2ed0f350..8aa89a51 100644 --- a/docs/admin/system_admin/tuning/tuning-gunicorn.rst +++ b/docs/admin/system_admin/tuning/tuning-gunicorn.rst @@ -16,7 +16,7 @@ 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. +1. Open the:file:`config/_shared/rhodecode.ini` file. 2. In the ``[server:main]`` section, change the number of Gunicorn ``workers`` using the following default formula `(2 * Cores) + 1`. We however not recommend using more than 8-12 workers per server. It's better @@ -94,7 +94,7 @@ handle using `Gevent`. To enable `Gevent` on |RCE| do the following: -1. Open the :file:`home/{user}/.rccontrol/{instance-id}/rhodecode.ini` file. +1. Open the:file:`config/_shared/rhodecode.ini` file. 2. In the ``[server:main]`` section, change `worker_class` for Gunicorn. diff --git a/docs/admin/system_admin/vcs-server.rst b/docs/admin/system_admin/vcs-server.rst index 8dce4e37..0a1a2728 100644 --- a/docs/admin/system_admin/vcs-server.rst +++ b/docs/admin/system_admin/vcs-server.rst @@ -118,7 +118,7 @@ configure the Redis backend for VCSServer caches. Once configured, restart the VCS Server. Make sure Redis is installed and running. -Open :file:`/home/{user}/.rccontrol/{vcsserver-id}/vcsserver.ini` +Open :file:`config/_shared/vcsserver.ini` file and ensure the below settings for `repo_object` type cache are set: .. code-block:: ini @@ -154,22 +154,10 @@ To clear the cache completely, you can restart the VCS Server. you only perform this when there is very little traffic on the instance. Use the following example to restart your VCS Server, -for full details see the :ref:`RhodeCode Control CLI `. - +for full details see the :ref:`RhodeCode rcstack CLI `. .. code-block:: bash - $ rccontrol status - -.. code-block:: vim - - - NAME: vcsserver-1 - - STATUS: RUNNING - logs:/home/ubuntu/.rccontrol/vcsserver-1/vcsserver.log - - VERSION: 4.7.2 VCSServer - - URL: http://127.0.0.1:10008 - - CONFIG: /home/ubuntu/.rccontrol/vcsserver-1/vcsserver.ini - - $ ./rcstack stack rhodecode restart + $ ./rcstack stack rhodecode restart vcsserver .. _vcs-server-config-file: diff --git a/docs/auth/ssh-connection.rst b/docs/auth/ssh-connection.rst index 721af64d..95968021 100644 --- a/docs/auth/ssh-connection.rst +++ b/docs/auth/ssh-connection.rst @@ -83,7 +83,7 @@ following instructions. If you wish to have integrations working correctly via SSH please configure The Application base_url. - Use the ``rccontrol status`` command to view instance details. + Use the ``./rcstack status`` command to view instance details. Hostname is required for the integration to properly set the instance URL. When your hostname is known (e.g https://code.rhodecode.com) please set it diff --git a/docs/conf.py b/docs/conf.py index f71a4c18..656d7cb9 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -57,8 +57,8 @@ extensions = [ ] intersphinx_mapping = { - "enterprise": ("https://docs.rhodecode.com/RhodeCode-Enterprise/", None), - "rcstack": ("https://docs.rhodecode.com/rcstack/", None), + "enterprise": ("https://docs.rhodecode.com/5.x/rce/", None), + "rcstack": ("https://docs.rhodecode.com/5.x/rcstack/", None), "control": ("https://docs.rhodecode.com/RhodeCode-Control/", None), } @@ -200,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'] +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 diff --git a/docs/install/config-database.rst b/docs/install/config-database.rst new file mode 100644 index 00000000..6ec53780 --- /dev/null +++ b/docs/install/config-database.rst @@ -0,0 +1,30 @@ +.. _config-database: + +Change database connection details +---------------------------------- + +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:`config/_shared/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 \ No newline at end of file diff --git a/docs/install/configure-celery.rst b/docs/install/configure-celery.rst index 8edfc1a5..fa7a5396 100644 --- a/docs/install/configure-celery.rst +++ b/docs/install/configure-celery.rst @@ -45,7 +45,7 @@ In order to install and configure Celery, follow these steps: 3. Configure Celery in the - :file:`home/{user}/.rccontrol/{instance-id}/rhodecode.ini` file. + :file:`config/_shared/rhodecode.ini` file. Set the broker_url as minimal settings required to enable operation. If used our example data from pt 1a, here is how the broker url should look like:: diff --git a/docs/tools/tools-overview.rst b/docs/tools/tools-overview.rst index ce845038..bce68cb0 100644 --- a/docs/tools/tools-overview.rst +++ b/docs/tools/tools-overview.rst @@ -18,19 +18,9 @@ and once configured see the :ref:`tools-cli` for more details. .. code-block:: bash # Get the status of each instance you wish to use with Tools - (venv)brian@ubuntu:~$ rccontrol status + (venv)brian@ubuntu:~$ ./rcstack status - - NAME: momentum-1 - - STATUS: RUNNING - - TYPE: Momentum - - VERSION: 3.0.0-nightly-momentum - - URL: http://127.0.0.1:10003 - - - NAME: momentum-3 - - STATUS: RUNNING - - TYPE: Momentum - - VERSION: 3.0.0-nightly-momentum - - URL: http://127.0.0.1:10007 + RCSTACK: v5.27.3, running hostname: http://code.rhodecode.com Example :file:`/home/{user}/.rhoderc` file. @@ -38,23 +28,22 @@ Example :file:`/home/{user}/.rhoderc` file. # Configure the .rhoderc file for each instance # API keys found in your instance - [instance:enterprise-1] - api_host = http://127.0.0.1:10003/ + [instance:enterprise-main] + api_host = http://code.rhodecode.com api_key = 91fdbdc257289c46633ef5aab274412911de1ba9 repo_dir = /home/brian/repos - [instance:enterprise-3] - api_host = http://127.0.0.1:10007/ + [instance:enterprise-ci] + api_host = http://ci.rhodecode.com api_key = 5a925f65438d29f8d6ced8ab8e8c3d305998d1d9 repo_dir = /home/brian/testing-repos/ -Example usage of |RCT| after |RCE| 3.5.0. From this version onwards |RCT| is -packaged with |RCE| by default. +Example usage of |RCT| after |RCE| 5.0.0. .. code-block:: bash - $ .rccontrol/enterprise-4/profile/bin/rhodecode-api --instance-name=enterprise-4 get_ip [11:56:57 on 05/10/2018] + $ ./rcstack cli cmd rhodecode-api --instance-name=enterprise-main get_ip [11:56:57 on 05/10/2018] { "error": null, diff --git a/docs/tutorials/deploy-from-host.rst b/docs/tutorials/deploy-from-host.rst index f2a42b13..b7da7427 100644 --- a/docs/tutorials/deploy-from-host.rst +++ b/docs/tutorials/deploy-from-host.rst @@ -7,7 +7,7 @@ If you wish to deploy your own |RCE| instance from something like a `Digital Ocean`_ droplet, or a `hetzner`_ server use the following instructions to get it setup. -I'm using an Ubuntu 14.04 image for the purposes of this +I'm using an Ubuntu 22.04 image for the purposes of this tutorial, but all other Unix environments will be pretty similar. You can check out the full lists of supported platforms and versions in the :ref:`system-overview-ref` section. @@ -17,7 +17,7 @@ Create a Digital Ocean Droplet ------------------------------ 1. Sign into Digital Ocean. -2. Create a Droplet choosing Ubuntu 14.04 as your |os|. +2. Create a Droplet choosing Ubuntu 22.04 as your |os|. 3. (Optional) Add SSH keys if you have them set up. Configure Your Server @@ -34,181 +34,15 @@ host |RCE|. $ ssh root@203.0.113.113 -2. It is not advised to install |RCE| as the ``root`` user. So create a user - with sudo permissions and then carry out the rest of the steps from that user - account. -.. code-block:: bash - - # Create a user with sudo permissions - root@rhodecode:~# sudo useradd -m -s /bin/bash -d /home/brian -U brian - root@rhodecode:~# sudo usermod -a -G sudo brian - - # Set the password for that user - root@rhodecode:~# passwd brian - Enter new UNIX password: - Retype new UNIX password: - passwd: password updated successfully - - # Switch to that user for the rest of the steps - root@rhodecode:~# su brian - - # You should see your home dir change to what was set during installation - brian@rhodecode:~$ cd ~ - brian@rhodecode:~$ pwd - /home/brian - -Once you have this set up, you are ready to install |RCC|. - -Install |RCC| +Install |RCS| ------------- -|RCC| will install and manage the package dependencies for your |RCE| instance. +|RCS| will install and manage the package dependencies for your |RCE| instance. -1. Download the |RCC| installer from https://rhodecode.com/download/ -2. Once downloaded to your computer, transfer the package to your server +Please refer to this documentation for quick installation +:ref:`Quick install tutorial ` -.. note:: - - These steps happen on your computer, not on the server. - -.. code-block:: bash - - # Change to where the file is downloaded - $ cd Downloads/ - - # SFTP to your server - $ sftp brian@203.0.113.113 - - # Use mput to transfer the file - sftp> mput RhodeCode-installer-linux-391_b1a804c4d69b_d6c087d520e3 - Uploading RhodeCode-installer-linux-391_b1a804c4d69b_d6c087d520e3 to /home/brian/RhodeCode-installer-linux-391_b1a804c4d69b_d6c087d520e3 - RhodeCode-installer-linux-391_b1a804c4d69b_d6c087d 100% 289MB 4.1MB/s 01:11 - sftp> exit - -The |RCC| installer is now on your server, and you can read the full -instructions here -:ref:`Install RhodeCode Control ` , -but below is the example shortcut. - -.. code-block:: bash - - # Check that the script is uploaded to your home directory - $ ls -1 - RhodeCode-installer-linux-buildYYYYXXXX_ZZZZ - - # Change the script permissions - $ chmod +x RhodeCode-installer-linux* - - # Run the installer and accept the prompts - $ ./RhodeCode-installer-linux-* - -.. important:: - - Once finished, exit the terminal and sign in again. This is to refresh you - session to pick up the new commands. - -Install |RCE| -------------- - -Now that |RCC| is installed, you can install |RCE|. For the full -instructions, see -:ref:`Install RhodeCode Enterprise `, -but the below is an example shortcut. - -.. code-block:: bash - - # Install a VCS Server and follow the prompts - $ rccontrol install VCSServer --start-at-boot - - Extracting VCSServer ... - Configuring RhodeCode VCS Server ... - Supervisord state is: RUNNING - Added process group vcsserver-1 - - # Install a RhodeCode Enterprise instance and follow the prompts - $ rccontrol install Enterprise --start-at-boot - - Configuration of RhodeCode Enterprise passed. - Supervisord state is: RUNNING - Added process group enterprise-1 - -|RCE| is now installed on your server, and is running on the port displayed -by the ``rccontrol status`` command. - -.. code-block:: bash - - brian@rhodecode:~$ rccontrol status - - - NAME: enterprise-1 - - STATUS: RUNNING - - TYPE: Enterprise - - VERSION: 3.1.1 - - URL: http://127.0.0.1:10002 - - - NAME: vcsserver-1 - - STATUS: RUNNING - - TYPE: VCSServer - - VERSION: 1.1.1 - - URL: http://127.0.0.1:10001 - -Serve |RCE| using Nginx ------------------------ - -Now that |RCE| is running, you need to use Nginx or Apache to serve it to -users. For detailed instructions about setting up your webserver, see the -:ref:`rhodecode-admin-ref` section. But the below shortcut should help serve -it. - -1. Install Nginx on your server. - -.. code-block:: bash - - # Install nginx - $ sudo apt-get install nginx - -2. Create a virtual hosts file for RhodeCode Enterprise. Create - the file in this location :file:`/etc/nginx/sites-available`. In this demo - I have called it ``vcs.conf`` - -.. code-block:: bash - - # Create the file - $ sudo vi /etc/nginx/sites-available/vcs.conf - -Use the following example to create yours. - -.. code-block:: nginx - - server { - listen 80; - # Change to your IP, or a domain name if you've set that up - server_name 203.0.113.113 ; - - location / { - # Set this line to match the RhodeCode Enterprise Instance URL - proxy_pass http://127.0.0.1:10002/; - proxy_set_header Host $Host; - proxy_buffering off; - # Setting this to a high number allows large repo pushes - client_max_body_size 4G; - } - } - -3. Symlink the virtual hosts file to the ``sites-enabled`` folder, - and then restart Nginx. - -.. code-block:: bash - - # Symlink the virtual hosts file - $ ln -s /etc/nginx/sites-available/vcs.conf /etc/nginx/sites-enabled/vcs.conf - - # You can also delete the Nginx default symlink - $ rm /etc/nginx/sites-enabled/default - - # Restart Nginx - $ sudo /etc/init.d/nginx restart - * Restarting nginx nginx [ OK ] Once restarted, you should see a clean |RCE| instance running on the IP address, or the domain you have set up.