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