diff --git a/Makefile b/Makefile --- a/Makefile +++ b/Makefile @@ -65,7 +65,7 @@ ruff-check: .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 diff --git a/docs/admin/system_admin/tuning/tuning-gunicorn.rst b/docs/admin/system_admin/tuning/tuning-gunicorn.rst --- a/docs/admin/system_admin/tuning/tuning-gunicorn.rst +++ b/docs/admin/system_admin/tuning/tuning-gunicorn.rst @@ -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 @@ 4. Change the VCSServer workers too. Ope :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 diff --git a/docs/conf.py b/docs/conf.py --- a/docs/conf.py +++ b/docs/conf.py @@ -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 diff --git a/docs/index.rst b/docs/index.rst --- a/docs/index.rst +++ b/docs/index.rst @@ -43,7 +43,6 @@ and commit files and |repos| while manag install/install-database install/install-steps admin/system-overview - nix/default-env admin/system-admin admin/user-admin admin/repo-admin @@ -80,14 +79,14 @@ and commit files and |repos| while manag .. toctree:: :maxdepth: 2 - :caption: RhodeCode Control Documentation + :caption: RhodeCode rcstack Documentation - RhodeCode Installer + RhodeCode Installer .. toctree:: :maxdepth: 1 :caption: About + release-notes/release-notes known-issues/known-issues - release-notes/release-notes admin/glossary diff --git a/docs/install/database-string.rst b/docs/install/database-string.rst deleted file mode 100644 --- a/docs/install/database-string.rst +++ /dev/null @@ -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 `. - -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 diff --git a/docs/install/install-steps.rst b/docs/install/install-steps.rst --- a/docs/install/install-steps.rst +++ b/docs/install/install-steps.rst @@ -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 con .. toctree:: setup-email - database-string configure-celery migrate-repos diff --git a/docs/install/quick-start.rst b/docs/install/quick-start.rst --- a/docs/install/quick-start.rst +++ b/docs/install/quick-start.rst @@ -8,110 +8,80 @@ Quick Start Installation Guide 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 ` - -.. tip:: + :ref:`RhodeCode rcstack Documentation ` - 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 ` + +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: your@mail.com - 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. diff --git a/docs/nix/add-to-env.rst b/docs/nix/add-to-env.rst deleted file mode 100644 --- a/docs/nix/add-to-env.rst +++ /dev/null @@ -1,43 +0,0 @@ -Adding Custom Packages -====================== - -If you wish to make additional Python modules available to use with -extensions that you have developed, use the following information. - -Prerequisite ------------- - -|RCC| manages the |RCE| environment using Supervisor. To add custom packages -you need to install your instance of |RCE| as a self managed -instance. This will let you to update the ``PYTHONPATH`` without |RCC| -overwriting it. You can then extend the ``PYTHONPATH`` to find packaged -outside of the |RCC| managed environment. To install |RCE| as a self-managed -service using |RCC|, see the -:ref:`Self-managed Instructions `. - -Adding Custom Packages ----------------------- - -Once you have your instance configured as self-managed, use the following steps. - -1. Add the modules to the |RCE| instance directory, - :file:`/home/{user}/.rccontrol/{instance-id}`. -2. Add this location to your ``PYTHONPATH`` environment variable. This is set - in the :file:`/home/{user}/.rccontrol/supervisor/supervisor.ini` file. For - more information about ``PYTHONPATH``, see the `PYTHONPATH documentation`_. - -.. code-block:: ini - - [program:enterprise-1_script] - numprocs = 1 - redirect_stderr = true - environment = PYTHONPATH="",GIT_SSL_CAINFO="/home/user/.rccontrol-profile/etc/ca-bundle.crt" - -3. Specify the hook for your added module on the - :menuselection:`Admin --> Settings --> Hooks` page. For - example, ``python:rcextensions/you.custom.hook`` -4. Restart |RCE| using the ``rccontrol restart `` command. - For more information, see the :ref:`RhodeCode Control CLI ` - documentation. - -.. _PYTHONPATH documentation: https://docs.python.org/2/using/cmdline.html#envvar-PYTHONPATH diff --git a/docs/nix/default-env.rst b/docs/nix/default-env.rst deleted file mode 100644 --- a/docs/nix/default-env.rst +++ /dev/null @@ -1,10 +0,0 @@ -.. _system-pack: - -System Packaging -================ - -.. toctree:: - :maxdepth: 1 - - nix - add-to-env diff --git a/docs/nix/nix.rst b/docs/nix/nix.rst deleted file mode 100644 --- a/docs/nix/nix.rst +++ /dev/null @@ -1,31 +0,0 @@ -.. _rhodecode-nix-ref: - -Nix Packaging -============= - -|RCE| is installed using |Nix Package Manager|. The Nix environment provides -the following features for maintenance and deployment: - -* Atomic upgrades and rollbacks -* Complete dependency management -* Garbage collection -* Binary patching -* Secure channel updates -* Nix works on Windows, Linux, and OSX - -The complete list of dependencies can be found in -:file:`/opt/rhodecode/store/{unique-hash}`. - -.. note:: - - No |RCE| data is stored in this location. - -.. warning:: - - Never alter any of the packages in the store. Always use the - :ref:`RhodeCode Control CLI ` update functions to keep - the packages and instances updated. - -.. |Nix Package Manager| raw:: html - - Nix