Référence du fichier de configuration

Cet article a été traduit de l'anglais par IA et peut contenir des erreurs. Vos commentaires nous aideront à l'améliorer.

Au démarrage, le serveur ActivityInfo lit sa configuration à partir d'un fichier nommé config.ini, dont l'emplacement dépend du type d'installation :

  • Windows : C:\Program Files\ActivityInfo\config.ini, ou le même répertoire que activityinfo.exe
  • Debian : /opt/activityinfo/config.ini
  • Docker : la racine du volume activityinfo.
  • Autre : le répertoire de travail actuel

Le fichier de configuration se compose d'un certain nombre de sections nommées dans lesquelles des paires clé-valeur sont définies. Les noms de clés ne sont pas sensibles à la casse.

Par exemple :

[Server]
Http Port=80
Https Port=443

[Data]
Data Directory = /opt/activityinfo/data

[Mail]
Enabled = True
Sender Address = notifications@activityinfo.org
Host = smtp.postmarkapp.com
Port = 25

Section Serveur

La section Serveur configure le serveur Web.

Clé Description Valeur par défaut
Http Port Le port TCP sur lequel écouter les connexions HTTP. 8081
Https Port Le port TCP sur lequel écouter les connexions HTTPS. 8081
Https Proxy Si « True », ActivityInfo n'écoutera pas les connexions HTTPS, mais s'attendra à ce qu'un proxy en amont ou un équilibreur de charge fournisse la terminaison SSL. 8081
Domain Le nom d'hôte du serveur. Ceci est utilisé lors de la redirection de http vers https, et dans les URL incluses dans les e-mails envoyés aux utilisateurs. localhost

Section Données

La section Données spécifie où ActivityInfo doit stocker ses données.

Clé Description Valeur par défaut
Data Directory Le répertoire où ActivityInfo stocke ses fichiers de base de données. Répertoire de travail actuel

Section E-mail

La section E-mail configure la façon dont ActivityInfo envoie des e-mails de notification, par exemple, des invitations à un utilisateur lorsqu'il est invité à accéder à une base de données, ou des e-mails de réinitialisation de mot de passe. Actuellement, le serveur autogéré ActivityInfo ne prend en charge que l'envoi d'e-mails via SMTP.

Clé Description Valeur par défaut
Enabled Vrai si le serveur doit envoyer des e-mails, ou Faux si le serveur ne doit pas envoyer d'e-mails. False
Sender Address L'adresse e-mail utilisée comme adresse « De » lorsque le serveur envoie des e-mails. admin@localhost
Host Le nom d'hôte du serveur SMTP localhost
Port Le numéro de port TCP du serveur SMTP 25
Username Le nom d'utilisateur à utiliser lors de l'authentification auprès du serveur SMTP
Password Le mot de passe à utiliser lors de l'authentification auprès du serveur SMTP

Fournisseurs d'identité

ActivityInfo prend en charge l'authentification unique (SSO) via des fournisseurs d'identité (IdP) externes. Chaque IdP est configuré dans sa propre section, nommée « IdP » par exemple :

[MyAzure IdP]
Type = OPENID_CONNECT
URL = https://login.microsoftonline.com/common/v2.0
Client ID = XYZ1234
Client Secret = ZDFSDF
Email Domains = example.gov, partner.org

[Google IdP]
Type = OPENID_CONNECT
URL = https://accounts.google.com
Client ID = XYZ1234
Client Secret = ZDFSDF
Email Domains = gmail.com, bedatadriven.com

[AD IdP]
Type = ADSI

Notez que l'ID de fournisseur, « My Azure » et « Google » dans les exemples ci-dessus, est arbitraire. Vous pouvez choisir n'importe quel nom correspondant au modèle [A-Za-z]{1,15}.

Le serveur autogéré ActivityInfo prend en charge les fournisseurs OpenID Connect.

Fournisseurs OpenID Connect

Pour les fournisseurs OpenID Connect, les clés suivantes sont obligatoires :

Clé Description
Type OPENID_CONNECT
URL L'URL de base OpenID Connect
Client ID L'ID client émis par le fournisseur
Client Secret Le secret client émis par le fournisseur
Email domains Une liste séparée par des virgules des domaines de messagerie qui doivent s'authentifier via ce fournisseur.

Intégrations d'API externes

Clé Description Valeur par défaut
Mapbox Public Access Token Le jeton d'accès public pour votre compte Mapbox. Vide

Section Sécurité

Remarque : ces options sont disponibles à partir de la version 4.1.3 du serveur autonome.

Clé Description Valeur par défaut
Strict Transport Security Activé, Test ou Désactivé.
Ajoute l'en-tête Strict-Transport-Security à toutes les requêtes, garantissant que les utilisateurs accèdent à ActivityInfo uniquement via une connexion sécurisée et chiffrée.
Désactivé
Account Disclosure Activé ou Désactivé.
Détermine si le serveur est autorisé à divulguer si un compte d'utilisateur existe ou non. S'il est activé, le serveur informera les utilisateurs lorsque leur e-mail est incorrect ou non enregistré auprès du système, ce qui rend ActivityInfo plus accessible. Cependant, il permet aux attaquants de déterminer si un utilisateur donné a un compte ou non.
Activé
XSS Protection Activé ou Désactivé.
Détermine si le serveur envoie l'en-tête X-XSS-Protection avec la valeur 1 ; mode=block. Cet en-tête est obsolète et n'est pas recommandé car il peut bloquer les requêtes légitimes.
Désactivé

Utilisation des variables d'environnement

À partir de la version 4.0.15, ActivityInfo peut également lire certains paramètres à partir de variables d'environnement, sous la forme « ACTIVITY_{SECTION}_{KEY NAME} », où les espaces sont remplacés par des traits de soulignement.

Par exemple :

  • ACTIVITYINFO_SERVER_HTTP_PORT
  • ACTIVITYINFO_SERVER_HTTPS_PORT
  • ACTIVITYINFO_SERVER_HTTPS_PROXY
  • ACTIVITYINFO_DATA_DATA_DIRECTORY
  • ACTIVITYINFO_MAIL_ENABLED
  • ACTIVITYINFO_MAIL_SENDER_ADDRESS
  • ACTIVITYINFO_MAIL_HOST
  • ACTIVITYINFO_MAIL_PORT

Si une clé est présente à la fois dans le fichier de configuration et dans une variable d'environnement, le fichier de configuration est prioritaire.

Élément suivant
Installation Red Hat