##// END OF EJS Templates
docs: more explicit naming of quick start guide
lisaq -
r468:d09d1859 default
parent child Browse files
Show More
@@ -1,109 +1,109 b''
1 1 .. _quick-start:
2 2
3 Quick Start Guide
4 =================
3 Quick Start Installation Guide
4 ==============================
5 5
6 6 .. important::
7 7
8 8 These are quick start instructions. To optimize your |RCE|,
9 9 |RCC|, and |RCT| usage, read the more detailed instructions in our guides.
10 10 For detailed installation instructions, see
11 11 :ref:`RhodeCode Control Documentation <control:rcc>`
12 12
13 13 .. tip::
14 14
15 15 If using a non-SQLite database, install and configure the database, create
16 16 a new user, and grant permissions. You will be prompted for this user's
17 17 credentials during |RCE| installation. See the relevant database
18 18 documentation for more details.
19 19
20 20 To get |RCE| up and running, run through the below steps:
21 21
22 22 1. Download the latest |RCC| installer from your `rhodecode.com`_ profile
23 23 or main page.
24 24 If you don't have an account, sign up at `rhodecode.com/register`_.
25 25
26 26 2. Run the |RCC| installer and accept the End User Licence using the
27 27 following example:
28 28
29 29 .. code-block:: bash
30 30
31 31 $ chmod 755 RhodeCode-installer-linux-*
32 32 $ ./RhodeCode-installer-linux-*
33 33
34 34 3. Install a VCS Server, and configure it to start at boot.
35 35
36 36 .. code-block:: bash
37 37
38 38 $ rccontrol install VCSServer
39 39
40 40 Agree to the licence agreement? [y/N]: y
41 41 IP to start the server on [127.0.0.1]:
42 42 Port for the server to start [10005]:
43 43 Creating new instance: vcsserver-1
44 44 Installing RhodeCode VCSServer
45 45 Configuring RhodeCode VCS Server ...
46 46 Supervisord state is: RUNNING
47 47 Added process group vcsserver-1
48 48
49 49
50 50 4. Install |RCEE| or |RCCE|. If using MySQL or PostgreSQL, during
51 51 installation you'll be asked for your database credentials, so have them at hand.
52 52 Mysql or Postgres needs to be running and a new database needs to be created.
53 53 You don't need any credentials or to create a database for SQLite.
54 54
55 55 .. code-block:: bash
56 56 :emphasize-lines: 11-16
57 57
58 58 $ rccontrol install Community
59 59
60 60 or
61 61
62 62 $ rccontrol install Enterprise
63 63
64 64 Username [admin]: username
65 65 Password (min 6 chars):
66 66 Repeat for confirmation:
67 67 Email: your@mail.com
68 68 Respositories location [/home/brian/repos]:
69 69 IP to start the Enterprise server on [127.0.0.1]:
70 70 Port for the Enterprise server to use [10004]:
71 71 Database type - [s]qlite, [m]ysql, [p]ostresql:
72 72 PostgreSQL selected
73 73 Database host [127.0.0.1]:
74 74 Database port [5432]:
75 75 Database username: db-user-name
76 76 Database password: somepassword
77 77 Database name: example-db-name
78 78
79 79 5. Check the status of your installation. You |RCEE|/|RCCE| instance runs
80 80 on the URL displayed in the status message.
81 81
82 82 .. code-block:: bash
83 83
84 84 $ rccontrol status
85 85
86 86 - NAME: enterprise-1
87 87 - STATUS: RUNNING
88 88 - TYPE: Enterprise
89 89 - VERSION: 4.1.0
90 90 - URL: http://127.0.0.1:10003
91 91
92 92 - NAME: vcsserver-1
93 93 - STATUS: RUNNING
94 94 - TYPE: VCSServer
95 95 - VERSION: 4.1.0
96 96 - URL: http://127.0.0.1:10001
97 97
98 98 .. note::
99 99
100 100 Recommended post quick start install instructions:
101 101
102 102 * Read the documentation
103 103 * Carry out the :ref:`rhodecode-post-instal-ref`
104 104 * Set up :ref:`indexing-ref`
105 105 * Familiarise yourself with the :ref:`rhodecode-admin-ref` section.
106 106
107 107 .. _rhodecode.com/download/: https://rhodecode.com/download/
108 108 .. _rhodecode.com: https://rhodecode.com/
109 109 .. _rhodecode.com/register: https://rhodecode.com/register/
General Comments 0
You need to be logged in to leave comments. Login now