docs(dev-build): added step-by-step instructions for dev env setup and setup_dev.sh for easier installation

docs/source/dev/step-by-step-example.rst

@@ -0,0 +1,113 b''
+.. _step-by-step-example:
+
+RhodeCode Development Infrastructure Setup Example
+==================================================
+
+1. **Configure PATH:** Set the environment variable for the workspace path.
+
+    .. code-block:: bash
+
+        export $WORKSPACE_HOME=/path/to/store
+
+2. **Run Setup Script:** Execute the `setup_dev.sh` script to install dependencies. Ensure it's executable.
+
+    .. code-block:: bash
+
+        # Fetch script
+        curl -L -s -o setup_dev.sh https://code.rhodecode.com/rhodecode-enterprise-docker/raw/master/scripts/dev-tools/setup_dev.sh && chmod +x setup_dev.sh
+        # Run script
+        ./setup_dev.sh
+
+3. **RhodeCode Enterprise-CE Setup:**
+
+    - Run the interactive console:
+
+        .. code-block:: bash
+
+            ./dev-tools ce
+
+    - Initialize the database:
+
+        .. code-block:: bash
+
+            /usr/local/bin/rhodecode_bin/bin/rc-setup-app \
+            /home/rhodecode/rhodecode-enterprise-ce/.dev/dev.ini \
+            --force-yes \
+            --skip-existing-db \
+            --user=admin \
+            --password=secret \
+            --email=[e-mail] \
+            --repos=/var/opt/rhodecode_repo_store
+
+    - Manually upgrade the database:
+
+        .. code-block:: bash
+
+            /usr/local/bin/rhodecode_bin/bin/rc-upgrade-db \
+            /home/rhodecode/rhodecode-enterprise-ce/.dev/dev.ini \
+            --force-yes
+
+    - Exit the console:
+
+        .. code-block:: bash
+
+            exit
+
+4. **Configure Waitress Server:**
+
+    Add the following configuration below GUNICORN APPLICATION SERVER in `vscserver.ini` and `rhodecode.ini` in `docker-rhodecode/config/_shared`:
+
+    .. code-block:: ini
+
+        use = egg:waitress#main
+        ## Number of worker threads
+        threads = 3
+        ## MAX BODY SIZE 100GB
+        max_request_body_size = 107374182400
+        asyncore_use_poll = true
+
+5. **Apply Changes:**
+
+    .. code-block:: bash
+
+        cd $WORKSPACE_HOME/rhodecode-vcsserver && cp ../docker-rhodecode/config/_shared/vcsserver.ini .dev/dev.ini
+        cd $WORKSPACE_HOME/rhodecode-enterprise-ce && cp ../docker-rhodecode/config/_shared/rhodecode.ini .dev/dev.ini
+
+6. **Remove Database Vars:**
+
+    In `docker-rhodecode/.custom`, remove the following variables from `.dev.env`: `RC_DB_URL` and `RC_SQLALCHEMY_DB1_URL`.
+
+7. **Update Makefile:**
+
+    Add the following line after `dev-env:` (line 125) in `rhodecode-enterprise-ce/Makefile`:
+
+    .. code-block:: bash
+
+        sudo -u root chown rhodecode:rhodecode /home/rhodecode/.cache/pip/
+
+8. **Adjust Permissions:**
+
+    .. code-block:: bash
+
+        chown -R 999:999 $WORKSPACE_HOME/
+
+9. **Run RhodeCode Services:**
+
+    Open two terminal windows, navigate to `$WORKSPACE_HOME/docker-rhodecode` in both terminals.
+
+    - In the first terminal, run:
+
+        .. code-block:: bash
+
+            ./dev-tools ce
+
+    - In the second terminal, run:
+
+        .. code-block:: bash
+
+            ./dev-tools vcs
+
+**COMMANDS:**
+
+- Run server: `make dev-srv`
+- Run tests: `pytest -v`

scripts/dev-tools/setup_dev.sh

@@ -0,0 +1,52 b''
+#!/bin/bash
+
+# Navigate into directory that you already defined
+cd $WORKSPACE_HOME
+
+mkdir docker-rhodecode && cd docker-rhodecode
+
+# To quickly get and install rcstack run this command
+curl -L -s -o rcstack https://dls.rhodecode.com/get-rcstack && chmod +x rcstack
+./rcstack init
+
+# Init command will setup docker, and dev-tools. Please check available options using
+curl -L -s -o dev-tools https://code.rhodecode.com/rhodecode-enterprise-docker/raw/master/scripts/dev-tools/dev-tools && chmod +x dev-tools
+./dev-tools --help
+
+# Navigate back to the parent directory
+cd ..
+
+# Clone repositories
+hg clone https://code.rhodecode.com/internal/rhodecode-vcsserver
+hg clone https://code.rhodecode.com/internal/rhodecode-enterprise-ce
+hg clone https://code.rhodecode.com/internal/rhodecode-enterprise-ee
+
+cd $WORKSPACE_HOME/docker-rhodecode
+
+# First start with setting up a dev builds for dev images
+./rcstack cli set-runtime-image beta
+
+cd $WORKSPACE_HOME/docker-rhodecode
+
+# To start developing we need few services to run, we can run this using `dev-env`
+./dev-tools dev-env
+
+cd $WORKSPACE_HOME/docker-rhodecode
+
+# You can check the status of services by running
+./rcstack status
+
+# Copy the runtime.env as our dev.env:
+cp .custom/.runtime.env .custom/.dev.env
+
+cd $WORKSPACE_HOME/rhodecode-vcsserver
+mkdir -p .dev/
+echo "make sh" > .dev/dev-env.sh && chmod +x .dev/dev-env.sh
+
+cd $WORKSPACE_HOME/rhodecode-enterprise-ce
+mkdir -p .dev/
+echo "make sh" > .dev/dev-env.sh && chmod +x .dev/dev-env.sh
+
+cd $WORKSPACE_HOME/rhodecode-vcsserver && cp ../docker-rhodecode/config/_shared/vcsserver.ini .dev/dev.ini
+
+cd $WORKSPACE_HOME/rhodecode-enterprise-ce && cp ../docker-rhodecode/config/_shared/rhodecode.ini .dev/dev.ini

