Show More
@@ -0,0 +1,36 b'' | |||||
|
1 | .. _custom-database-use: | |||
|
2 | ||||
|
3 | Custom Database usage | |||
|
4 | --------------------- | |||
|
5 | ||||
|
6 | .. important:: | |||
|
7 | ||||
|
8 | If you do change the default database that |RCS| uses, then you will need to | |||
|
9 | manage and upgrade the database by yourself. |RCS| cannot perform normal operations based on an external database. | |||
|
10 | ||||
|
11 | If you need to change database connection details for a |RCEE| instance, | |||
|
12 | use the following steps: | |||
|
13 | ||||
|
14 | 1. Open the :file:`rhodecode.ini` file for the instance you wish to edit. The | |||
|
15 | default location is | |||
|
16 | :file:`config/_shared/rhodecode.ini` | |||
|
17 | ||||
|
18 | 2. When you open the file, find the database configuration section, | |||
|
19 | and use the below example to change the | |||
|
20 | connection details: | |||
|
21 | ||||
|
22 | .. code-block:: ini | |||
|
23 | ||||
|
24 | ######################################################### | |||
|
25 | ### DB CONFIGS - EACH DB WILL HAVE IT'S OWN CONFIG ### | |||
|
26 | ######################################################### | |||
|
27 | ||||
|
28 | # Default SQLite config | |||
|
29 | sqlalchemy.db1.url = sqlite:////home/brian/.rccontrol/enterprise-1/rhodecode.db | |||
|
30 | ||||
|
31 | # Use this example for a PostgreSQL | |||
|
32 | sqlalchemy.db1.url = postgresql://postgres:qwe@localhost/rhodecode | |||
|
33 | ||||
|
34 | # see sqlalchemy docs for other advanced settings | |||
|
35 | sqlalchemy.db1.echo = false | |||
|
36 | sqlalchemy.db1.pool_recycle = 3600 |
@@ -0,0 +1,12 b'' | |||||
|
1 | .. _install-advanced: | |||
|
2 | ||||
|
3 | ||||
|
4 | Advanced Installation | |||
|
5 | --------------------- | |||
|
6 | ||||
|
7 | ||||
|
8 | .. tip:: | |||
|
9 | ||||
|
10 | If using a non-SQLite database, install and configure the database, create | |||
|
11 | a new user, and grant permissions. | |||
|
12 |
@@ -0,0 +1,9 b'' | |||||
|
1 | .. _rollback-an-upgrade: | |||
|
2 | ||||
|
3 | ||||
|
4 | Rollback to previous version | |||
|
5 | ============================ | |||
|
6 | ||||
|
7 | ||||
|
8 | Sometimes it might happen that thereβs a need to rollback an performed upgrade of your installed instances. | |||
|
9 |
@@ -73,6 +73,7 b" rst_epilog = '''" | |||||
73 | .. |authtoken| replace:: Authentication Token |
|
73 | .. |authtoken| replace:: Authentication Token | |
74 | .. |authtokens| replace:: **Auth Tokens** |
|
74 | .. |authtokens| replace:: **Auth Tokens** | |
75 | .. |RCC| replace:: RhodeCode Control |
|
75 | .. |RCC| replace:: RhodeCode Control | |
|
76 | .. |RCS| replace:: RhodeCode rcstack | |||
76 | .. |RCE| replace:: RhodeCode Enterprise |
|
77 | .. |RCE| replace:: RhodeCode Enterprise | |
77 | .. |RCCE| replace:: RhodeCode Community |
|
78 | .. |RCCE| replace:: RhodeCode Community | |
78 | .. |RCEE| replace:: RhodeCode Enterprise |
|
79 | .. |RCEE| replace:: RhodeCode Enterprise |
@@ -132,6 +132,9 b' There are two requirements for OS to be able to run whole rcstack.' | |||||
132 |
|
132 | |||
133 | install/installation.rst |
|
133 | install/installation.rst | |
134 | install/upgrade.rst |
|
134 | install/upgrade.rst | |
|
135 | install/rollback-an-upgrade.rst | |||
|
136 | install/custom-database-use.rst | |||
|
137 | install/install-advanced.rst | |||
135 |
|
138 | |||
136 |
|
139 | |||
137 | .. toctree:: |
|
140 | .. toctree:: |
@@ -39,6 +39,7 b' rcstack is using the below command to install docker, if you prefer to install i' | |||||
39 | curl https://get.docker.com/ | sh |
|
39 | curl https://get.docker.com/ | sh | |
40 |
|
40 | |||
41 |
|
41 | |||
|
42 | .. _quick_installation: | |||
42 |
|
43 | |||
43 | Quick install tutorial |
|
44 | Quick install tutorial | |
44 | ---------------------- |
|
45 | ---------------------- | |
@@ -47,6 +48,14 b' Those are step-by-step installation/run steps.' | |||||
47 |
|
48 | |||
48 | 1. **initialize; create configurations / docker definitions** |
|
49 | 1. **initialize; create configurations / docker definitions** | |
49 |
|
50 | |||
|
51 | .. note:: | |||
|
52 | ||||
|
53 | IMPORTANT: A valid domain needs to be set during bootstrap. This is stored inside :file:`.custom/.runtime.env` file. | |||
|
54 | To access the RhodeCode stack running the domain needs to be entered in the browser. | |||
|
55 | This can be a local domain entry or real domain, e.g rhodecode.local or rhodecode.yourcompany.com (pointing to the machine IP) | |||
|
56 | In case your browser can't resolve the given domain, a 404 page will be shown, and rcstack won't router traffic into instances. | |||
|
57 | ||||
|
58 | ||||
50 | Run the following command |
|
59 | Run the following command | |
51 |
|
60 | |||
52 | .. code-block:: bash |
|
61 | .. code-block:: bash | |
@@ -61,14 +70,8 b' Few adjustments that could be done are for example to change the domain address,' | |||||
61 |
|
70 | |||
62 | 2. **Start router to handle all incoming traffic** |
|
71 | 2. **Start router to handle all incoming traffic** | |
63 |
|
72 | |||
64 | Start Traefik router that would handle all incoming traffic, load balance. |
|
73 | Start Traefik router that would handle all incoming traffic, and load balance it to various components. | |
65 |
|
||||
66 | .. note:: |
|
|||
67 |
|
74 | |||
68 | IMPORTANT: A valid domain needs to be set during bootstrap. This is stored inside .custom/.runtime.env file. |
|
|||
69 | To access the RhodeCode stack running the domain needs to be entered in the browser. |
|
|||
70 | This can be a local entry or real domain, e.g rhodecode.local or rhodecode.yourcompany.com (pointing to the machine IP) |
|
|||
71 | In case machine can't resolve the domain, a 404 page will be shown |
|
|||
72 |
|
75 | |||
73 | .. note:: |
|
76 | .. note:: | |
74 |
|
77 | |||
@@ -93,7 +96,7 b' Run the router stack in the background' | |||||
93 | .. note:: |
|
96 | .. note:: | |
94 |
|
97 | |||
95 | By default RhodeCode stack is configured to run PostgreSQL database inside docker. If you need to run mysql, or external |
|
98 | By default RhodeCode stack is configured to run PostgreSQL database inside docker. If you need to run mysql, or external | |
96 |
database, please disable the database inside services stack. : |
|
99 | database, please disable the database inside services stack. :ref:`custom-database-use` | |
97 |
|
100 | |||
98 |
|
101 | |||
99 | 4. **Start other services required** |
|
102 | 4. **Start other services required** |
General Comments 0
You need to be logged in to leave comments.
Login now