Configuration

The tenant configuration is a GitLab repository that contains the configuration of your tenant.

This is an "As Code" approach to configure your tenant. You will be able to simply edit the configuration files and commit them to apply the changes.

All the configuration must be in the tenant.yml file and respect this JSON Schema.

Example

Here is an example of a minimal tenant.yml file:

tenant.yml

name: Forge
slug: epita-forge
parent: epita
description: A Forge tenant
image_path: files/forge.svg

groups:
  - slug: group-A
    permissions:
      - INTRA_REPO_CLONE
    members: [xavier.login]

intranet:
  files: []
  contacts: []
  trombinoscope: []

Reference

Tenant

Field name	Description
name	The name of the tenant that will be displayed on the Forge services.
slug	The slug of the tenant as configured by the Forge team. This value cannot be changed.
parent	The slug of the parent tenant configured by the Forge team. This value cannot be changed.
description	The description of the tenant that will be displayed on the Forge services.
image_path	The relative path to the image of the tenant in the GitLab repository that will be displayed on the Forge services.
groups	The list of the permissions groups object. See here for more details.
intranet	The intranet configuration object. See here for more details.

Permissions groups

Field name	Description
slug	The slug of the group. This is only used for improving the readability of the configuration. It is not used in Forge services.
permissions	The list of permissions that the group will have. See here for more details.
members	The list of members that will be in the group.