docs/source/index.rst

@@ -1,183 +1,184 b''
 Welcome to RhodeCode rcstack documentation!
 ===========================================
 
 
 =================
 RhodeCode rcstack
 =================
 
 RhodeCode rcstack is a multi-node highly-scalable setup to run RhodeCode services.
 It consists of all RhodeCode services required with additionally
 Edge Router(Traefik with optional SSL) and Metrics Stack (Prometheus, Loki, Grafana) in single environment using Docker.
 
 .. only:: html
 
    Latest Version
    --------------
 
    The latest version of rcstack is |release|.
 
 
 Overview
 --------
 
 To quickly get and install rcstack run this command
 
 .. code-block:: bash
 
     mkdir docker-rhodecode && cd docker-rhodecode
     curl -L -s -o rcstack https://dls.rhodecode.com/get-rcstack && chmod +x rcstack
     ./rcstack get-started
 
 
 Using a docker-compose this setup creates following services for RhodeCode:
 
 
 
 **Router (mandatory to run):**
 
 
 .. code-block:: bash
 
     ./rcstack router --help
 
 
 `Traefik <https://doc.traefik.io/traefik/>`_ aka Edge Router is responsible for handling all outgoing and incoming traffic to whole stack.
 It can do SSL termination, and handle SSL traffic with certificate management.
 
 Traefik listens to few defaults ports and
 handles all incoming/outgoing traffic to the stack
 
 - 80   (HTTP)
 - 443  (HTTPS)
 - 9022 (SSH for RhodeCode traffic)
 - 3100 (Loki log aggregation)
 
 
 **Services (mandatory to run):**
 
 .. code-block:: bash
 
     ./rcstack services --help
 
 
 - Database (defaults to PostgreSQL) Optionally can be replaced by MySQL, or own external database if needed.
 - Redis, acts as cache and queue exchange
 - ChannelStream - live websocket communications
 - Elasticsearch (full text search backend)
 - Nginx (static file service) proxy serving RhodeCode static files
 
 
 **RhodeCode (mandatory to run):**
 
 .. code-block:: bash
 
     ./rcstack rhodecode --help
 
 
 - RhodeCode CE/EE web app
 - VCSServer for GIT/SVN/HG support
 - SSH server for cloning over SSH
 - SVN webserver for SVN protocol support
 - Celery workers for asynchronous tasks
 - Celery beat for scheduler and automation tasks
 
 
 **Metrics (Optional)**
 
 .. code-block:: bash
 
     ./rcstack metrics --help
 
 - Loki, logs aggregation
 - Grafana, metrics Dashboard
 - Prometheus, metrics time-series
 - Statsd-exporter - statsd to Prometheus bridge
 - Node-exporter - machine stats and usage
 - Promtail - log scraping
 
 
 System Requirements
 -------------------
 
 Hardware
 ++++++++
 
 2 CPU cores and 2GB RAM is typically sufficient for small teams/projects.
 We recommend 2-4 CPU cores and 4-8GB of RAM to unlock full potential of all services running in the
 RhodeCode Stack.
 
 
 OS Support
 ++++++++++
 
 
 rcstack works on any linux distribution, and has a beta support for MacOS.
 There are two requirements for OS to be able to run whole rcstack.
 
 - Ability to run Docker daemon
 - Ability to run a certain standard unix tools like:
 
   - curl
   - tar
   - find
   - gzip
 
 
 
 .. toctree::
     :maxdepth: 1
     :hidden:
     :caption: Installation
 
     install/installation.rst
     install/upgrade.rst
 
 
 .. toctree::
     :maxdepth: 1
     :hidden:
     :caption: Configuration
 
     configuration/configuration-overview.rst
     configuration/configuration-of-components.rst
     configuration/scaling-rhodecode.rst
     configuration/enable-ssl-on-traefik.rst
     configuration/ssl-certificates.rst
     configuration/data-volumes.rst
     configuration/set-license-file.rst
     configuration/set-specific-install-version.rst
 
 
 .. toctree::
     :maxdepth: 1
     :hidden:
     :caption: Usage
 
     usage/monitoring-unhealthy-containers.rst
 
 
 .. toctree::
     :maxdepth: 1
     :hidden:
     :caption: Migration
 
     migration/migration-to-docker.rst
 
 
 .. toctree::
     :maxdepth: 1
     :hidden:
     :caption: Builds & Images
 
     builds/build-new-image.rst
     builds/building-images.rst
     dev/dev-setup.rst
+    dev/step-by-step-example.rst
 
 
 .. toctree::
     :maxdepth: 1
     :hidden:
     :caption: Changelog
 
     changes.rst
  No newline at end of file