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

8
docs/admin/adding-anonymous-user.rst
View file

@ -3,19 +3,19 @@
Anonymous Users
---------------
By default, |RCM| provides |repo| access for registered users only. It can be
By default, |RCE| provides |repo| access for registered users only. It can be
configured to be **world-open** in terms of read and write permissions. This
configuration is called "Anonymous Access" and allows |RCM| to be used as a
configuration is called "Anonymous Access" and allows |RCE| to be used as a
public hub where unregistered users have access to your |repos|.
Anonymous access is useful for open source projects, universities,
or if running inside a restricted internal corporate network to serve
documents to all employees. Anonymous users get the default user permission
settings that are applied across the whole |RCM| system.
settings that are applied across the whole |RCE| system.
To enable anonymous access to your |repos|, use the following steps:
1. From the |RCM| interface, select :menuselection:`Admin --> Permissions`.
1. From the |RCE| interface, select :menuselection:`Admin --> Permissions`.
2. On the Application tab, check the :guilabel:`Allow anonymous access` box.
3. Select :guilabel:`Save`.
4. To set the anonymous user access permissions, which are based on the

2
docs/admin/admin-tricks.rst
View file

@ -166,7 +166,7 @@ To add custom hooks to your instance, use the following steps:
``pretxnchangegroup.example`` with value ``python:/path/to/custom_hook.py:my_func_name``
3. Select :guilabel:`Save`
Also, see the |RC| Extensions section of the :ref:`rc-tools` guide. |RC|
Also, see the RhodeCode Extensions section of the :ref:`rc-tools` guide. RhodeCode
Extensions can be used to add additional hooks to your instance and comes
with a number of pre-built plugins if you chose to install them.

4
docs/admin/apache-wsgi-coding.rst
View file

@ -3,7 +3,7 @@
Apache WSGI Configuration
^^^^^^^^^^^^^^^^^^^^^^^^^
|RCM| can also be set up with Apache under ``mod_wsgi``. To configure this
|RCE| can also be set up with Apache under ``mod_wsgi``. To configure this
use the following steps.
1. Install ``mod_wsgi`` using the following command:
@ -50,6 +50,6 @@ The following is an example ``wsgi`` dispatch script.
.. note::
When using `mod_wsgi` the same version of |hg| must be running in your
system's |PY| environment and on |RCM|. To check the |RCM| version,
system's |PY| environment and on |RCE|. To check the |RCE| version,
on the interface go to
:menuselection:`Admin --> Settings --> System Info`

2
docs/admin/config-files-overview.rst
View file

@ -67,7 +67,7 @@ sections.
Default location: :file:`/home/{user}/.rccontrol/cache/MANIFEST`
|RCC| uses this file to source the latest available builds from the
secure |RC| download channels. The only reason to mess with this file
secure RhodeCode download channels. The only reason to mess with this file
is if you need to do an offline installation,
see the :ref:`Offline Installation<control:offline-installer-ref>`
instructions, otherwise |RCC| will completely manage this file.

2
docs/admin/glossary.rst
View file

@ -33,7 +33,7 @@ Glossary
Adding more machines or workers into your pool of resources.
Instance
A single installed version of one of the |RC| products. It could
A single installed version of one of the RhodeCode products. It could
refer to |RCE| or the VCS server depending on the context.
Plugin

6
docs/admin/indexing.rst
View file

@ -3,7 +3,7 @@
Full-text Search
----------------
By default |RC| is configured to use `Whoosh`_ to index |repos| and
By default RhodeCode is configured to use `Whoosh`_ to index |repos| and
provide full-text search.
|RCE| also provides support for `Elasticsearch`_ as a backend for scalable
@ -46,7 +46,7 @@ Configure the ``.rhoderc`` File
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|RCT| uses the :file:`/home/{user}/.rhoderc` file for connection details
to |RCM| instances. If this file is not automatically created,
to |RCE| instances. If this file is not automatically created,
you can configure it using the following example. You need to configure the
details for each instance you want to index.
@ -62,7 +62,7 @@ details for each instance you want to index.
- VERSION: 1.5.0
- URL: http://127.0.0.1:10000
To get your API Token, on the |RCM| interface go to
To get your API Token, on the |RCE| interface go to
:menuselection:`username --> My Account --> Auth tokens`
.. code-block:: ini

2
docs/admin/public-access.rst
View file

@ -3,7 +3,7 @@
Public Access
-------------
By default |RCM| allows users to read all **public** |repos|. User
By default |RCE| allows users to read all **public** |repos|. User
permissions and |repo| access can be configured explicitly,
and those permissions will override any default settings. The default
settings can be found under the following section:

10
docs/admin/setting-default-permissions.rst
View file

