All Configuration Options for Pristy

All Pristy applications can be configured using a JSON configuration file: env-config.json.

Dynamic vs Static Parameters

Pristy configuration parameters are divided into two categories:

Dynamic Parameters

Dynamic parameters can be modified directly from the Configuration page of Pristy Portail, Pristy Espaces, Pristy Marchés and Pristy Média (Pristy Social offers raw JSON editing). The page shows the parameters defined in each application’s config-descriptions.json file, plus any other option already present in the saved file, with:

  • Contextual descriptions in French and English
  • Data type validation (text, number, boolean, list, object, choice)
  • Predefined default values
  • Ability to add or remove options
  • Explicit saving of changes with the Save button

List of dynamic parameters modifiable via the Pristy Espaces interface:

  • APP_ROOT_TITLE - Application title
  • ASPECTS - Available Alfresco aspects
  • CLASSIFICATION_PLAN_ENABLED, CLASSIFICATION_PLAN_ALLOW_NO_NATURE, CLASSIFICATION_PLAN_FULL_VIEW_THRESHOLD, CLASSIFICATION_PLAN_INLINE_METADATA_THRESHOLD, CLASSIFICATION_PLAN_NATURE_CODE_PROPERTY, FILENAME_NATURE_DETECTION - Classification plan
  • COLLAB_ENABLED - Collaborative editing activation
  • CONSTRAINTS - Metadata constraints
  • DASHBOARD_PERSONAL_ENABLED - Personal dashboard
  • DEFAULT_ELEMENT_PER_PAGE - Default number of elements per page
  • EDIT_WITH_MSOFFICE - Microsoft Office editing
  • ESPACES_HOST, MARCHES_HOST, MEDIA_HOST, SOCIAL_HOST - Application addresses
  • HOME_PAGE - Home page
  • MATOMO_ENABLE, MATOMO_INSTANCE_URL, MATOMO_SITE_ID - Matomo configuration
  • METADATA - Metadata configuration
  • MIME_TYPES - MIME types offered to change a file’s type
  • OPEN_PDF_WITH_COLLABORA - Open PDFs with Collabora
  • PDF_TOOLS_SYMBOLS - PDF editor symbols
  • ROW_PER_PAGE_OPTIONS - Pagination options
  • SEARCH_BASE_FILTER_QUERIES - Search filter queries
  • SEARCH_FACET - Search facet configuration
  • SEARCH_FACET_QUERIES - Facet queries
  • SEARCH_USER_QUERY - User search query
  • SHOW_ACA_LOGIN_LINK - Link to ACA

The options without effect only appear in the Configuration page when they are still in the saved file: changing them changes nothing.

Static Parameters

Static parameters can only be modified by manually editing the env-config.json file on the server: Pristy Core does not pass them to the Configuration page. They are ACA_HOST, ACA_LINK, ALFRESCO_HOST, ALFRESCO_ROOT, APP_ROOT, COLLABORA_HOSTING_DISCOVERY, PORTAIL_HOST, ACTES_HOST, PREVIEW_URL and every option whose name starts with AUTH. These parameters typically concern:

  • URLs configuration for the different Pristy applications
  • The authentication mode (AUTH)
  • Critical system configurations

Any change, static or dynamic, applies the next time the page is loaded in the browser: no restart is needed.


Complete Parameter List

This section presents all configuration parameters available in Pristy, organized by functional category. Parameters marked as dynamic can be modified via the administration interface.

General Parameters

APP_ROOT (string) - Static
Application prefix corresponding to the base URL. Common values: /actes/, /social/. Only read by Pristy Actes and Pristy Social: the other applications are built for their path.
APP_ROOT_TITLE (string) - Dynamic
Application name displayed in the user interface. Default value: "Pristy Root"; the configuration deposited at initialization sets the name of each application ("Pristy Espaces", "Pristy Portail"…).
INSTANCE_NAME (string) - Internal
Name of the application’s folder under Pristy - Configuration (for example espaces), where it reads its dashboard among other things. Set by the application itself: do not modify it.
HOME_PAGE (string) - Dynamic
Home page of Pristy Espaces: "workspaces" (list of workspaces) or "dashboard" (dashboard). Any other value is treated as "workspaces". Default value: "workspaces".
APPLICATIONS (array) - Dynamic
List of applications offered by the application switcher. Each entry carries a key (portail, espaces, actes, marches, social, media) and a mandatory url address; label and icon allow adding another application. To be declared in the common configuration, from the Bootstrap page of Pristy Portail: a value in the static file or in an application’s configuration is ignored. Default value: [] (the switcher is then empty).
BREADCRUMB_ROOT_URL (string) - No effect
Former root URL of the breadcrumb. Only read by Pristy Actes.
THEME (string) - No effect
Former choice of the application theme. No longer read by any application.

