Manage AtoM configuration files¶

config/app.yml¶

This is the primary file where AtoM-specific settings that cannot be managed via the user interface are maintained. This file includes settings such as:

• Global digital object upload limit (in gigabytes) - can be set to -1 for unlimited, or set to a specific limit in GBs.
• Timeout limit for fetching digital objects from external services (in seconds) - default value is 10s
• Which cache engine you want to use (can use Memcached for a distributed cache, for example) - default is sfAPCCache
• Enable read-only mode, if you want to remove the login button and prevent users from logging into the application.
• Set a Google Maps API key (for use in the Archival institution template, to generate dynamic Google Maps)
• Set a Google Analytics API key, for basic installation-wide analytics via Google
• Enable htmlpurifier - limits HTML on static pages to a white-list of approved elements and attributes, to prevent XSS - see: Static pages and security configuration for more information.

Important

Symfony (the PHP framework that AtoM uses) has a cascading system of priorization for configuration files - if you create an app.yml file in apps/qubit/config/, its settings will override those found in config/app.yml. This can be useful if you want to change some configuration values without actually altering AtoM’s installation defaults - Artefactual uses this method for automated deployment via Ansible, for example.

If your settings changes aren’t taking effect in config/app.yml and you’ve already cleared the cache and restarted php-fpm, you might want to double-check to make sure you don’t have a file in apps/qubit/config/app.yml overriding the other configuration file. If you are using the Vagrant box for example, you will have this extra config file, since Artefactual uses Ansible to automate the build of the Vagrant box.

apps/qubit/config/settings.yml¶

• Symfony and PHP settings - see the Symfony documentation for more general information: http://symfony.com/legacy/doc/reference/1_4/en/04-Settings
• For things like default_culture, default_timezone, etc
• Includes settings for error handling behavior as well - be careful changing these! We don’t recommend it.

config/factories.yml¶

• Another Symfony 1.x configuration file
• More details at: http://symfony.com/legacy/doc/reference/1_4/en/05-factories
• Useful for changing logging options, user authentication (LDAP), etc
• We don’t recommend changing this file unless you know what you’re doing!
• See: Logging for some ideas on how to work with these settings to change or improve logging in AtoM

config/config.php¶

• Where basic configuration information for database access is stored, such as the database user, pass, and name
• We don’t recommend changing this file unless you know what you’re doing!

config/sitemap.yml¶

This configuration file is used in conjunction with the sitemap generation command-line task - for more information, see: Generate an XML sitemap for search engine optimization.

This file contains the priorities (or weighting) for each level of description of archival descriptions included in the sitemap the CLI task will generate. If you have added new levels of description to the Levels of description taxonomy, you can give them a priority here, or adjust the default priorities included in the file (shown in the image below).