weblate/docs/admin/access.rst
Michal Čihař 76972c4216 docs: automate documenting built-in teams
This way new teams won't be missed like we did with `Project creators`.

Fixes #11314
2024-04-02 15:53:42 +02:00

702 lines
54 KiB
ReStructuredText
Raw Permalink Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

.. _access-control:
Access control
==============
Weblate comes with a fine-grained privilege system to assign user permissions
for the whole instance, or in a limited scope.
.. _acl:
Project access control
----------------------
.. note::
Projects running the gratis Libre plan on Hosted Weblate are always
:guilabel:`Public`. You can switch to the paid plan if you want to restrict
access to your project.
You can limit users access to individual projects by selecting a different
:ref:`project-access_control` setting. Available options are:
:guilabel:`Public`
Visible to everybody.
Any authenticated user can contribute.
VCS repository might be exposed to everybody.
**Choose this for open-source projects, or when your Weblate instance is private or locked-down.**
:guilabel:`Protected`
Visible to everybody.
Only chosen users can contribute.
Only chosen users can access VCS repository.
**Choose this to gain visibility, but still have control over who can contribute.**
:guilabel:`Private`
Visible only to chosen users.
Only chosen users can contribute.
Only chosen users can access VCS repository.
**Choose this for projects that should not be exposed publicly at all.**
:guilabel:`Custom`
Visible only to chosen users.
Only chosen users can contribute.
Only chosen users can access VCS repository.
Not available on Hosted Weblate.
You will have to set up all the permissions using :ref:`custom-acl`.
**Choose this on your own Weblate instance if you want to define access in a specific, finely customizable way.**
:guilabel:`Access control` can be changed in the :guilabel:`Access` tab of the
configuration (:guilabel:`Manage`:guilabel:`Settings`) of each respective
project.
.. image:: /screenshots/project-access.webp
The default value can be changed by :setting:`DEFAULT_ACCESS_CONTROL`.
.. note::
Even for `Private` projects, some info about your project will be exposed:
statistics and language summary for the whole instance will include counts
for all projects despite the access control setting.
Your project name and other information cant be revealed through this.
.. note::
The actual set of permissions available for users by default in `Public`,
`Protected`, and `Private` projects can be redefined by Weblate instance
administrator using :ref:`custom settings <custom-acl>`.
.. seealso::
:ref:`project-access_control`
.. _manage-acl:
Managing per-project access control
-----------------------------------
Users with the :guilabel:`Manage project access` privilege (see
:ref:`privileges`) can manage users in projects via adding them to the teams.
The initial collection of teams is provided by Weblate, but additional ones can
be defined providing more fine-grained access control. You can limit teams to
languages and assign them designated access roles (see :ref:`privileges`).
The following teams are automatically created for every project:
For `Public`, `Protected` and `Private` projects:
Administration
Includes all permissions available for the project.
Review (only if :ref:`review workflow <reviews>` is turned on)
Can approve translations during review.
For `Protected` and `Private` projects only:
Translate
Can translate the project and upload translations made offline.
Sources
Can edit source strings (if allowed in the
:ref:`project settings <component-manage_units>`) and source string info.
Languages
Can manage translated languages (add or remove translations).
Glossary
Can manage glossary (add or remove entries, also upload).
Memory
Can manage translation memory.
Screenshots
Can manage screenshots (add or remove them, and associate them to source
strings).
Automatic translation
Can use automatic translation.
VCS
Can manage VCS and access the exported repository.
Billing
Can access billing info and settings (see :ref:`billing`).
.. image:: /screenshots/manage-users.webp
These features are available on the :guilabel:`Access control` page, which can be
accessed from the projects menu :guilabel:`Manage`:guilabel:`Users`.
Team administrators
+++++++++++++++++++
.. versionadded:: 4.15
Each team can have team administrator, who can add and remove users within the
team. This is useful in case you want to build self-governed teams.
.. _invite-user:
Inviting new users
++++++++++++++++++
Adding existing users will send them invitation to confirm. With
:setting:`REGISTRATION_OPEN` the administrator can also invite new users using
e-mail. Invited users have to complete the registration process to get access
to the project.
It is not required to have any site-wide privileges in order to do so, access management
permission on the projects scope (e.g. a membership in the `Administration`
team) would be sufficient.
.. hint::
If the invited user missed the validity of the invitation, a new invitation
has to be created.
The same kind of invitations are available site-wide from the
:ref:`management interface <management-interface>` on the :guilabel:`Users` tab.
.. versionchanged:: 5.0
Weblate now does not automatically create accounts or add users to the
teams. This is only done after confirmation from the user.
.. _block-user:
Blocking users
++++++++++++++
.. versionadded:: 4.7
In case some users behave badly in your project, you have an option to block
them from contributing. The blocked user still will be able to see the project
if he has permissions for that, but he won't be able to contribute.
Per-project permission management
+++++++++++++++++++++++++++++++++
You can set your projects to :guilabel:`Protected` or :guilabel:`Private` (see
:ref:`acl`), and :ref:`manage users <manage-acl>` per-project in the Weblate
user interface.
By default this prevents Weblate from granting access provided by
`Users` and `Viewers` :ref:`default teams <default-teams>` due to these teams
own configuration. This doesnt prevent you from granting permissions to those
projects site-wide by altering default teams, creating a new one, or creating
additional custom settings for individual component as described in :ref:`custom-acl` below.
One of the main benefits of managing permissions through the Weblate
user interface is that you can delegate it to other users without giving them
the superuser privilege. In order to do so, add them to the `Administration`
team of the project.
.. _custom-acl:
Site-wide access control
------------------------
.. include:: /snippets/not-hosted.rst
The permission system is based on teams and roles, where roles define a set of
permissions, and teams link them to users and translations, see
:ref:`auth-model` for more details.
The most powerful features of the Weblates access control system can be configured
in the :ref:`management-interface`. You can use it to manage permissions of any
project. You dont necessarily have to switch it to :guilabel:`Custom` :ref:`access
control <acl>` to utilize it. However you must have superuser privileges in
order to use it.
If you are not interested in details of implementation, and just want to create a
simple-enough configuration based on the defaults, or dont have a site-wide access
to the whole Weblate installation (like on `Hosted Weblate <https://hosted.weblate.org/>`_),
please refer to the :ref:`manage-acl` section.
Site-wide permission management
+++++++++++++++++++++++++++++++
To manage permissions for a whole instance at once, add users to
appropriate :ref:`default teams <default-teams>`:
* `Users` (this is done by default by the
:ref:`automatic team assignment <autoteam>`).
* `Reviewers` (if you are using :ref:`review workflow <reviews>` with dedicated
reviewers).
* `Managers` (if you want to delegate most of the management operations to somebody
else).
You should keep all projects configured as `Public` (see :ref:`acl`), otherwise
the site-wide permissions provided by membership in the `Users` and `Reviewers` teams
wont have any effect.
You may also grant some additional permissions of your choice to the default
teams. For example, you may want to give a permission to manage screenshots to all
the `Users`.
You can define some new custom teams as well. If you want to
keep managing your permissions site-wide for these teams, choose an
appropriate value for the :guilabel:`Project selection` (e.g.
:guilabel:`All projects` or :guilabel:`All public projects`).
Custom permissions for languages, components or projects
++++++++++++++++++++++++++++++++++++++++++++++++++++++++
You can create your own dedicated teams to manage permissions for distinct
objects such as languages, components, and projects. Although these teams can
only grant additional privileges, you cant revoke any permission granted
by site-wide or per-project teams by adding another custom team.
**Example:**
If you want (for whatever reason) to allow translation to a
specific language (lets say `Czech`) only to a closed set of reliable translators
while keeping translations to other languages public, you will have to:
1. Remove the permission to translate `Czech` from all the users. In the
default configuration this can be done by altering the `Users`
:ref:`default team <default-teams>`.
.. list-table:: Group `Users`
:stub-columns: 1
* - Language selection
- `As defined`
* - Languages
- All but `Czech`
..
2. Add a dedicated team for `Czech` translators.
.. list-table:: Group `Czech translators`
:stub-columns: 1
* - Roles
- `Power users`
* - Project selection
- `All public projects`
* - Language selection
- `As defined`
* - Languages
- `Czech`
..
3. Add users you wish to give the permissions to into this team.
As you can see, permissions management this way is powerful,
but can be quite a tedious job. You cant
delegate it to another user, unless granting superuser permissions.
.. _auth-model:
Users, roles, teams, and permissions
------------------------------------
The authentication models consist of several objects:
`Permission`
Individual permission defined by Weblate. Permissions cannot be
assigned to users. This can only be done through assignment of roles.
`Role`
A role defines a set of permissions. This allows reuse of these sets in
several places, making the administration easier.
`User`
User can belong to several teams.
`Group`
Group connect roles, users, and authentication objects (projects,
languages, and component lists).
.. graphviz::
graph auth {
"User" -- "Group";
"Group" -- "Role";
"Role" -- "Permission";
"Group" -- "Project";
"Group" -- "Language";
"Group" -- "Components";
"Group" -- "Component list";
}
.. note::
A team can have no roles assigned to it, in that case access to browse the
project by anyone is assumed (see below).
Access for browse to a project
++++++++++++++++++++++++++++++
A user has to be a member of a team linked to the project, or any component
inside that project. Having membership is enough, no specific permissions are
needed to browse the project (this is used in the default `Viewers` team, see
:ref:`default-teams`).
Access for browse to a component
++++++++++++++++++++++++++++++++
A user can access unrestricted components once able to access the components
project (and will have all the permissions the user was granted for the
project). With :ref:`component-restricted` turned on, access to the component
requires explicit permissions for the component (or a component list the component is in).
.. _perm-check:
Scope of teams
++++++++++++++
The scope of the permission assigned by the roles in the teams are applied by
the following rules:
- If the team specifies any :guilabel:`Component list`, all the permissions given to
members of that team are granted for all the components in the component
lists attached to the team, and an access with no additional permissions is
granted for all the projects these components are in. :guilabel:`Components`
and :guilabel:`Projects` are ignored.
Using huge component lists might have a performance impact, please consider
giving access via projects instead.
- If the team specifies any :guilabel:`Components`, all the permissions given to
the members of that team are granted for all the components attached to the
team, and an access with no additional permissions is granted for all the
projects these components are in. :guilabel:`Projects` are ignored.
- Otherwise, if the team specifies any :guilabel:`Projects`, either by directly
listing them or by having :guilabel:`Projects selection` set to a value like :guilabel:`All
public projects`, all those permissions are applied to all the projects, which
effectively grants the same permissions to access all projects
:ref:`unrestricted components <component-restricted>`.
- The restrictions imposed by a teams :guilabel:`Languages` are applied separately,
when its verified if a user has an access to perform certain actions. Namely,
its applied only to actions directly related to the translation process itself like
reviewing, saving translations, adding suggestions, etc.
.. hint::
Use :guilabel:`Language selection` or :guilabel:`Project selection`
to automate inclusion of all languages or projects.
**Example:**
Lets say there is a project ``foo`` with the components: ``foo/bar`` and
``foo/baz`` and the following team:
.. list-table:: Group `Spanish Admin-Reviewers`
:stub-columns: 1
* - Roles
- `Review Strings`, `Manage repository`
* - Components
- foo/bar
* - Languages
- `Spanish`
..
Members of that team will have following permissions (assuming the default role settings):
- General (browsing) access to the whole project ``foo`` including both
components in it: ``foo/bar`` and ``foo/baz``.
- Review strings in ``foo/bar`` Spanish translation (not elsewhere).
- Manage VCS for the whole ``foo/bar`` repository e.g. commit pending
changes made by translators for all languages.
.. _autoteam:
Automatic team assignments
--------------------------
While editing the :guilabel:`Team`, you can specify
:guilabel:`Automatic assignments`, which is a list of regular expressions
used to automatically assign newly created users to a team based on their
e-mail addresses. This assignment only happens upon account creation.
The most common use-case for the feature is to assign all new users to some
default team. This behavior is used for the default `Users` and `Guest` teams
(see :ref:`default-teams`). Use regular expression ``^.*$`` to match all users.
Another use-case for this option might be to
give some additional privileges to employees of your company by default.
Assuming all of them use corporate e-mail addresses on your domain, this can
be accomplished with an expression like ``^.*@mycompany.com``.
.. note::
Automatic team assignment to `Users` and `Viewers` is always recreated
when upgrading from one Weblate version to another. If you want to turn it off, set the regular expression to
``^$`` (which wont match anything).
.. note::
As for now, there is no way to bulk-add already existing users to some team
via the user interface. For that, you may resort to using the :ref:`REST API <api>`.
Default teams and roles
-----------------------
After installation, a default set of teams is created (see :ref:`default-teams`).
These roles and teams are created upon installation. The built-in roles are
always kept up to date by the database migration when upgrading. You cant
actually change them, please define a new role if you want to define your own
set of permissions.
.. _privileges:
List of privileges
++++++++++++++++++
..
Generated using ./manage.py list_permissions
+------------------------------+-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Scope | Permission | Built-in roles |
+==============================+===========================================+=============================================================================================================================================================================================+
| Billing (see :ref:`billing`) | View billing info | :guilabel:`Administration`, :guilabel:`Billing` |
+------------------------------+-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Changes | Download changes | :guilabel:`Administration` |
+------------------------------+-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Comments | Post comment | :guilabel:`Administration`, :guilabel:`Edit source`, :guilabel:`Power user`, :guilabel:`Review strings`, :guilabel:`Translate` |
+ +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | Delete comment | :guilabel:`Administration` |
+ +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | Resolve comment | :guilabel:`Administration`, :guilabel:`Review strings` |
+------------------------------+-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Component | Edit component settings | :guilabel:`Administration` |
+ +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | Lock component, preventing translations | :guilabel:`Administration`, :guilabel:`Manage repository` |
+------------------------------+-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Glossary | Add glossary entry | :guilabel:`Administration`, :guilabel:`Manage glossary`, :guilabel:`Power user` |
+ +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | Edit glossary entry | :guilabel:`Administration`, :guilabel:`Manage glossary`, :guilabel:`Power user` |
+ +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | Delete glossary entry | :guilabel:`Administration`, :guilabel:`Manage glossary`, :guilabel:`Power user` |
+ +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | Upload glossary entries | :guilabel:`Administration`, :guilabel:`Manage glossary`, :guilabel:`Power user` |
+------------------------------+-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Automatic suggestions | Use automatic suggestions | :guilabel:`Administration`, :guilabel:`Edit source`, :guilabel:`Power user`, :guilabel:`Review strings`, :guilabel:`Translate` |
+------------------------------+-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Translation memory | Edit translation memory | :guilabel:`Administration`, :guilabel:`Manage translation memory` |
+ +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | Delete translation memory | :guilabel:`Administration`, :guilabel:`Manage translation memory` |
+------------------------------+-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Projects | Edit project settings | :guilabel:`Administration` |
+ +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | Manage project access | :guilabel:`Administration` |
+------------------------------+-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Reports | Download reports | :guilabel:`Administration` |
+------------------------------+-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Screenshots | Add screenshot | :guilabel:`Administration`, :guilabel:`Manage screenshots` |
+ +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | Edit screenshot | :guilabel:`Administration`, :guilabel:`Manage screenshots` |
+ +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | Delete screenshot | :guilabel:`Administration`, :guilabel:`Manage screenshots` |
+------------------------------+-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Source strings | Edit additional string info | :guilabel:`Administration`, :guilabel:`Edit source` |
+------------------------------+-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Strings | Add new string | :guilabel:`Administration` |
+ +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | Remove a string | :guilabel:`Administration` |
+ +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | Dismiss failing check | :guilabel:`Administration`, :guilabel:`Edit source`, :guilabel:`Power user`, :guilabel:`Review strings`, :guilabel:`Translate` |
+ +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | Edit strings | :guilabel:`Administration`, :guilabel:`Edit source`, :guilabel:`Power user`, :guilabel:`Review strings`, :guilabel:`Translate` |
+ +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | Review strings | :guilabel:`Administration`, :guilabel:`Review strings` |
+ +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | Edit string when suggestions are enforced | :guilabel:`Administration`, :guilabel:`Review strings` |
+ +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | Edit source strings | :guilabel:`Administration`, :guilabel:`Edit source`, :guilabel:`Power user` |
+------------------------------+-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Suggestions | Accept suggestion | :guilabel:`Administration`, :guilabel:`Edit source`, :guilabel:`Power user`, :guilabel:`Review strings`, :guilabel:`Translate` |
+ +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | Add suggestion | :guilabel:`Administration`, :guilabel:`Edit source`, :guilabel:`Add suggestion`, :guilabel:`Power user`, :guilabel:`Review strings`, :guilabel:`Translate` |
+ +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | Delete suggestion | :guilabel:`Administration`, :guilabel:`Power user` |
+ +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | Vote on suggestion | :guilabel:`Administration`, :guilabel:`Edit source`, :guilabel:`Power user`, :guilabel:`Review strings`, :guilabel:`Translate` |
+------------------------------+-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Translations | Add language for translation | :guilabel:`Administration`, :guilabel:`Power user`, :guilabel:`Manage languages` |
+ +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | Perform automatic translation | :guilabel:`Administration`, :guilabel:`Automatic translation` |
+ +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | Delete existing translation | :guilabel:`Administration`, :guilabel:`Manage languages` |
+ +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | Download translation file | :guilabel:`Administration`, :guilabel:`Edit source`, :guilabel:`Access repository`, :guilabel:`Power user`, :guilabel:`Review strings`, :guilabel:`Translate`, :guilabel:`Manage languages` |
+ +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | Add several languages for translation | :guilabel:`Administration`, :guilabel:`Manage languages` |
+------------------------------+-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Uploads | Define author of uploaded translation | :guilabel:`Administration` |
+ +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | Overwrite existing strings with upload | :guilabel:`Administration`, :guilabel:`Edit source`, :guilabel:`Power user`, :guilabel:`Review strings`, :guilabel:`Translate` |
+ +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | Upload translations | :guilabel:`Administration`, :guilabel:`Edit source`, :guilabel:`Power user`, :guilabel:`Review strings`, :guilabel:`Translate` |
+------------------------------+-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| VCS | Access the internal repository | :guilabel:`Administration`, :guilabel:`Access repository`, :guilabel:`Power user`, :guilabel:`Manage repository` |
+ +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | Commit changes to the internal repository | :guilabel:`Administration`, :guilabel:`Manage repository` |
+ +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | Push change from the internal repository | :guilabel:`Administration`, :guilabel:`Manage repository` |
+ +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | Reset changes in the internal repository | :guilabel:`Administration`, :guilabel:`Manage repository` |
+ +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | View upstream repository location | :guilabel:`Administration`, :guilabel:`Access repository`, :guilabel:`Power user`, :guilabel:`Manage repository` |
+ +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | Update the internal repository | :guilabel:`Administration`, :guilabel:`Manage repository` |
+------------------------------+-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Site wide privileges | Use management interface | |
+ +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | Add new projects | |
+ +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | Add language definitions | |
+ +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | Manage language definitions | |
+ +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | Manage teams | |
+ +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | Manage users | |
+ +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | Manage roles | |
+ +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | Manage announcements | |
+ +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | Manage translation memory | |
+ +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | Manage machinery | |
+ +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | Manage component lists | |
+ +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | Manage billing | |
+------------------------------+-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. note::
Site-wide privileges are not granted to any default role. These are
powerful and quite close to superuser status. Most of them affect all projects
in your Weblate installation.
List of built-in roles
++++++++++++++++++++++
..
Generated using ./manage.py list_permissions
`Administration`
:guilabel:`View billing info`, :guilabel:`Download changes`, :guilabel:`Post comment`, :guilabel:`Delete comment`, :guilabel:`Resolve comment`, :guilabel:`Edit component settings`, :guilabel:`Lock component, preventing translations`, :guilabel:`Add glossary entry`, :guilabel:`Delete glossary entry`, :guilabel:`Edit glossary entry`, :guilabel:`Upload glossary entries`, :guilabel:`Use automatic suggestions`, :guilabel:`Delete translation memory`, :guilabel:`Edit translation memory`, :guilabel:`Edit project settings`, :guilabel:`Manage project access`, :guilabel:`Download reports`, :guilabel:`Add screenshot`, :guilabel:`Delete screenshot`, :guilabel:`Edit screenshot`, :guilabel:`Edit additional string info`, :guilabel:`Accept suggestion`, :guilabel:`Add suggestion`, :guilabel:`Delete suggestion`, :guilabel:`Vote on suggestion`, :guilabel:`Add language for translation`, :guilabel:`Add several languages for translation`, :guilabel:`Perform automatic translation`, :guilabel:`Delete existing translation`, :guilabel:`Download translation file`, :guilabel:`Add new string`, :guilabel:`Dismiss failing check`, :guilabel:`Remove a string`, :guilabel:`Edit strings`, :guilabel:`Edit string when suggestions are enforced`, :guilabel:`Review strings`, :guilabel:`Edit source strings`, :guilabel:`Define author of uploaded translation`, :guilabel:`Overwrite existing strings with upload`, :guilabel:`Upload translations`, :guilabel:`Access the internal repository`, :guilabel:`Commit changes to the internal repository`, :guilabel:`Push change from the internal repository`, :guilabel:`Reset changes in the internal repository`, :guilabel:`Update the internal repository`, :guilabel:`View upstream repository location`
`Edit source`
:guilabel:`Post comment`, :guilabel:`Use automatic suggestions`, :guilabel:`Edit additional string info`, :guilabel:`Accept suggestion`, :guilabel:`Add suggestion`, :guilabel:`Vote on suggestion`, :guilabel:`Download translation file`, :guilabel:`Dismiss failing check`, :guilabel:`Edit strings`, :guilabel:`Edit source strings`, :guilabel:`Overwrite existing strings with upload`, :guilabel:`Upload translations`
`Add suggestion`
:guilabel:`Add suggestion`
`Access repository`
:guilabel:`Download translation file`, :guilabel:`Access the internal repository`, :guilabel:`View upstream repository location`
`Manage glossary`
:guilabel:`Add glossary entry`, :guilabel:`Delete glossary entry`, :guilabel:`Edit glossary entry`, :guilabel:`Upload glossary entries`
`Power user`
:guilabel:`Post comment`, :guilabel:`Add glossary entry`, :guilabel:`Delete glossary entry`, :guilabel:`Edit glossary entry`, :guilabel:`Upload glossary entries`, :guilabel:`Use automatic suggestions`, :guilabel:`Accept suggestion`, :guilabel:`Add suggestion`, :guilabel:`Delete suggestion`, :guilabel:`Vote on suggestion`, :guilabel:`Add language for translation`, :guilabel:`Download translation file`, :guilabel:`Dismiss failing check`, :guilabel:`Edit strings`, :guilabel:`Edit source strings`, :guilabel:`Overwrite existing strings with upload`, :guilabel:`Upload translations`, :guilabel:`Access the internal repository`, :guilabel:`View upstream repository location`
`Review strings`
:guilabel:`Post comment`, :guilabel:`Resolve comment`, :guilabel:`Use automatic suggestions`, :guilabel:`Accept suggestion`, :guilabel:`Add suggestion`, :guilabel:`Vote on suggestion`, :guilabel:`Download translation file`, :guilabel:`Dismiss failing check`, :guilabel:`Edit strings`, :guilabel:`Edit string when suggestions are enforced`, :guilabel:`Review strings`, :guilabel:`Overwrite existing strings with upload`, :guilabel:`Upload translations`
`Translate`
:guilabel:`Post comment`, :guilabel:`Use automatic suggestions`, :guilabel:`Accept suggestion`, :guilabel:`Add suggestion`, :guilabel:`Vote on suggestion`, :guilabel:`Download translation file`, :guilabel:`Dismiss failing check`, :guilabel:`Edit strings`, :guilabel:`Overwrite existing strings with upload`, :guilabel:`Upload translations`
`Manage languages`
:guilabel:`Add language for translation`, :guilabel:`Add several languages for translation`, :guilabel:`Delete existing translation`, :guilabel:`Download translation file`
`Automatic translation`
:guilabel:`Perform automatic translation`
`Manage translation memory`
:guilabel:`Delete translation memory`, :guilabel:`Edit translation memory`
`Manage screenshots`
:guilabel:`Add screenshot`, :guilabel:`Delete screenshot`, :guilabel:`Edit screenshot`
`Manage repository`
:guilabel:`Lock component, preventing translations`, :guilabel:`Access the internal repository`, :guilabel:`Commit changes to the internal repository`, :guilabel:`Push change from the internal repository`, :guilabel:`Reset changes in the internal repository`, :guilabel:`Update the internal repository`, :guilabel:`View upstream repository location`
`Billing`
:guilabel:`View billing info`
`Add new projects`
:guilabel:`Add new projects`
.. _default-teams:
List of teams
+++++++++++++
The following teams are created upon installation (or after executing
:wladmin:`setupgroups`) and you are free to modify them. The migration will,
however, re-create them if you delete or rename them.
`Guests`
Defines permissions for non-authenticated users.
This team only contains anonymous users (see :setting:`ANONYMOUS_USER_NAME`).
You can remove roles from this team to limit permissions for
non-authenticated users.
Default roles: `Add suggestion`, `Access repository`
`Viewers`
This role ensures visibility of public projects for all users. By default,
all users are members of this team.
By default, :ref:`automatic team assignment <autoteam>` makes all new
accounts members of this team when they join.
Default roles: none
`Users`
Default team for all users.
By default, :ref:`automatic team assignment <autoteam>` makes all new
accounts members of this team when they join.
Default roles: `Power user`
`Reviewers`
Group for reviewers (see :ref:`workflows`).
Default roles: `Review strings`
`Managers`
Group for administrators.
Default roles: `Administration`
`Project creators`
.. versionadded:: 5.1
Users who can create new projects.
Default roles: `Add new projects`
.. warning::
Never remove the predefined Weblate teams and users as this can lead to
unexpected problems! If you have no use for them, you can removing all their
privileges instead.
Additional access restrictions
------------------------------
If you want to use your Weblate installation in a less public manner, i.e. allow
new users on an invitational basis only, it can be done by configuring Weblate
in such a way that only known users have an access to it. In order to do so, you can set
:setting:`REGISTRATION_OPEN` to ``False`` to prevent registrations of any new
users, and set :setting:`REQUIRE_LOGIN` to ``/.*`` to require signing in to access
all the site pages. This is basically the way to lock your Weblate installation.
.. hint::
You can use built-in :ref:`invite-user` to add new users.