##// END OF EJS Templates
docs: back to main page link, link to rcstack docs higher, small fixes
andverb -
r5501:03cb7a12 default
parent child Browse files
Show More
@@ -1,92 +1,98 b''
1 1 |RCE|
2 2 =====
3 3
4 4 |RCE| is a high-performance source code management and collaboration system.
5 5 It enables you to develop projects securely behind the firewall while
6 6 providing collaboration tools that work with |git|, |hg|,
7 7 and |svn| |repos|. The user interface allows you to create, edit,
8 8 and commit files and |repos| while managing their security permissions.
9 9
10 10 |RCE| provides the following features:
11 11
12 12 * Source code management.
13 13 * Extended permissions management.
14 14 * Integrated code collaboration tools.
15 15 * Integrated code review and notifications.
16 16 * Scalability provided by multi-node setup.
17 17 * Fully programmable automation API.
18 18 * Web-based hook management.
19 19 * Native |svn| support.
20 20 * Migration from existing databases.
21 21 * |RCE| SDK.
22 22 * Built-in analytics
23 23 * Built in integrations including: Slack, Webhooks (used for Jenkins/TeamCity and other CIs), Jira, Redmine, Hipchat
24 24 * Pluggable authentication system.
25 25 * Support for AD, |LDAP|, Crowd, CAS, PAM.
26 26 * Support for external authentication via Oauth Google, Github, Bitbucket, Twitter.
27 27 * Debug modes of operation.
28 28 * Private and public gists.
29 29 * Gists with limited lifetimes and within instance only sharing.
30 30 * Fully integrated code search function.
31 31 * Always on SSL connectivity.
32 32
33 33 .. only:: html
34 34
35 35 Table of Contents
36 36 -----------------
37 37
38 38 .. toctree::
39 39 :maxdepth: 1
40 :caption: Documentation directory
41
42 Back to documentation directory <https://docs.rhodecode.com/>
43
44 .. toctree::
45 :maxdepth: 1
46 :caption: RhodeCode RCstack Documentation
47
48 RhodeCode RCstack Installer <https://docs.rhodecode.com/rcstack/>
49
50 .. toctree::
51 :maxdepth: 1
40 52 :caption: Admin Documentation
41 53
42 54 install/quick-start
43 55 install/install-database
44 56 install/install-steps
45 57 admin/system-overview
46 58 admin/system-admin
47 59 admin/user-admin
48 60 admin/repo-admin
49 61 admin/security-tips
50 62 auth/auth
51 63 issue-trackers/issue-trackers
52 64 admin/lab-settings
53 65
54 66 .. toctree::
55 67 :maxdepth: 1
56 68 :caption: Feature Documentation
57 69
58 70 collaboration/collaboration
59 71 collaboration/review-notifications
60 72 collaboration/pull-requests
61 73 code-review/code-review
62 74 integrations/integrations
63 75
64 76 .. toctree::
65 77 :maxdepth: 1
66 78 :caption: User Documentation
67 79
68 80 usage/basic-usage
69 81 tutorials/tutorials
70 82
71 83 .. toctree::
72 84 :maxdepth: 1
73 85 :caption: Developer Documentation
74 86
75 87 api/api
76 88 tools/rhodecode-tools
77 89 extensions/extensions-hooks
78 90 contributing/contributing
79 91
80 92 .. toctree::
81 :maxdepth: 2
82 :caption: RhodeCode RCstack Documentation
83
84 RhodeCode RCstack Installer <https://docs.rhodecode.com/rcstack/>
85
86 .. toctree::
87 93 :maxdepth: 1
88 94 :caption: About
89 95
90 96 known-issues/known-issues
91 97 release-notes/release-notes
92 98 admin/glossary
@@ -1,24 +1,24 b''
1 1 .. _quick-start:
2 2
3 3 Quick Start Installation Guide
4 4 ==============================
5 5
6 6 Since version 5.0.0 Rhodecode runs in Docker, and to get |RCE| up and running,
7 you need to use RCstack installer - https://docs.rhodecode.com/rcstack/install/installation.html/
7 you need to use RCstack installer - https://docs.rhodecode.com/rcstack/install/installation.html
8 8
9 9 Please follow RCstack documentation steps to set up your |RCE| installation.
10 10
11 11
12 12 .. note::
13 13
14 14 Recommended post quick start install instructions:
15 15
16 16 * Read the documentation
17 17 * Carry out the :ref:`rhodecode-post-instal-ref`
18 18 * Set up :ref:`indexing-ref`
19 19 * Familiarise yourself with the :ref:`rhodecode-admin-ref` section.
20 20
21 21 .. _rhodecode.com: https://rhodecode.com/
22 22 .. _rhodecode.com/register: https://rhodecode.com/register/
23 23 .. _rhodecode.com/download: https://rhodecode.com/download/
24 24
@@ -1,32 +1,21 b''
1 1 .. _install-sqlite-database:
2 2
3 SQLite
4 ------
3 SQLite (Deprecated)
4 -------------------
5 5
6 6 .. important::
7 7
8 We do not recommend using SQLite in a large development environment
9 as it has an internal locking mechanism which can become a performance
10 bottleneck when there are more than 5 concurrent users.
8 As of 5.x, SQLite is no longer supported, we advise to migrate to MySQL or PostgreSQL.
11 9
12 |RCE| installs SQLite as the default database if you do not specify another
13 during installation. SQLite is suitable for small teams,
14 projects with a low load, and evaluation purposes since it is built into
15 |RCE| and does not require any additional database server.
16
17 Using MySQL or PostgreSQL in an large setup gives you much greater
18 performance, and while migration tools exist to move from one database type
19 to another, it is better to get it right first time and to immediately use
20 MySQL or PostgreSQL when you deploy |RCE| in a production environment.
21 10
22 11 Migrating From SQLite to PostgreSQL
23 12 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
24 13
25 14 If you started working with SQLite and now need to migrate your database
26 15 to PostgreSQL, you can contact support@rhodecode.com for some help. We have a
27 16 set of scripts that enable SQLite to PostgreSQL migration. These scripts have
28 17 been tested, and work with PostgreSQL 9.1+.
29 18
30 19 .. note::
31 20
32 21 There are no SQLite to MySQL or MariaDB scripts available.
General Comments 0
You need to be logged in to leave comments. Login now