Alfresco Parameters

ALFRESCO_HOST (string) - Static
Full address of the Alfresco Content Services server. Example: "https://demo.pristy.net", "http://localhost:8010". Required.
ALFRESCO_ROOT (string) - Static
Base path of the Alfresco server. Default value: "alfresco".
ALFRESCO_AUTH (string) - Static
Alfresco authentication type. Only the value of the static file is taken into account. Default value: "BASIC".
PREVIEW_URL (string) - Static
Base URL for document preview. Example: "https://demo.pristy.net/portail/preview/".

Authentication Parameters

AUTH (string) - Static
Application authentication type. Possible values: "basic", "keycloak", "lemonldap", "azuread". Default value: "basic".

Basic Mode

In basic mode, the user enters their username and password directly on the application’s login page.

Keycloak / OIDC Mode

In keycloak mode, authentication is delegated to a Keycloak server. The OIDC_* options are not filtered by Pristy Core: preferably put them in the static file.

OIDC_CUSTOM (object) - Static
Identity provider configuration, required in OIDC mode. With keycloak-js: realm, url and clientId. With oidc-client-ts: oidcProvider (or url and realm) and clientId required, scope ("openid profile email" by default), checkLoginIframe, fetchRequestCredentials; responseType is ignored. Example:
{
  "realm": "pristy",
  "url": "https://auth.jeci.tech/",
  "clientId": "pristy-front"
}
OIDC_CLIENT (string) - Static
Library used to communicate with the identity provider: "keycloak-js" or "oidc-client-ts". Any other value falls back to "keycloak-js". Default value: "keycloak-js".
OIDC_USERNAME_CLAIM (string) - Static
Token attribute whose value must match the user’s Alfresco identifier. Default value: "preferred_username".
OIDC_ACCOUNT_URLS (object) - Static
Addresses of the identity provider’s account console, per section ("profile", "password"). Only useful when they cannot be derived from the provider’s address. Default value: {}.
OIDC_REALM, OIDC_CLIENT_ID, OIDC_PROVIDER, OIDC_RESPONSE_TYPE (string) - No effect
Former OIDC mode options, replaced by OIDC_CUSTOM.

LemonLDAP-NG / OIDC Mode

In lemonldap mode, authentication is delegated to LemonLDAP-NG (OIDC parameters similar to Keycloak mode).

Azure AD / OIDC Mode

In azuread mode, authentication is delegated to Microsoft Entra ID (OIDC parameters similar to Keycloak mode).

Application URLs

ACTES_HOST (string) - Static
Full URL of the Pristy Actes application. Example: "https://demo.pristy.net", "http://localhost:8011".
ESPACES_HOST (string) - Dynamic
Full URL of the Pristy Espaces application. Example: "https://demo.pristy.net", "http://localhost:8010".
PORTAIL_HOST (string) - Static
Full URL of the Pristy Portail application. Example: "https://demo.pristy.net", "http://localhost:8009".
MARCHES_HOST (string) - Dynamic
Full URL of the Pristy Marches application. Example: "https://demo.pristy.net", "http://localhost:8012".
SOCIAL_HOST (string) - Dynamic
Full URL of the Pristy Social application. Example: "https://demo.pristy.net", "http://localhost:8013".
MEDIA_HOST (string) - Dynamic
Full URL of the Pristy Média application. Example: "https://demo.pristy.net".

All these addresses default to "", which designates the application’s own server.

ACA_HOST (string) - No effect
Former full URL of the Alfresco Content Application interface. Read by no application.
ACA_LINK (string) - Static
Link to the ACA interface, shown on the login page when SHOW_ACA_LOGIN_LINK is true. Default value: "http://localhost:80/aca/".

