engineering/unrhodecode
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: added SAML documentation.

Browse source 
- Remove few obsolete replaces
- update authentication docs
- cleanups and fixes
This commit is contained in:
Marcin Kuzminski 2018-11-30 07:37:45 +01:00
parent 909181f429
commit cbff54d3ed
72 changed files with 657 additions and 298 deletions
Download patch file Download diff file Expand all files Collapse all files

38
docs/install/install-database.rst
View file

@ -5,8 +5,24 @@ Supported Databases
.. important::
We do not recommend using SQLite in a production environment. It is
supported by |RCE| for evaluation purposes.
We do not recommend using SQLite in a production environment of more than 5 people.
It is not suited for higher usage and mayb cause problems.
|RCE| supports the following databases. The recommended encoding is UTF-8.
.. only:: latex
* :ref:`install-sqlite-database`
* :ref:`install-mysql-database`
* :ref:`install-postgresql-database`
.. toctree::
using-mysql
using-postgresql
using-sqllite
Database Overview
-----------------
@ -48,21 +64,3 @@ following example to configure the correct one.
# for the RCE instance you are installing
Database name: example-db-name-for-2xx # The 2xx version database
Database name: example-db-name-for-3xx # The 3xx version database
Supported Databases
-------------------
|RCM| supports the following databases. The recommended encoding is Unicode
UTF-8.
.. only:: latex
* :ref:`install-sqlite-database`
* :ref:`install-mysql-database`
* :ref:`install-postgresql-database`
.. toctree::
using-mysql
using-postgresql
using-sqllite

2
docs/install/install-steps.rst
View file

@ -4,7 +4,7 @@ Post Installation Tasks
=======================
The following tasks are the most common post installation requirements. Use
the information in these sections to configure your instance of |RCM|.
the information in these sections to configure your instance of |RCE|.
.. toctree::

12
docs/install/migrate-repos.rst
View file

@ -3,21 +3,21 @@
Migrating |repos|
-----------------
If you have installed |RCM| and have |repos| that you wish to migrate into
If you have installed |RCE| and have |repos| that you wish to migrate into
the system, use the following instructions.
1. On the |RCM| interface, check your |repo| storage location under
1. On the |RCE| interface, check your |repo| storage location under
:menuselection:`Admin --> Settings --> System Info`. For example,
Storage location: /home/{username}/repos.
2. Copy the |repos| that you want |RCM| to manage to this location.
2. Copy the |repos| that you want |RCE| to manage to this location.
3. Remap and rescan the |repos|, see :ref:`remap-rescan`
.. important::
Directories create |repo| groups inside |RCM|.
Directories create |repo| groups inside |RCE|.
Importing adds |RCM| git hooks to your |repos|.
Importing adds |RCE| git hooks to your |repos|.
You should verify if custom ``.hg`` or ``.hgrc`` files inside
repositories should be adjusted since |RCM| reads the content of them.
repositories should be adjusted since |RCE| reads the content of them.

5
docs/install/quick-start.rst
View file

@ -27,9 +27,12 @@ To get |RCE| up and running, run through the below steps:
.. code-block:: bash
$ chmod 755 RhodeCode-installer-linux-*
$ chmod +x RhodeCode-installer-linux-*
$ ./RhodeCode-installer-linux-*
Do you accept the RhodeCode Control license?
Press [Y] to accept license and [V] to view license text: y
3. Install a VCS Server, and configure it to start at boot.
.. code-block:: bash

4
docs/install/setup-email.rst
View file

@ -3,12 +3,12 @@
Set up Email
------------
To setup email with your |RCM| instance, open the default
To setup email with your |RCE| instance, open the default
:file:`/home/{user}/.rccontrol/{instance-id}/rhodecode.ini`
file and uncomment and configure the email section. If it is not there,
use the below example to insert it.
Once configured you can check the settings for your |RCM| instance on the
Once configured you can check the settings for your |RCE| instance on the
:menuselection:`Admin --> Settings --> Email` page.
.. code-block:: ini

6
docs/install/using-mysql.rst
View file

@ -4,15 +4,15 @@ MySQL or MariaDB
----------------
To use a MySQL or MariaDB database you should install and configure the
database before installing |RCM|. This is because during |RCM| installation
database before installing |RCE|. This is because during |RCE| installation
you will setup a connection to your MySQL or MariaDB database. To work with
either, use the following steps:
1. Depending on your |os|, install a MySQL or MariaDB database following the
appropriate instructions from the `MySQL website`_ or `MariaDB website`_.
2. Configure the database with a username and password which you will use
with |RCM|.
3. Install |RCM|, and during installation select MySQL as your database.
with |RCE|.
3. Install |RCE|, and during installation select MySQL as your database.
4. Enter the following information during the database setup:
* Your network IP Address

6
docs/install/using-postgresql.rst
View file

@ -4,15 +4,15 @@ PostgreSQL
----------
To use a PostgreSQL database, you should install and configure the database
before installing |RCV|. This is because during |RCV| installation you will
before installing |RCE|. This is because during |RCE| installation you will
setup the connection to your PostgreSQL database. To work with PostgreSQL,
use the following steps:
1. Depending on your |os|, install a PostgreSQL database following the
appropriate instructions from the `PostgreSQL website`_.
2. Configure the database with a username and password, which you will use
with |RCV|.
3. Install |RCV|, and during installation select PostgreSQL as your database.
with |RCE|.
3. Install |RCE|, and during installation select PostgreSQL as your database.
4. Enter the following information during the database setup:
* Your network IP Address

6
docs/install/using-sqllite.rst
View file

@ -9,15 +9,15 @@ SQLite
as it has an internal locking mechanism which can become a performance
bottleneck when there are more than 5 concurrent users.
|RCM| installs SQLite as the default database if you do not specify another
|RCE| installs SQLite as the default database if you do not specify another
during installation. SQLite is suitable for small teams,
projects with a low load, and evaluation purposes since it is built into
|RCM| and does not require any additional database server.
|RCE| and does not require any additional database server.
Using MySQL or PostgreSQL in an large setup gives you much greater
performance, and while migration tools exist to move from one database type
to another, it is better to get it right first time and to immediately use
MySQL or PostgreSQL when you deploy |RCM| in a production environment.
MySQL or PostgreSQL when you deploy |RCE| in a production environment.
Migrating From SQLite to PostgreSQL
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^