##// END OF EJS Templates
docs: added some tips about root installation to quick-start guide.
marcink -
r4235:cd860dfe stable
parent child Browse files
Show More
@@ -1,113 +1,122 b''
1 1 .. _quick-start:
2 2
3 3 Quick Start Installation Guide
4 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 `rhodecode.com/download`_.
23 23 If you don't have an account, sign up at `rhodecode.com/register`_.
24 24
25 25 2. Run the |RCC| installer and accept the End User Licence using the
26 26 following example:
27 27
28 28 .. code-block:: bash
29 29
30 30 $ chmod +x RhodeCode-installer-linux-*
31 31 $ ./RhodeCode-installer-linux-*
32 32
33 33 Do you accept the RhodeCode Control license?
34 34 Press [Y] to accept license and [V] to view license text: y
35 35
36
37 .. important::
38
39 We recommend running RhodeCode as a non-root user, such as `rhodecode`;
40 this user must have a proper home directory.
41 Either log in as that user to install the software, or do it as root
42 with `sudo -i -u rhodecode ./RhodeCode-installer-linux-*`
43
44
36 45 3. Install a VCS Server, and configure it to start at boot.
37 46
38 47 .. code-block:: bash
39 48
40 49 $ rccontrol install VCSServer
41 50
42 51 Agree to the licence agreement? [y/N]: y
43 52 IP to start the server on [127.0.0.1]:
44 53 Port for the server to start [10005]:
45 54 Creating new instance: vcsserver-1
46 55 Installing RhodeCode VCSServer
47 56 Configuring RhodeCode VCS Server ...
48 57 Supervisord state is: RUNNING
49 58 Added process group vcsserver-1
50 59
51 60
52 61 4. Install |RCEE| or |RCCE|. If using MySQL or PostgreSQL, during
53 62 installation you'll be asked for your database credentials, so have them at hand.
54 63 Mysql or Postgres needs to be running and a new database needs to be created.
55 64 You don't need any credentials or to create a database for SQLite.
56 65
57 66 .. code-block:: bash
58 67 :emphasize-lines: 11-16
59 68
60 69 $ rccontrol install Community
61 70
62 71 or
63 72
64 73 $ rccontrol install Enterprise
65 74
66 75 Username [admin]: username
67 76 Password (min 6 chars):
68 77 Repeat for confirmation:
69 78 Email: your@mail.com
70 79 Respositories location [/home/brian/repos]:
71 80 IP to start the Enterprise server on [127.0.0.1]:
72 81 Port for the Enterprise server to use [10004]:
73 82 Database type - [s]qlite, [m]ysql, [p]ostresql:
74 83 PostgreSQL selected
75 84 Database host [127.0.0.1]:
76 85 Database port [5432]:
77 86 Database username: db-user-name
78 87 Database password: somepassword
79 88 Database name: example-db-name
80 89
81 90 5. Check the status of your installation. You |RCEE|/|RCCE| instance runs
82 91 on the URL displayed in the status message.
83 92
84 93 .. code-block:: bash
85 94
86 95 $ rccontrol status
87 96
88 97 - NAME: enterprise-1
89 98 - STATUS: RUNNING
90 99 - TYPE: Enterprise
91 100 - VERSION: 4.1.0
92 101 - URL: http://127.0.0.1:10003
93 102
94 103 - NAME: vcsserver-1
95 104 - STATUS: RUNNING
96 105 - TYPE: VCSServer
97 106 - VERSION: 4.1.0
98 107 - URL: http://127.0.0.1:10001
99 108
100 109 .. note::
101 110
102 111 Recommended post quick start install instructions:
103 112
104 113 * Read the documentation
105 114 * Carry out the :ref:`rhodecode-post-instal-ref`
106 115 * Set up :ref:`indexing-ref`
107 116 * Familiarise yourself with the :ref:`rhodecode-admin-ref` section.
108 117
109 118 .. _rhodecode.com/download/: https://rhodecode.com/download/
110 119 .. _rhodecode.com: https://rhodecode.com/
111 120 .. _rhodecode.com/register: https://rhodecode.com/register/
112 121 .. _rhodecode.com/download: https://rhodecode.com/download/
113 122
General Comments 0
You need to be logged in to leave comments. Login now