Pristy Menu Parameters

MENU_ESPACES, MENU_ACTES, MENU_MARCHES, MENU_SOCIAL, MENU_MEDIA (boolean) - No effect
Former options of the application switcher, which is now built only from APPLICATIONS. Default value: false.

Metadata and Data Models

METADATA (array) - Dynamic
Complete configuration of the metadata fields displayed in the application. Each entry defines a field with its properties. Field structure:
{
  "id": "cm:title",
  "labelId": "field.title",
  "display": ["popup", "details", "advancedSearch"],
  "input": "text",
  "readOnly": false,
  "modelAspect": "cm:titled",
  "order": 2
}

Available properties:

  • id (string, required): Alfresco field identifier (e.g. "name", "cm:title", "exif:flash")
  • labelId (string): i18n translation key for the label
  • title (string): Alternative title if labelId is not provided
  • display (array): Where to display the field. Values: "popup" (edit window), "details" (Properties panel), "advancedSearch" (advanced search, Pristy Espaces only), "view" (view editor), "datatable" (metadata that can be shown on cards and in the grid). In Pristy Espaces, the Metadata page sets them without editing the JSON
  • input (string): Input type. Values: "text", "datetime", "date", "boolean", "int", "float", "double", "list"
  • readOnly (boolean): Read-only field
  • modelType (string): Concerned Alfresco content type (e.g. "cm:content", "cm:folder")
  • modelAspect (string): Concerned Alfresco aspect (e.g. "cm:titled", "cm:author", "exif:exif")
  • constraint (string): Associated constraint name (if input = "list")
  • order (number): Display order

Common field examples:

  • Document name: "name"
  • Title: "cm:title"
  • Description: "cm:description"
  • Author: "cm:author"
  • Creation date: "createdAt"
  • Modification date: "modifiedAt"
  • Creator: "createdByUser"
  • Modifier: "modifiedByUser"
  • Version: "cm:versionLabel"
  • Size: "size"
  • MIME type: "mimeType"
ASPECTS (array) - Dynamic
List of Alfresco aspects available for manual addition to documents via the interface. Structure:
[
  {
    "id": "exif:exif",
    "title": "EXIF",
    "labelId": "exif_exif"
  },
  {
    "id": "cm:author",
    "title": "Author",
    "labelId": "cm_author"
  },
  {
    "id": "cm:titled",
    "title": "Title",
    "labelId": "cm_titled"
  }
]

Default value: [] (empty list).

CONSTRAINTS (array) - Dynamic
Defines constrained value lists for metadata fields. Two types of constraints are supported:
  1. Static constraint: Hard-coded value list
{
  "name": "authors",
  "type": "static",
  "list": [
    {
      "id": "jlesage",
      "label": "Jérémie Lesage",
      "labelId": ""
    },
    {
      "id": "cpiassale",
      "label": "Cindy Piassale",
      "labelId": ""
    }
  ]
}
  1. Dynamic constraint: List loaded via an Alfresco webscript
{
  "name": "sample",
  "type": "webscript",
  "uri": "/s/constraints/sample"
}

Default value: [].

Pagination

