Configuration

General Configuration

Lodex utilizes the node-config package to manage its internal settings. These parameters are determined at boot time and are immutable at runtime. If you modify any part of this configuration, a full restart of the Lodex container is mandatory for the changes to take effect.

Configuration Methods

There are two primary ways to override the default configuration when using Docker:

1. Via Environment Variable (NODE_CONFIG)

The most convenient method for quick adjustments within docker-compose.yml is the NODE_CONFIG variable. This allows you to pass a JSON string directly as an environment variable.

YAML

services:
  lodex:
    environment:
      - NODE_CONFIG={"ezs": {"timeout":60000 } }

2. Via Local Configuration File (local-production.json)

For more complex or extensive configurations, you can use a dedicated JSON file. By default, Lodex looks for a file named local-production.json in its configuration folder. To use this with Docker, you must mount the file as a volume:

YAML

services:
  lodex:
    volumes:
      - ./my-config.json:/app/config/local-production.json

Priority: The NODE_CONFIG environment variable usually takes precedence over file-based configurations. Ensure you are not defining the same parameter in both places to avoid confusion.

ezmaster: With ezmaster, the file local-producation.json can be edited directly via the ezmaster interface and the configuration icon.

An instance can be configured from the Lodex interface in the settings menu. Lodex provides access to a configuration file in JSON format, which mainly allows you to adjust the appearance of Lodex, the menus, the theme colors, and the breadcrumb trail.

• front.breadcrumb: The list of the items displayed in the breadcrumb trail. The last item is not displayed on root page of the site. By default the list is empty. Each item contains:
  • label: An object to specify the breadcrumb item label in each language eg: { "fr": "Accueil", "en": "Home" }
  • url: the URL where to go
  • isExternal : the URL is external to the current website (true or false, default is false)

 {
     "label": {
         "en": "Data Istex",
         "fr": "Données Istex"
      },
      "url": "http://localhost:3000",
      "isExternal": false
 }

• front.menu: The list of item displayed in the site menu. The order of the item in the array is the order of item in the menu. Each item contains:
  • label: An object to specify the menu label in each language eg: { "fr": "Accueil", "en": "Home" }
  • icon: The icon used in the menu, can be either a fontAwesome icon name. Careful the name must be in camel case, so fa-home become faHome. Or a custom svg file added in the theme. Note that an icon loaded from a file will not change color on hover and active.
  • position: left, right or advanced, tell where to display the menu item on the menu. If advanced is selected, the item will be added in the advanced menu.
  • role: The role of the menu, cab be either:
    • home: allow to navigate to the home of the site
    • resources: Allow to navigate to the list of resources (/graph)
    • graphs: Open the list of graph sub menu
    • search: Open the search panel
    • admin: Navigate to the admin. (This will only appear when logged as an admin)
    • sign-in: Link to login to the site. (This will only appear if not logged)
    • sign-out: Link to logout from the site. (This will only appear if logged)
    • custom: Add a custom link. The url is given by the link key.
    • link: The link used when in custom role, will be ignored otherwise. You can add external link as well as internal link. For internal link, simply point to the html file in the custom theme folder. For example to add an about page with a custom icon:

{
    "label": {
        "en": "About",
        "fr": "A propos"
    },
    "icon": "/about.svg",
    "position": "left",
    "role": "custom",
    "link": "/about.html"
}

By default the menu is:

[
      {
        "label": {
                "en": "Home",
                "fr": "Accueil"
        },
        "icon": "faHome",
        "position": "left",
        "role": "home"
      },
      {
        "label": {
                "en": "Resources",
                "fr": "Ressources"
        },
        "icon": "faList",
        "position": "left",
        "role": "resources"
      },
      {
        "label": {
                "en": "Graphs",
                "fr": "Graphiques"
        },
        "icon": "faChartArea",
        "position": "advanced",
        "role": "graphs"
      },
      {
        "label": {
                "en": "Search",
                "fr": "recherche"
        },
        "icon": "faSearch",
        "position": "right",
        "role": "search"
      },
      {
        "label": {
                "en": "Admin",
                "fr": "Admin"
        },
        "icon": "faCogs",
        "position": "advanced",
        "role": "admin"
      },
      {
        "label": {
                "en": "Sign in",
                "fr": "Connexion"
        },
        "icon": "faSignInAlt",
        "position": "advanced",
        "role": "sign-in"
      },
      {
        "label": {
                "en": "Sign out",
                "fr": "Déconnexion"
        },
        "icon": "faSignOutAlt",
        "position": "advanced",
        "role": "sign-out"
      }
]