L’essentiel
La configuration de Phraseanet se fait via le fichier config/configuration.yml. A chaque mise à jour de celle-ci, il est nécessaire de recompiler la configuration via la commande suivante :
`bin/console compile:configuration`.
La configuration de Phraseanet est écrite dans le fichier config/configuration.yml qui est automatiquement généré à l’installation.
Ce fichier est au format YAML, qui a pour intérêt d’être très lisible. Pour des raisons de performance, et notamment de cache opcode, la configuration est compilée.
En contre partie il est nécessaire de recompiler après une mise à jour.
La compilation de la configuration est très facile et rapide à éxecuter. Il faut utiliser la commande bin/console compile:configuration.
bin/console compile:configuration
Voici un exemple de fichier de configuration commenté
servername: 'http://192.168.1.170/' # (string) L'URL à partir de laquelle est accessible Phraseanet
languages:
available: # (array) Un tableau de code de langues actives. Toutes les langues sont activées si le tableau est vide
- fr
- en
default: fr # (string) La langue de l'application par défaut
main:
maintenance: false # (boolean) Activation du mode maintenance
api_require_ssl: false # (boolean) Force SSL pour les requêtes d'API Phraseanet
database: # (array) Configuration du serveur de base de données
host: 127.0.0.1
port: '3306'
user: phraseanet
password: phraseanet
dbname: ab_alch_phraseavm
driver: pdo_mysql
charset: UTF8
database-test: # (array) Configuration pour les tests (développeurs uniquement)
driver: pdo_sqlite
path: /tmp/db.sqlite
charset: UTF8
cache: # (array) Configuration du service de cache
type: MemcacheCache
options:
host: localhost
port: 11211
opcodecache: # (array) Configuration du service de cache opcode
type: ArrayCache
options: { }
search-engine: # (array) Configuration Elasticsearch
type: elasticsearch
options:
host: 127.0.0.1
port: 9200
index: phraseanet_86a108b98a5aa92431bf94a42e8d3d3f
shards: 3
replicas: 0
minScore: 2
highlight: false
maxResultWindow: 500000
populate_order: RECORD_ID
populate_direction: DESC
activeTab: '#elastic-search' # (string) Nom de l'onglet actif pour la rubrique Paramètre du moteur de recherche
base_aggregate_limit: 10 # (integer) Paramétrage de la facette base à 10 valeurs
collection_aggregate_limit: 10# (integer) Paramétrage de la facette collections à 10 valeurs
doctype_aggregate_limit: 10 # (integer) Paramétrage de la facette type de documents à 10 valeurs
camera_model_aggregate_limit: 0
iso_aggregate_limit: 0
aperture_aggregate_limit: 0
shutterspeed_aggregate_limit: 0
flashfired_aggregate_limit: 0
framerate_aggregate_limit: 0
audiosamplerate_aggregate_limit: 0
videocodec_aggregate_limit: 0
audiocodec_aggregate_limit: 0
orientation_aggregate_limit: 0
colorspace_aggregate_limit: 0
mimetype_aggregate_limit: 0
key: 86a108b98a5aa92431bf94a42e8d3d3f # (string) La clé de l'application
task-manager:
logger:
enabled: true # (boolean) Active les logs dans le système de fichier
max-files: 10 # (integer) Le nombre maximum de fichiers de log à conserver
level: INFO # (string) Le niveau de log minimum
enabled: true
status: started
options:
protocol: tcp
host: 127.0.0.1
port: 6660
linger: 500
storage: # (array) Configuration des chemins de stockage
cache: /var/www/Phraseanet/cache
log: /var/www/Phraseanet/logs
download: /var/www/Phraseanet/tmp/download # (string) Le répertoire de stockage des fichiers en téléchargement
lazaret: /var/www/Phraseanet/tmp/lazaret # (string) Le répertoire de stockage des fichiers en quarantaine
caption: /var/www/Phraseanet/tmp/caption # (string) Le répertoire de stockage des éléments affichés au survol d'un enregistrement
subdefs: /var/www/phrasea_datas/ # (string) Le répertoire de stockage générique pour les fichiers de sous-définition
binaries: # (array) Configuration des executables externes
php_binary: /usr/bin/php
phraseanet_indexer: /usr/local/bin/phraseanet_indexer
swf_extract_binary: /usr/local/bin/swfextract
pdf2swf_binary: /usr/local/bin/pdf2swf
swf_render_binary: /usr/local/bin/swfrender
unoconv_binary: /usr/bin/unoconv
ffmpeg_binary: /usr/bin/ffmpeg
mp4box_binary: /usr/bin/MP4Box
pdftotext_binary: /usr/bin/pdftotext
recess_binary: /usr/local/bin/recess
bridge: # (array) Configuration pour le Bridge Phraseanet (dépréciée)
youtube:
enabled: false
client_id: ''
client_secret: ''
developer_key: ''
flickr:
enabled: false
client_id: ''
client_secret: ''
dailymotion:
enabled: false
client_id: ''
client_secret: ''
trusted-proxies: { } # (array) Configuration des proxies de confiance
debugger:
allowed-ips: { }
border-manager: # (array) Configuration du service douanes Phraseanet
enabled: true # (boolean) Activation du service de douane
checkers:
-
type: Checker\Sha256 # (array) Verification de doublonnage par somme de contrôle
enabled: true
-
type: Checker\UUID # (array) Verification de doublonnage par métadonnée UUID
enabled: true
-
type: Checker\Colorspace # (array) Verification de l'espace colorimétrique par le profil ICC
enabled: false
options:
colorspaces:
- cmyk
- grayscale
- rgb
-
type: Checker\Dimension # (array) Verification pour des dimensions minimales requises
enabled: false
options:
width: 80
height: 160
-
type: Checker\Extension # (array) Verification d'extension
enabled: false
options:
extensions:
- jpg
- jpeg
- bmp
- tif
- gif
- png
- pdf
- doc
- odt
- mpg
- mpeg
- mov
- avi
- xls
- flv
- mp3
- mp2
-
type: Checker\Filename # (array) Verification de doublonnage par nom de fichier
enabled: false
options:
sensitive: true
-
type: Checker\MediaType # (array) Verification du type de document
enabled: false
options:
mediatypes:
- Audio
- Document
- Flash
- Image
- Video
authentication: # (array) Configuration de l'authentification
auto-create:
templates: { } # (string) Nom du modèle de droits appliqué lorsque l'auto-inscription est activé
captcha:
enabled: true
trials-before-display: 9
providers: # (array) Configuration de l'authentification par des services tiers (à tester)
facebook: # (array) Configuration de l'authentification via Facebook (à tester)
enabled: false # (boolean) Active ou désactive l'authentification par le fournisseur
options:
app-id: '' # (string) Identifiant (id) Facebook
secret: '' # (string) Secret (secret) Facebook
twitter: # (array) La configuration de l'authentification par twitter (à tester)
enabled: false
options:
consumer-key: ''
consumer-secret: ''
google-plus: # (array) La configuration de l'authentification par google-plus (testé et fonctionnel)
enabled: false
options:
client-id: ''
client-secret: ''
github: # (array) La configuration de l'authentification par github (testé et fonctionnel)
enabled: false
options:
client-id: ''
client-secret: ''
viadeo: # (array) La configuration de l'authentification par Viadeo est dépréciée
enabled: false
options:
client-id: ''
client-secret: ''
linkedin: # (array) La configuration de l'authentification par linkedin (à tester)
enabled: false
options:
client-id: ''
client-secret: ''
registration-fields: # (array) Configuration des champs optionnels disponibles sur le formulaire d'inscription lorsqu'activé
-
name: firstname
required: true
-
name: lastname
required: true
-
name: geonameid
required: true
-
name: company
required: true
xsendfile: # (array) Configuration Sendfile (Nginx) / XSendFile (Apache)
enabled: false # (array) Active, désactive Sendfile
type: nginx # (string) Type XSendFile (`nginx` ou `apache`)
mapping: { } # (array) Mapping des dossiers (voir configuration for :ref:`Apache<apache-xsendfile>` and :ref:`Nginx<nginx-sendfile>`)
plugins: { } # (array) Configuration des :doc:`plugins <Plugins>`.
h264-pseudo-streaming:
enabled: false
type: null
mapping: { }
api_cors:
enabled: false # (boolean) Activation du CORS sur l'API
allow_credentials: false # (boolean) Inclus les cookies dans les requêtes CORS
allow_origin: { } # (array) La liste des domaines autorisés à envoyer des requêtes sur l'API
# '*' pour autoriser les demandes de toutes origines
allow_headers: { } # (array) La liste des headers supportés par le serveur
allow_methods: {'GET', 'POST', 'PUT'} # (array) La liste des methodes HTTP supportées
expose_headers: { } # (array) La liste des headers exposés autres que Cache-Control, Content-Language, Content-Type, Expires, Last-Modified, Pragma
max_age: 0 # (integer) Autorise la réponse "preflight" à être cachée pour X secondes
hosts: { } # (array) Liste des noms de domaine ou le CORS est activé
session: # (array) Configuration des validés des sessions
idle: 0
lifetime: 604800
crossdomain: # (array) Configuration de cross-domain
allow-access-from:
-
domain: '*.cooliris.com'
secure: 'false'
static-file:
enabled: true # (boolean) Active les vignettes statiques
type: apache # (string) Type StaticFile (`nginx` ou `apache`)
mapping:
mount-point: /thumb
directory: ''
registry: # (array) Paramètres de l'application
general:
title: 'Phraseanet V4.0 (VM)' # (string) Nom donné à l'instance
keywords: null # (string) Contenu de la balise META NAME="keywords"
description: null # (string) Contenu de la balise META NAME="description"
analytics: null
allow-indexation: true
home-presentation-mode: CAROUSEL
default-subdef-url-ttl: 7200
modules:
thesaurus: true
stories: true
doc-substitution: true
thumb-substitution: true
anonymous-report: false
actions:
download-max-size: 120
validation-reminder-days: 2
validation-expiration-days: 10
auth-required-for-export: true
tou-validation-required-for-export: false # (boolean) Faire valider par l'utilisateur les Conditions générales d'utilisation lors des téléchargements
export-title-choice: false # (boolean) Permettre le choix par l'utilisateur des noms de fichiers lors de téléchargement
default-export-title: title # (string) Nom attribué de fichier téléchargé
social-tools: all
enable-push-authentication: false
force-push-authentication: false
enable-feed-notification: true
export-stamp-choice: false
download-link-validity: 24 # (integer) Durée de validité des liens de téléchargement en heures
ftp:
ftp-enabled: true
ftp-user-access: true
registration:
auto-select-collections: true
auto-register-enabled: true
maintenance:
message: 'Under maintenance'
enabled: false
api-clients:
api-enabled: true
navigator-enabled: true
office-enabled: true
webservices:
google-charts-enabled: true
geonames-server: 'https://geonames.alchemyasp.com/' # (string) Adresse du serveur Geonames Alchemy (mettre null si non accessible)
captchas-enabled: false
recaptcha-public-key: ''
recaptcha-private-key: ''
captcha-enabled: false
executables:
h264-streaming-enabled: false
auth-token-directory: null
auth-token-directory-path: null
auth-token-passphrase: null
php-conf-path: null
imagine-driver: ''
ffmpeg-threads: 2
pdf-max-pages: 5
searchengine:
min-letters-truncation: 1
default-query: all
default-query-type: 0
email: # (array) Paramétrage optionnel, selon contexte, pour l'envoi des e-mails
emitter-email: vm@alchemy.fr
prefix: 'Phraseanet VM -'
smtp-enabled: true
smtp-auth-enabled: true
smtp-host: smtp.gmail.com
smtp-port: '465'
smtp-secure-mode: ssl
smtp-user: vm@alchemy.fr
smtp-password: 'mysmtppassword'
admin-email: nobody@nodomaine
web-applications:
email-optional-for-login: false
custom-links: # (array) Paramétrage pour liens optionnels dans la barre de menu ou le menu d'aide
-
linkName: 'Phraseanet store'
linkLanguage: fr
linkUrl: 'https://alchemy.odoo.com/shop'
linkLocation: help-menu
linkOrder: 1
linkBold: false
linkColor: ''
-
linkName: 'Phraseanet store'
linkLanguage: en
linkUrl: 'https://alchemy.odoo.com/en_US/shop'
linkLocation: navigation-bar
linkOrder: 1
linkBold: false
linkColor: ''
user-settings: # (array) Tableau de valeurs par défaut pour les préférences utilisateurs
images_per_page: 60
images_size: 200
embed_bundle: # (array) Configuration de Embed Bundle
video:
player: videojs # (array) Active le lecteur videojs (seul choix possible)
autoplay: false # (boolean) Active, désactive la lecture automatique des vidéos dans le lecteur
video_message_start: StartOfMessage # (string) Le nom du champ documentaire ou est stockée la valeur de début de lecture en seconde
coverSubdef: previewx4 # (string) Sous-définition utilisée pour la présentation hors lecture dans le lecteur
available-speeds: # (array) Vitesses de lecture disponibles dans le lecteur
- 1
- 1.5
- 3
audio:
player: videojs # (array) Active le lecteur videojs pour la lecture audio (seul choix possible)
autoplay: false # (boolean) AActive, désactive la lecture automatique des documents audio dans le lecteur
document:
player: flexpaper
enable-pdfjs: true # (boolean) Utiliser pdfjs comme visionneuse pour les documents PDF
Les langues disponibles ainsi que leurs codes respectifs sont les suivants :
Les différents fournisseurs d’authentification se configurent simplement. Il suffit de créer une application “Phraseanet” chez le fournisseur en spécifiant l’URL de callback adéquate.
Note
Les URLs de callback fournies sont des exemples présupposant que Phraseanet est installé à l’adresse http://phraseanet.mondomaine.com. Il faut adapter ces URLs en fonction de l’adresse réelle.
Les services de cache cache et opcode-cache peuvent être configurés avec les adapteurs suivants :
| Nom | Service | Description | Options |
|---|---|---|---|
| MemcacheCache | cache | Serveur de cache utilisant l’extension PHP Memcache | host, port |
| MemcachedCache | cache | Serveur de cache utilisant l’extension PHP Memcached | host, port |
| RedisCache | Cache | Serveur de cache utilisant l’extension PHP redis | host, port |
| ApcCache | opcode-cache | Cache opcode utilisant PHP APC | |
| XcacheCache | opcode-cache | Cache opcode utilisant PHP Xcache | |
| WinCacheCache | opcode-cache | Cache opcode utilisant PHP WinCache | |
| ArrayCache | cache | opcode-cache | Cache désactivé |
Les sessions sont stockées par défaut sur le disque, dans le système de fichiers.
Il est possible d’utiliser d’autres types de stockage :
| Type | Description | Options |
|---|---|---|
| file | Stockage des sessions sur le disque | |
| memcache | Stockage des sessions dans un serveur Memcached, utilise l’extension PHP memcache | host, port |
| memcached | Stockage des sessions dans un serveur Memcached, utilise l’extension PHP memcached | host, port |
| redis | Stockage des sessions dans un serveur Redis, utilise l’extension PHP redis | host, port |
Avertissement
Le paramétrage de la durée de vie (ttl) de la session ne fonctionne pas avec la gestion par le système de fichiers. Dans ce cas, utiliser le paramétrage gc_maxlifetime de PHP.
Seul le moteur de recherche Elasticsearch est disponible.
| Nom | Options |
|---|---|
| Alchemy\Phrasea\SearchEngine\Elastic\ElasticSearchEngine | host, port, index |
Si Phraseanet est derrière un reverse-proxy, renseigner l’adresse du reverse proxy pour que les adresses IP des utilisateurs soient reconnues.
trusted-proxies:
192.168.27.15
10.0.0.45
La section registration-fields permet de personnaliser les champs disponibles dans le formulaire de la page d’inscription ainsi que leur caractère obligatoire.
registration-fields:
-
name: firstname
required: true
-
name: lastname
required: true
-
name: company
required: false
| id | Nom (déprécié) |
| login | Identifiant |
| gender | Sexe |
| firstname | Prénom |
| lastname | Nom |
| address | Adresse |
| zipcode | Code Postal |
| geonameid | Ville, Pays |
| position | Poste |
| company | Société |
| job | Activité |
| tel | Téléphone |
| fax | Fax |
Note
Dans le formulaire d’inscription, il n’est possible de remplir la ville et pays de l’utilisateur que par le Geonameid. Geonameid n’est fonctionnel que si le webservice https://geonames.alchemyasp.com est utilisé.
Dans le cas ou l’instance Phraseanet ne peut pas accéder au serveur Geonames indiquer null comme adresse du serveur Geonames dans la configuration.
Dans ce contexte, ne pas indiquer geonameid dans le formulaire d’inscription.
La configuration xsendfile doit être manipulée à l’aide des outils en ligne de commandes. Les documentations pour Nginx et Apache sont disponibles.
Les plugins se configurent aussi dans ce fichier. Se référer à la documentation des plugins pour cette partie.
Les points de vérification du service de douane sont configurables. Il est aussi possible de créer son propre point de vérification.
| Verification | Description | Options |
|---|---|---|
| CheckerSha256 | Vérifie si le fichier n’est pas un doublon En se basant sur la somme de controle “sha256” | |
| CheckerUUID | Vérifie si le fichier n’est pas un doublon En se basant sur l’identifiant unique du fichier | |
| CheckerDimension | Vérification sur les dimensions du fichier (* si applicable) | width : largeur mini du fichier height : hauteur mini du fichier |
| CheckerExtension | Vérification sur les extensions du fichiers | extensions : les extensions de fichiers autorisées |
| CheckerFilename | Vérifie si le fichier n’est pas un doublon En se basant sur son nom | sensitive : active la sensibilité à la casse |
| CheckerMediaType | Vérification sur le type du fichier (Audio, Video...) | mediatypes : les types de médias autorisés |
| CheckerColorspace | Vérification sur l’espace de couleur du fichier (* si applicable) | colorspaces : les types d’espaces colorimétriques autorisés |
Le service de douane permet également de personnaliser la détection des types mime via le paramètre extension-mapping. Sur certains systèmes, des mauvais types mimes peuvent être détectés. Utiliser ce tableau pour forcer un type mime en fonction d’une extension de fichier.
Il est possible de restreindre la portée d’un point de vérification sur un ensemble de collections en fournissant une liste de base_id correspondant :
#services.yml
Border:
border_manager:
type: Border\BorderManager
options:
enabled: true
checkers:
-
type: Checker\Sha256
enabled: true
collections:
- 4
- 5
La même restriction peut être faite au niveau des databoxes :
#services.yml
Border:
border_manager:
type: Border\BorderManager
options:
enabled: true
checkers:
-
type: Checker\Sha256
enabled: true
databoxes:
- 3
- 7
Note
Il n’est pas possible de restreindre à la fois sur des databoxes et des collections.
Tous les points de vérifications sont déclarés dans le namespace Alchemy\Phrasea\Border\Checker. Il suffit de créer un nouvel objet dans ce namespace. Cet objet doit implémenter l’interface Alchemy\Phrasea\Border\Checker\Checker
Exemple d’un point de vérification qui filtre les documents sur leurs données GPS :
<?php
namespace Alchemy/Phrasea/Border/Checker;
use Alchemy\Phrasea\Border\File;
use Doctrine\ORM\EntityManager;
use MediaVorus\Media\DefaultMedia as Media;
class NorthPole implements Checker
{
private $options;
public function __construct(Array $options)
{
$this->options = $options;
}
//Contrainte de validation, doit retourner un booleen
public function check(EntityManager $em, File $file)
{
$media = $file->getMedia();
if (null !== $latitude = $media->getLatitude() && null !== $ref = $media->getLatitudeRef()) {
if($latitude > 60 && $ref == Media::GPSREF_LATITUDE_NORTH) {
return true;
}
}
return false;
}
}
Déclaration du point de contrôle
border-manager:
enabled: true
checkers:
-
type: Checker\NorthPole
enabled: true
Il est possible de personnaliser les préférences utilisateur par défaut. Les paramètres suivants sont ajustables :
| Nom | Description | Valeur par défaut | Valeurs disponibles |
|---|---|---|---|
| view | Affichage des résultats | thumbs | thumbs (en vignettes) list (en liste) |
| images_per_page | Nombre d’image par page de résultat | 20 | |
| images_size | Taille des vignettes de résultat | 120 | |
| editing_images_size | Taille des vignettes d’édition | 134 | |
| editing_top_box | Taille du bloc supérieur d’édition (pourcentage) | 30 | |
| editing_right_box | Taille du bloc droit d’édition (pourcentage) | 48 | |
| editing_left_box | Taille du bloc gauche d’édition (pourcentage) | 33 | |
| basket_sort_field | Index de tri des paniers | name | name (par nom) ou date (par date) |
| basket_sort_order | Ordre de tri des paniers | ASC | ASC (ascendant) ou DESC (descendant) |
| warning_on_delete_story | Alerter avant la suppression d’un reportage | true | true (oui) ou false (non) |
| client_basket_status | Afficher les paniers dans Classic | 1 | 1 (oui) ou 0 (non) |
| css | Theme CSS de production | 000000 | 000000 (sombre) ou 959595 (clair) |
| advanced_search_reload | Utiliser les dernières options de recherche au chargement | 1 | 1 (oui) ou 0 (non) |
| start_page_query | Question par défaut | last | |
| start_page | Page de démarrage de production | QUERY | PUBLI (publications) ou QUERY (recherche) ou LAST_QUERY (dernière recherche) |
| rollover_thumbnail | Affichage au rollover | caption | caption (notice) ou preview (prévisualisaton) |
| technical_display | Afficher les informations techniques | 1 | 1 (oui) ou 0 (non) ou group (groupé avec la notice) |
| doctype_display | Afficher une icone correspondante au type de document | 1 | 1 (oui) ou 0 (non) |
| basket_caption_display | Afficher la notice des enregistrements dans un panier | 0 | 1 (oui) ou 0 (non) |
| basket_status_display | Afficher les status des enregistrements dans un panier | 0 | 1 (oui) ou 0 (non) |
| basket_title_display | Afficher le titre des enregistrements dans un panier | 0 | 1 (oui) ou 0 (non) |
Fixe (en secondes) la durée d’inactivité de l’utilisateur avant déconnexion automatique.
Le réglage “idle” est prioritaire sur le réglage “lifetime” et l’option “Se souvenir de moi” n’est alors pas présente sur la page d’accueil.
En cochant “Se souvenir de moi” à l’authentification, durant cette période (en secondes) l’accès à l’application est immédiat sans avoir à se ré-authentifier.
Booléan qui active ou désactive le lazyload des vignettes dans production, cette option est obsolète si l’option “static-file” est activé pour l’affichage des vignettes.
En activant cette option, les vignettes sont servies comme contenu statique. Un lien symbolique est créé pour chaque image.
static-file:
enabled: true
type: nginx
symlink-directory: ''
Phraseanet inclut le lecteur Videojs pour lecture des prévisualisations des documents de type audio et vidéo.
Il peut être personnalisé :
embed_bundle: # (array) Configuration de embed bundle
video:
player: videojs # (array) Active videojs comme lecteur de prévisualisations vidéos - seul choix possible
autoplay: false # (boolean) Active la lecture automatique de la prévisualisation vidéo
video_message_start: StartOfMessage # (string) Le nom du champ documentaire ou est stockée la valeur de début de lecture en seconde
coverSubdef: previewx4 # (string) Définit la sous-définition de type image utilisé pour présenter le lecteur hors lecture
available-speeds: # (array) Vitesses de défilement disponibles dans le lecteur
- 1
- 1.5
- 3
audio:
player: videojs # (array) Active vidéojs comme lecteur de prévisualisations audio
autoplay: false # (boolean) Active la lecture automatique de la prévisualisation audio
Note
La lecture à haute vitesse a des impacts sur la consomation de bande passante.
La visionneuse Pdf.js peut être utilisée pour l’affichage de prévisualisations des documents PDF en remplacement de la visionneuse FlexPaper utilisée par defaut.
Pdfjs permet la lecture de fichiers PDF par le navigateur tandis que FlexPaper nécessite que le plugin Adobe Flash Player soit installé et activé pour le navigateur ainsi qu’autorisé, cas échéant, pour l’instance Phraseanet consultée.
embed_bundle:
document:
player: flexpaper # (string) Pour les documents Office, utiliser flexpaper ou pdfjs
enable-pdfjs: true # (boolean) Utiliser pdfjs comme lecteur de prévisualisation pour les documents PDF
Note
Flexpaper ou Pdfjs peuvent être utilisés pour la lecture des fichiers de prévisualisation de documents Microsoft Office. Paramétrer la sous-définition Preview pour les documents de type Document en fonction du choix de paramétrage du lecteur utilisé.