##// END OF EJS Templates
docs: updated some installation instructions
marcink -
r144:e4b1972a default
parent child Browse files
Show More
@@ -1,32 +1,34 b''
1 # Try and keep this list alphabetical
1 # Try and keep this list alphabetical
2 # ui is for user interface elements and messages
2 # ui is for user interface elements and messages
3 # button - that's obvious
3 # button - that's obvious
4
4
5 rst_epilog = '''
5 rst_epilog = '''
6 .. |AE| replace:: Appenlight
6 .. |AE| replace:: Appenlight
7 .. |authtoken| replace:: Authentication Token
7 .. |authtoken| replace:: Authentication Token
8 .. |authtokens| replace:: **Auth Tokens**
8 .. |authtokens| replace:: **Auth Tokens**
9 .. |git| replace:: Git
9 .. |git| replace:: Git
10 .. |hg| replace:: Mercurial
10 .. |hg| replace:: Mercurial
11 .. |svn| replace:: Subversion
11 .. |svn| replace:: Subversion
12 .. |LDAP| replace:: LDAP / Active Directory
12 .. |LDAP| replace:: LDAP / Active Directory
13 .. |os| replace:: operating system
13 .. |os| replace:: operating system
14 .. |OS| replace:: Operating System
14 .. |OS| replace:: Operating System
15 .. |PY| replace:: Python
15 .. |PY| replace:: Python
16 .. |pr| replace:: pull request
16 .. |pr| replace:: pull request
17 .. |prs| replace:: pull requests
17 .. |prs| replace:: pull requests
18 .. |psf| replace:: Python Software Foundation
18 .. |psf| replace:: Python Software Foundation
19 .. |repo| replace:: repository
19 .. |repo| replace:: repository
20 .. |repos| replace:: repositories
20 .. |repos| replace:: repositories
21 .. |RCI| replace:: RhodeCode Control
21 .. |RCI| replace:: RhodeCode Control
22 .. |RCC| replace:: RhodeCode Control
22 .. |RCC| replace:: RhodeCode Control
23 .. |RCV| replace:: RhodeCode Enterprise
23 .. |RCV| replace:: RhodeCode Enterprise
24 .. |RCM| replace:: RhodeCode Enterprise
24 .. |RCM| replace:: RhodeCode Enterprise
25 .. |RCE| replace:: RhodeCode Enterprise
25 .. |RCE| replace:: RhodeCode Enterprise
26 .. |RCCE| replace:: RhodeCode Enterprise
27 .. |RCEE| replace:: RhodeCode Community
26 .. |RCX| replace:: RhodeCode Extensions
28 .. |RCX| replace:: RhodeCode Extensions
27 .. |RCT| replace:: RhodeCode Tools
29 .. |RCT| replace:: RhodeCode Tools
28 .. |RCEBOLD| replace:: **RhodeCode Enterprise**
30 .. |RCEBOLD| replace:: **RhodeCode Enterprise**
29 .. |RCEITALICS| replace:: `RhodeCode Enterprise`
31 .. |RCEITALICS| replace:: `RhodeCode Enterprise`
30 .. |RC| replace:: RhodeCode
32 .. |RC| replace:: RhodeCode
31 .. |RNS| replace:: Release Notes
33 .. |RNS| replace:: Release Notes
32 '''
34 '''
@@ -1,38 +1,38 b''
1 .. _config-database:
1 .. _config-database:
2
2
3 Make Database Changes
3 Make Database Changes
4 ---------------------
4 ---------------------
5
5
6 .. important::
6 .. important::
7
7
8 If you do change the |repo| database that |RCM| uses, then you will need to
8 If you do change the |repo| database that |RCEE| uses, then you will need to
9 upgrade the database, and also remap and rescan the |repos|. More detailed
9 upgrade the database, and also remap and rescan the |repos|. More detailed
10 information is available in the
10 information is available in the
11 :ref:`Alternative upgrade documentation <control:install-port>`.
11 :ref:`Alternative upgrade documentation <control:install-port>`.
12
12
13 If you need to change database connection details for a |RCM| instance,
13 If you need to change database connection details for a |RCEE| instance,
14 use the following steps:
14 use the following steps:
15
15
16 1. Open the :file:`rhodecode.ini` file for the instance you wish to edit. The
16 1. Open the :file:`rhodecode.ini` file for the instance you wish to edit. The
17 default location is
17 default location is
18 :file:`home/{user}/.rccontrol/{instance-id}/rhodecode.ini`
18 :file:`home/{user}/.rccontrol/{instance-id}/rhodecode.ini`
19 2. When you open the file, find the database configuration section,
19 2. When you open the file, find the database configuration section,
20 and use the below example to change the
20 and use the below example to change the
21 connection details:
21 connection details:
22
22
23 .. code-block:: ini
23 .. code-block:: ini
24
24
25 #########################################################
25 #########################################################
26 ### DB CONFIGS - EACH DB WILL HAVE IT'S OWN CONFIG ###
26 ### DB CONFIGS - EACH DB WILL HAVE IT'S OWN CONFIG ###
27 #########################################################
27 #########################################################
28
28
29 # Default SQLite config
29 # Default SQLite config
30 sqlalchemy.db1.url = sqlite:////home/brian/.rccontrol/enterprise-1/rhodecode.db
30 sqlalchemy.db1.url = sqlite:////home/brian/.rccontrol/enterprise-1/rhodecode.db
31
31
32 # Use this example for a PostgreSQL
32 # Use this example for a PostgreSQL
33 sqlalchemy.db1.url = postgresql://postgres:qwe@localhost/rhodecode
33 sqlalchemy.db1.url = postgresql://postgres:qwe@localhost/rhodecode
34
34
35 # see sqlalchemy docs for other advanced settings
35 # see sqlalchemy docs for other advanced settings
36 sqlalchemy.db1.echo = false
36 sqlalchemy.db1.echo = false
37 sqlalchemy.db1.pool_recycle = 3600
37 sqlalchemy.db1.pool_recycle = 3600
38 sqlalchemy.db1.convert_unicode = true
38 sqlalchemy.db1.convert_unicode = true
@@ -1,102 +1,109 b''
1 .. _quick-start:
1 .. _quick-start:
2
2
3 Quick Start Guide
3 Quick Start 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 |RCM| 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 your `rhodecode.com`_ profile
22 1. Download the latest |RCC| installer from your `rhodecode.com`_ profile
23 page. If you don't have an account, sign up at `rhodecode.com/register`_.
23 or main page.
24 If you don't have an account, sign up at `rhodecode.com/register`_.
25
24 2. Run the |RCC| installer and accept the End User Licence using the
26 2. Run the |RCC| installer and accept the End User Licence using the
25 following example:
27 following example:
26
28
27 .. code-block:: bash
29 .. code-block:: bash
28
30
29 $ chmod 755 RhodeCode-installer-linux-*
31 $ chmod 755 RhodeCode-installer-linux-*
30 $ ./RhodeCode-installer-linux-*
32 $ ./RhodeCode-installer-linux-*
31
33
32 3. Install a VCS Server, and configure it to start at boot.
34 3. Install a VCS Server, and configure it to start at boot.
33
35
34 .. code-block:: bash
36 .. code-block:: bash
35
37
36 $ rccontrol install VCSServer
38 $ rccontrol install VCSServer
37
39
38 Agree to the licence agreement? [y/N]: y
40 Agree to the licence agreement? [y/N]: y
39 IP to start the server on [127.0.0.1]:
41 IP to start the server on [127.0.0.1]:
40 Port for the server to start [10005]:
42 Port for the server to start [10005]:
41 Creating new instance: vcsserver-1
43 Creating new instance: vcsserver-1
42 Installing RhodeCode VCSServer
44 Installing RhodeCode VCSServer
43 Configuring RhodeCode VCS Server ...
45 Configuring RhodeCode VCS Server ...
44 Supervisord state is: RUNNING
46 Supervisord state is: RUNNING
45 Added process group vcsserver-1
47 Added process group vcsserver-1
46
48
47
49
48 4. Install |RCE|. If using MySQL or PostgreSQL, during installation you'll be
50 4. Install |RCEE| or |RCCE|. If using MySQL or PostgreSQL, during
49 asked for your database credentials, so have them at hand. You don't need
51 installation you'll be asked for your database credentials, so have them at hand.
50 any for SQLite.
52 Mysql or Postgres needs to be running and a new database needs to be created.
53 You don't need any credentials or to create a database for SQLite.
51
54
52 .. code-block:: bash
55 .. code-block:: bash
53 :emphasize-lines: 11-16
56 :emphasize-lines: 11-16
54
57
58 $ rccontrol install Community
59
60 or
61
55 $ rccontrol install Enterprise
62 $ rccontrol install Enterprise
56
63
57 Username [admin]: username
64 Username [admin]: username
58 Password (min 6 chars):
65 Password (min 6 chars):
59 Repeat for confirmation:
66 Repeat for confirmation:
60 Email: your@mail.com
67 Email: your@mail.com
61 Respositories location [/home/brian/repos]:
68 Respositories location [/home/brian/repos]:
62 IP to start the Enterprise server on [127.0.0.1]:
69 IP to start the Enterprise server on [127.0.0.1]:
63 Port for the Enterprise server to use [10004]:
70 Port for the Enterprise server to use [10004]:
64 Database type - [s]qlite, [m]ysql, [p]ostresql:
71 Database type - [s]qlite, [m]ysql, [p]ostresql:
65 PostgreSQL selected
72 PostgreSQL selected
66 Database host [127.0.0.1]:
73 Database host [127.0.0.1]:
67 Database port [5432]:
74 Database port [5432]:
68 Database username: db-user-name
75 Database username: db-user-name
69 Database password: somepassword
76 Database password: somepassword
70 Database name: example-db-name
77 Database name: example-db-name
71
78
72 5. Check the status of your installation. You |RCE| instance runs on the URL
79 5. Check the status of your installation. You |RCEE|/|RCCE| instance runs
73 displayed in the status message.
80 on the URL displayed in the status message.
74
81
75 .. code-block:: bash
82 .. code-block:: bash
76
83
77 $ rccontrol status
84 $ rccontrol status
78
85
79 - NAME: enterprise-1
86 - NAME: enterprise-1
80 - STATUS: RUNNING
87 - STATUS: RUNNING
81 - TYPE: Enterprise
88 - TYPE: Enterprise
82 - VERSION: 3.3.0
89 - VERSION: 4.1.0
83 - URL: http://127.0.0.1:10003
90 - URL: http://127.0.0.1:10003
84
91
85 - NAME: vcsserver-1
92 - NAME: vcsserver-1
86 - STATUS: RUNNING
93 - STATUS: RUNNING
87 - TYPE: VCSServer
94 - TYPE: VCSServer
88 - VERSION: 3.3.0
95 - VERSION: 4.1.0
89 - URL: http://127.0.0.1:10001
96 - URL: http://127.0.0.1:10001
90
97
91 .. note::
98 .. note::
92
99
93 Recommended post quick start install instructions:
100 Recommended post quick start install instructions:
94
101
95 * Read the documentation
102 * Read the documentation
96 * Carry out the :ref:`rhodecode-post-instal-ref`
103 * Carry out the :ref:`rhodecode-post-instal-ref`
97 * Set up :ref:`indexing-ref`
104 * Set up :ref:`indexing-ref`
98 * Familiarise yourself with the :ref:`rhodecode-admin-ref` section.
105 * Familiarise yourself with the :ref:`rhodecode-admin-ref` section.
99
106
100 .. _rhodecode.com/download/: https://rhodecode.com/download/
107 .. _rhodecode.com/download/: https://rhodecode.com/download/
101 .. _rhodecode.com: https://rhodecode.com/
108 .. _rhodecode.com: https://rhodecode.com/
102 .. _rhodecode.com/register: https://rhodecode.com/register/
109 .. _rhodecode.com/register: https://rhodecode.com/register/
General Comments 0
You need to be logged in to leave comments. Login now