93 lines
3.6 KiB
ReStructuredText
93 lines
3.6 KiB
ReStructuredText
.. _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 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
|
|
|
|
|
|
|
|
.. note::
|
|
|
|
Recommended post quick start install instructions:
|
|
|
|
* Read the documentation
|
|
* Carry out the :ref:`rhodecode-post-install-ref`
|
|
* Set up :ref:`indexing-ref`
|
|
* Familiarise yourself with the :ref:`rhodecode-admin-ref` section.
|
|
|
|
.. _rhodecode.com: https://rhodecode.com/
|
|
.. _rhodecode.com/register: https://rhodecode.com/register/
|
|
.. _rhodecode.com/download: https://rhodecode.com/download/
|
|
|