DEFAULT_ELEMENT_PER_PAGE (number) - Dynamic
Default number of elements displayed per page. The user’s choice is stored in the browser. Default value: 5. The configuration deposited at initialization sets 12 for Pristy Espaces and Pristy Portail, 6 for Pristy Marchés and 10 for Pristy Média.
ROW_PER_PAGE_OPTIONS (array) - Dynamic
Pagination choices offered to the user in the interface. Default value: []. The configuration deposited at initialization sets [6, 12, 18, 24], and [5, 10, 20, 40] for Pristy Média.
SEARCH_BASE_FILTER_QUERIES (array) - Dynamic
Solr filter queries applied by default to all searches. Allows excluding certain content types. Default value:
[
  { "query": "+TYPE:'cm:folder' OR +TYPE:'cm:content'" },
  { "query": "-TYPE:'cm:thumbnail' AND -TYPE:'cm:failedThumbnail' AND -TYPE:'cm:rating'" },
  { "query": "-cm:creator:System AND -QNAME:comment" },
  { "query": "-TYPE:'st:site' AND -ASPECT:'st:siteContainer' AND -ASPECT:'sys:hidden'" },
  { "query": "-TYPE:'dl:dataList' AND -TYPE:'dl:todoList' AND -TYPE:'dl:issue'" },
  { "query": "-TYPE:'fm:topic' AND -TYPE:'fm:post' AND -TYPE:'fm:forum'" },
  { "query": "-TYPE:'lnk:link'" },
  { "query": "-PNAME:'0/wiki'" }
]
SEARCH_FACET (array) - Dynamic
Configuration of the facets (filters) displayed in search results. Structure:
[
  {
    "field": "content.mimetype",
    "mincount": 1,
    "label": "facets.fields.file_type"
  },
  {
    "field": "creator",
    "mincount": 1,
    "label": "facets.fields.creator"
  },
  {
    "field": "modifier",
    "mincount": 1,
    "label": "facets.fields.modifier"
  },
  {
    "field": "SITE",
    "mincount": 1,
    "label": "facets.fields.location"
  },
  {
    "field": "TYPE",
    "mincount": 1,
    "label": "facets.fields.type"
  }
]

Properties:

  • field (string): Solr field on which to build the facet
  • mincount (number): Minimum number of occurrences to display a value
  • label (string): i18n key for the facet label
SEARCH_FACET_QUERIES (array) - Dynamic
Facets based on complex Solr queries, typically for date filters. Default value (for Espaces):
[
  {
    "label": "facets.queries.today",
    "query": "cm:modified:[TODAY to TODAY]",
    "group": "facets.categories.modified_date"
  },
  {
    "label": "facets.queries.this_week",
    "query": "cm:modified:[NOW/DAY-7DAYS TO NOW/DAY+1DAY]",
    "group": "facets.categories.modified_date"
  },
  {
    "label": "facets.queries.this_month",
    "query": "cm:modified:[NOW/DAY-1MONTH TO NOW/DAY+1DAY]",
    "group": "facets.categories.modified_date"
  },
  {
    "label": "facets.queries.last_6_months",
    "query": "cm:modified:[NOW/DAY-6MONTHS TO NOW/DAY+1DAY]",
    "group": "facets.categories.modified_date"
  },
  {
    "label": "facets.queries.this_year",
    "query": "cm:modified:[NOW/DAY-1YEAR TO NOW/DAY+1DAY]",
    "group": "facets.categories.modified_date"
  }
]

Pristy Marches uses specific facets for the creation and notification dates of contracts (mm:dateCreation, mm:dateNotification).

SEARCH_USER_QUERY (string) - Dynamic
Solr query template for user search. The %s string is replaced by the search term. Default value (Espaces): "((cm:name:\"%s*\" OR cm:title:\"%s*\" OR cm:description:\"%s*\" OR TEXT:\"%s*\" OR TAG:\"%s*\"))".

Value deposited when Pristy Marchés is initialized (includes business fields): "((cm:name:\"%s*\" OR cm:title:\"%s*\" OR cm:description:\"%s*\" OR TEXT:\"%s*\" OR TAG:\"%s*\" OR mm:objetMarche:\"%s*\" OR mm:numMarche:\"%s*\" OR mm:objetConsultation:\"%s*\" OR mm:numConsultation:\"%s*\" OR mm:infoComplementaire:\"%s*\") AND (ASPECT:\"mm:infosMarche\" OR ASPECT:\"mm:infosConsultation\" OR ASPECT:\"mm:repriseMarches\"))".

PrimeVue Themes

Pristy Portail, Pristy Espaces, Pristy Marchés and Pristy Média now use PrimeVue 4, whose theme is built in: the following options are no longer read by these applications. Pristy Social and Pristy Actes may still use them.

PRIMEVUE_THEMES_URL (string) - No effect
Former base URL of the PrimeVue 3 theme stylesheets.
primeConfig (object) - No effect
Former global PrimeVue 3 configuration (ripple, inputStyle).

Collabora Online

Configuration for online editing with Collabora Online (LibreOffice Online).