@ -3,7 +3,7 @@
Setting Default Permissions
---------------------------
Default permissions allow you to configure |RCM| so that when a new |repo|, user group,
Default permissions allow you to configure |RCE| so that when a new |repo|, user group,
or user is created their permissions are already defined. To set default permissions you need administrator
privileges. See the following sections for setting up your permissions system:
@ -19,7 +19,7 @@ Setting User defaults
To set default user permissions, use the following steps.
1. From the |RCM| interface, select :menuselection:`Admin --> Permissions`
1. From the |RCE| interface, select :menuselection:`Admin --> Permissions`
2. Select the :guilabel:`Global` tab from the left-hand menu. The permissions
set on this screen apply to users and user-groups across the whole instance.
3. Save your changes
@ -31,7 +31,7 @@ Setting User Group defaults
To set default user group permissions, use the following steps.
1. From the |RCM| interface, select :menuselection:`Admin --> User groups`
1. From the |RCE| interface, select :menuselection:`Admin --> User groups`
2. Select :guilabel:`Permissions`, and configure the default user
permissions. All users will get these permissions unless
individually set.
@ -48,7 +48,7 @@ Setting Repository defaults
To set default |repo| permissions, use the following steps.
1. From the |RCM| interface, select :menuselection:`Admin --> Permissions`
1. From the |RCE| interface, select :menuselection:`Admin --> Permissions`
2. Select the :guilabel:`Object` tab from the left-hand menu and set the
|perm| permissions
3. Save your changes
@ -60,7 +60,7 @@ Setting Repository Group defaults
To set default Repository Group permissions, use the following steps.
1. From the |RCM| interface, select :menuselection:`Admin --> Repository Groups`
1. From the |RCE| interface, select :menuselection:`Admin --> Repository Groups`
2. Select :guilabel:`Edit` beside the |repo| group you wish to configure
3. On the left-hand pane select :guilabel:`Permissions`
4. Set the default permissions for all |repos| created in this group

4
docs/admin/setting-repo-perms.rst
View file

@ -3,12 +3,12 @@
Repository Administration
=========================
Repository permissions in |RCM| can be managed in a number of different ways.
Repository permissions in |RCE| can be managed in a number of different ways.
This overview should give you an insight into how you could adopt particular
settings for your needs:
* Global |repo| permissions: This allows you to set the default permissions
for each new |repo| created within |RCM|, see :ref:`repo-default-ref`. All
for each new |repo| created within |RCE|, see :ref:`repo-default-ref`. All
|repos| created will inherit these permissions unless explicitly configured.
* Individual |repo| permissions: To set individual |repo| permissions,
see :ref:`set-repo-perms`.

6
docs/admin/system-overview.rst
View file

@ -59,7 +59,7 @@ Supported Browsers
System Requirements
-------------------
|RCM| performs best on machines with ultra-fast hard disks. Generally disk
|RCE| performs best on machines with ultra-fast hard disks. Generally disk
performance is more important than CPU performance. In a corporate production
environment handling 1000s of users and |repos| you should deploy on a 12+
core 64GB RAM server. In short, the more RAM the better.
@ -68,7 +68,7 @@ core 64GB RAM server. In short, the more RAM the better.
For example:
- for team of 1 - 5 active users you can run on 1GB RAM machine with 1CPU
- above 250 active users, |RCM| needs at least 8GB of memory.
- above 250 active users, |RCE| needs at least 8GB of memory.
Number of CPUs is less important, but recommended to have at least 2-3 CPUs
@ -114,7 +114,7 @@ Connection Methods
* HTTPS
* SSH
* |RCM| API
* |RCE| API
Internationalization Support
----------------------------

2
docs/admin/user-admin.rst
View file

@ -3,7 +3,7 @@
User Administration
===================
|RCM| enables you to define permissions for the following entities within the
|RCE| enables you to define permissions for the following entities within the
system; **users**, **user groups**, **repositories**, **repository groups**.
Within each one of these entities you can set default settings,

12
docs/admin/vcs-server.rst
View file

@ -3,13 +3,13 @@
VCS Server Management
---------------------
The VCS Server handles |RCM| backend functionality. You need to configure
a VCS Server to run with a |RCM| instance. If you do not, you will be missing
the connection between |RCM| and its |repos|. This will cause error messages
The VCS Server handles |RCE| backend functionality. You need to configure
a VCS Server to run with a |RCE| instance. If you do not, you will be missing
the connection between |RCE| and its |repos|. This will cause error messages
on the web interface. You can run your setup in the following configurations,
currently the best performance is one of following:
* One VCS Server per |RCM| instance.
* One VCS Server per |RCE| instance.
* One VCS Server handling multiple instances.
.. important::
@ -49,7 +49,7 @@ To configure a |RCE| instance to use a VCS server, see
|RCE| VCS Server Options
^^^^^^^^^^^^^^^^^^^^^^^^
The following list shows the available options on the |RCM| side of the
The following list shows the available options on the |RCE| side of the
connection to the VCS Server. The settings are configured per
instance in the
:file:`/home/{user}/.rccontrol/{instance-id}/rhodecode.ini` file.
@ -75,7 +75,7 @@ instance in the
\vcs.server <host:port>
Set the host, either hostname or IP Address, and port of the VCS server
you wish to run with your |RCM| instance.
you wish to run with your |RCE| instance.
.. code-block:: ini