quick-start.rst
109 lines
| 3.1 KiB
| text/x-rst
|
RstLexer
Quick Start 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 Control Documentation <control:rcc>`
Tip
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:
- Download the latest |RCC| installer from your rhodecode.com profile or main page. If you don't have an account, sign up at rhodecode.com/register.
- Run the |RCC| installer and accept the End User Licence using the following example:
$ chmod 755 RhodeCode-installer-linux-* $ ./RhodeCode-installer-linux-*
- Install a VCS Server, and configure it to start at boot.
$ 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
- 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.
- Check the status of your installation. You |RCEE|/|RCCE| instance runs on the URL displayed in the status message.
$ rccontrol status - NAME: enterprise-1 - STATUS: RUNNING - TYPE: Enterprise - VERSION: 4.1.0 - URL: http://127.0.0.1:10003 - 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`
- Set up :ref:`indexing-ref`
- Familiarise yourself with the :ref:`rhodecode-admin-ref` section.