COLLABORA_HOSTING_DISCOVERY (string) - Static
URL of the Collabora Online discovery file. Example: "https://demo.pristy.net/espaces/hosting/discovery.xml", "http://localhost:8010/espaces/hosting/discovery.xml".
OPEN_PDF_WITH_COLLABORA (boolean) - Dynamic
Opens PDF files with Collabora Online instead of the native PDF reader. Default value: false.
EDIT_WITH_MSOFFICE (boolean) - Dynamic
Displays the “Edit in Microsoft Office” button to edit Office documents directly (MS-OFBA protocol). Only works on Windows with Office installed. This component is not free software. Default value: false. The configuration deposited when Pristy Espaces, Pristy Marchés and Pristy Média are initialized sets true.
PDF_TOOLS_SYMBOLS (array) - Dynamic
Symbols offered by the Symbol tool of the PDF editor: Remix Icon names, without the ri- prefix. Read by Pristy Espaces, Pristy Marchés and Pristy Média. Default value: ["check-line", "close-line", "check-double-line", "checkbox-blank-circle-fill", "subtract-line", "checkbox-circle-line", "close-circle-line", "question-line", "error-warning-line", "arrow-right-line", "star-fill"].

Analytics and Monitoring

Matomo

Configuration for the Matomo web analytics tool (free alternative to Google Analytics), read by Pristy Portail, Pristy Espaces and Pristy Marchés.

MATOMO_ENABLE (boolean) - Dynamic
Enables or disables Matomo integration. Default value: false.
MATOMO_INSTANCE_URL (string) - Dynamic
URL of the Matomo instance. Example: "https://matomo.example.com". Default value: "not-defined".
MATOMO_SITE_ID (string or number) - Dynamic
Site identifier in Matomo. Example: "1" or 1. Default value: "not-defined".

Interface Options

SHOW_ACA_LOGIN_LINK (boolean) - Dynamic
Displays, on the login page, a link to the Alfresco Content Application interface (ACA_LINK). Default value: false.
MIME_TYPES (array) - Dynamic
MIME types offered in the properties edit window to change a file’s type. Each entry carries a label and a value. Read by Pristy Espaces only. Default value: PDF, plain text, Markdown, HTML, JSON, XML and CSV.

Options without effect

The following options still appear in old configuration files, but no application reads them anymore: changing them changes nothing.

SHOW_FAVORITES (boolean) - No effect
Used to display the “Favorites” section in the Espaces interface.
SHOW_RECENT (boolean) - No effect
Used to display the “Recent Files” section in the Espaces interface.
SHOW_SEARCH (boolean) - No effect
Used to display the search field in the interface.
ALLOWED_FILE_EXTENSIONS (array) - No effect
List of file extensions allowed for upload. No filter is applied.
DASHBOARD_CONFIG (array) - No effect
Former dashboard configuration. Dashboards are now saved in a dashboard-config.json file specific to each application, built with the dashboard editor.

The THEME, ACA_HOST, MENU_* and former OIDC_* options, described above, are in the same situation, as are BREADCRUMB_ROOT_URL, PRIMEVUE_THEMES_URL and primeConfig outside Pristy Actes and Pristy Social.

Security

NEW_PASSWORD_RULES (string) - Dynamic
Password validation rules displayed to the user when changing their password. Only Pristy Portail reads this option. Default value: "no rules" (no rule shown in the password change window). The configuration deposited when Pristy Portail is initialized sets "Le mot de passe doit contenir au moins une lettre majuscule, un chiffre, et un caractère spécial.".

Pristy Espaces

Parameters specific to major features of Pristy Espaces (version 26.0).

