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