COLLAB_ENABLED (boolean) - Dynamic
Enables real-time collaborative editing of text files (Markdown, XML, JSON, etc.) in Pristy Espaces. 26.0 feature, still in beta. Default value: true.
CLASSIFICATION_PLAN_ENABLED (boolean) - Dynamic
Enables the classification plan module in Pristy Espaces (automatic document classification, requalification, hot upload of the plan). Also read by Pristy Marchés. Default value: false; the configuration deposited when Pristy Marchés is initialized sets true.
CLASSIFICATION_PLAN_ALLOW_NO_NATURE (boolean) - Dynamic
Allows importing a file without a nature into a workspace that has a classification plan (not during a requalification). Default value: false.
CLASSIFICATION_PLAN_FULL_VIEW_THRESHOLD (number) - Dynamic
Number of files from which the “Import with a Classification Plan” window adds a progress bar and filters on the file list. Default value: 5.
CLASSIFICATION_PLAN_INLINE_METADATA_THRESHOLD (number) - Dynamic
Maximum number of metadata fields of a nature for them to be entered directly on the file’s row, in the import window. Default value: 3.
CLASSIFICATION_PLAN_NATURE_CODE_PROPERTY (string) - Dynamic
Alfresco property in which to save the nature code of a classified document (for example "pm:natureDocument"). When empty, the code is not saved. Default value: "".
FILENAME_NATURE_DETECTION (boolean) - Dynamic
Automatically suggests a nature based on the name of the files imported with a classification plan. Default value: false; the configuration deposited when Pristy Marchés is initialized sets true.
DASHBOARD_PERSONAL_ENABLED (boolean) - Dynamic
Lets each user save a personal dashboard, which they see instead of the shared dashboard. Default value: true; the configuration deposited when Pristy Espaces and Pristy Marchés are initialized sets false.
SAVED_VIEWS_GLOBAL (array) - Dynamic
Former list of global views, only read when the configuration folder contains no vue-*.json file or cannot be read. Views are now managed from the View Management page. Default value: [].
CHAT_ENABLED (boolean) - Dynamic
Enables the Rocket.Chat chat integration, provided ROCKETCHAT_HOST is set. Read by Pristy Espaces and by the Profile page of Pristy Portail. The chat options are no longer in the structured edition of the Configuration page. Default value: false.
ROCKETCHAT_HOST (string) - Dynamic
URL of the Rocket.Chat server. Default value: "".
ROCKETCHAT_WS_URL (string) - Dynamic
WebSocket URL of the Rocket.Chat server, derived from ROCKETCHAT_HOST (wss://<host>/websocket) when empty. Default value: "".
CHAT_OAUTH_ENABLED (boolean) - Dynamic
Enables OAuth authentication for Rocket.Chat (requires an OAuth configuration on the Rocket.Chat server). Default value: false.
CHAT_OAUTH_SERVICE (string) - Dynamic
Name of the OAuth service configured in Rocket.Chat. Default value: "keycloak".

Pristy Marchés

CLASSIFICATION_PLAN_NAME (string) - Dynamic
Name of the global classification plan file (for example plan-marches.json), chosen from the Classification Plan page. Default value: ""; the configuration deposited when Pristy Marchés is initialized sets "plan-marches.json".
SHOW_MONTANT_MARCHE (boolean) - Dynamic
Shows the “Market price excl. tax” field in the consultation creation and modification forms. Default value: false.

Pristy Média

DIFFUSION_ENABLED (boolean) - Dynamic
Adds the “Diffusion settings” action on acts workspaces. Default value: false; the configuration deposited when Pristy Média is initialized sets true.
WORKSPACE_TYPE_ACTES_ENABLED (boolean) - Dynamic
Offers the “Administrative acts” workspace type when creating a workspace. Default value: false.
WORKSPACE_TYPE_GALLERY_ENABLED (boolean) - Dynamic
Offers the “Multimedia galleries” workspace type when creating a workspace. Default value: false; the configuration deposited when Pristy Média is initialized sets true.

Pristy Actes

Parameters specific to the Pristy Actes application for administrative acts management.

WEBDELIB (boolean) - Static
Enables WebDelib integration. Default value: false.
DELIB_PUBLICATION (string) - Static
Kafka topic set in pk:topic when an act is published, in legacy mode. Default value: "add-tampon-actes".
DELIB_PUBLICATION_MODE (string) - Static
Act publication mode: legacy sets pk:topic for pristy-kafka-pdf-tampon, processor requests the tampon task of pristy-processor-tampon, which must be enabled in Pristy Core (pristy.task.enabled). Default value: "legacy".
HIDE_SEANCE (boolean) - Static
Hides the display of sessions. Default value: false.

Last Update - November 5, 2026
Call To Action 📣

Try Pristy

You can try the Pristy demo by signing up using the link below.

Demander une démo