system.yaml 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148
  1. absolute_urls: false # Absolute or relative URLs for `base_url`
  2. timezone: '' # Valid values: http://php.net/manual/en/timezones.php
  3. default_locale: # Default locale (defaults to system)
  4. param_sep: ':' # Parameter separator, use ';' for Apache on windows
  5. wrapped_site: false # For themes/plugins to know if Grav is wrapped by another platform
  6. reverse_proxy_setup: false # Running in a reverse proxy scenario with different webserver ports than proxy
  7. force_ssl: false # If enabled, Grav forces to be accessed via HTTPS (NOTE: Not an ideal solution)
  8. force_lowercase_urls: true # If you want to support mixed cased URLs set this to false
  9. custom_base_url: '' # Set the base_url manually, e.g. http://yoursite.com/yourpath
  10. username_regex: '^[a-z0-9_-]{3,16}$' # Only lowercase chars, digits, dashes, underscores. 3 - 16 chars
  11. pwd_regex: '(?=.*\d)(?=.*[a-z])(?=.*[A-Z]).{8,}' # At least one number, one uppercase and lowercase letter, and be at least 8+ chars
  12. intl_enabled: true # Special logic for PHP International Extension (mod_intl)
  13. languages:
  14. supported: [] # List of languages supported. eg: [en, fr, de]
  15. include_default_lang: true # Include the default lang prefix in all URLs
  16. translations: true # Enable translations by default
  17. translations_fallback: true # Fallback through supported translations if active lang doesn't exist
  18. session_store_active: false # Store active language in session
  19. http_accept_language: false # Attempt to set the language based on http_accept_language header in the browser
  20. override_locale: false # Override the default or system locale with language specific one
  21. home:
  22. alias: '/home' # Default path for home, ie /
  23. hide_in_urls: false # Hide the home route in URLs
  24. pages:
  25. theme: quark # Default theme (defaults to "quark" theme)
  26. order:
  27. by: default # Order pages by "default", "alpha" or "date"
  28. dir: asc # Default ordering direction, "asc" or "desc"
  29. list:
  30. count: 20 # Default item count per page
  31. dateformat:
  32. default: # The default date format Grav expects in the `date: ` field
  33. short: 'jS M Y' # Short date format
  34. long: 'F jS \a\t g:ia' # Long date format
  35. publish_dates: true # automatically publish/unpublish based on dates
  36. process:
  37. markdown: true # Process Markdown
  38. twig: false # Process Twig
  39. twig_first: false # Process Twig before markdown when processing both on a page
  40. never_cache_twig: false # Only cache content, never cache twig processed in content (incompatible with `twig_first: true`)
  41. events:
  42. page: true # Enable page level events
  43. twig: true # Enable Twig level events
  44. markdown:
  45. extra: false # Enable support for Markdown Extra support (GFM by default)
  46. auto_line_breaks: false # Enable automatic line breaks
  47. auto_url_links: false # Enable automatic HTML links
  48. escape_markup: false # Escape markup tags into entities
  49. special_chars: # List of special characters to automatically convert to entities
  50. '>': 'gt'
  51. '<': 'lt'
  52. types: [txt,xml,html,htm,json,rss,atom] # list of valid page types
  53. append_url_extension: '' # Append page's extension in Page urls (e.g. '.html' results in /path/page.html)
  54. expires: 604800 # Page expires time in seconds (604800 seconds = 7 days)
  55. cache_control: # Can be blank for no setting, or a valid `cache-control` text value
  56. last_modified: false # Set the last modified date header based on file modification timestamp
  57. etag: false # Set the etag header tag
  58. vary_accept_encoding: false # Add `Vary: Accept-Encoding` header
  59. redirect_default_route: false # Automatically redirect to a page's default route
  60. redirect_default_code: 302 # Default code to use for redirects
  61. redirect_trailing_slash: true # Handle automatically or 302 redirect a trailing / URL
  62. ignore_files: [.DS_Store] # Files to ignore in Pages
  63. ignore_folders: [.git, .idea] # Folders to ignore in Pages
  64. ignore_hidden: true # Ignore all Hidden files and folders
  65. url_taxonomy_filters: true # Enable auto-magic URL-based taxonomy filters for page collections
  66. frontmatter:
  67. process_twig: false # Should the frontmatter be processed to replace Twig variables?
  68. ignore_fields: ['form','forms'] # Fields that might contain Twig variables and should not be processed
  69. cache:
  70. enabled: true # Set to true to enable caching
  71. check:
  72. method: file # Method to check for updates in pages: file|folder|hash|none
  73. driver: auto # One of: auto|file|apc|xcache|memcache|wincache
  74. prefix: 'g' # Cache prefix string (prevents cache conflicts)
  75. clear_images_by_default: true # By default grav will include processed images in cache clear, this can be disabled
  76. cli_compatibility: false # Ensures only non-volatile drivers are used (file, redis, memcache, etc.)
  77. lifetime: 604800 # Lifetime of cached data in seconds (0 = infinite)
  78. gzip: false # GZip compress the page output
  79. allow_webserver_gzip: false # If true, `content-encoding: identity` but connection isn't closed before `onShutDown()` event
  80. redis:
  81. socket: false # Path to redis unix socket (e.g. /var/run/redis/redis.sock), false = use server and port to connect
  82. twig:
  83. cache: true # Set to true to enable Twig caching
  84. debug: true # Enable Twig debug
  85. auto_reload: true # Refresh cache on changes
  86. autoescape: false # Autoescape Twig vars
  87. undefined_functions: true # Allow undefined functions
  88. undefined_filters: true # Allow undefined filters
  89. umask_fix: false # By default Twig creates cached files as 755, fix switches this to 775
  90. assets: # Configuration for Assets Manager (JS, CSS)
  91. css_pipeline: false # The CSS pipeline is the unification of multiple CSS resources into one file
  92. css_pipeline_include_externals: true # Include external URLs in the pipeline by default
  93. css_pipeline_before_excludes: true # Render the pipeline before any excluded files
  94. css_minify: true # Minify the CSS during pipelining
  95. css_minify_windows: false # Minify Override for Windows platforms. False by default due to ThreadStackSize
  96. css_rewrite: true # Rewrite any CSS relative URLs during pipelining
  97. js_pipeline: false # The JS pipeline is the unification of multiple JS resources into one file
  98. js_pipeline_include_externals: true # Include external URLs in the pipeline by default
  99. js_pipeline_before_excludes: true # Render the pipeline before any excluded files
  100. js_minify: true # Minify the JS during pipelining
  101. enable_asset_timestamp: false # Enable asset timestamps
  102. collections:
  103. jquery: system://assets/jquery/jquery-2.x.min.js
  104. errors:
  105. display: 0 # Display either (1) Full backtrace | (0) Simple Error | (-1) System Error
  106. log: true # Log errors to /logs folder
  107. debugger:
  108. enabled: false # Enable Grav debugger and following settings
  109. shutdown:
  110. close_connection: true # Close the connection before calling onShutdown(). false for debugging
  111. images:
  112. default_image_quality: 85 # Default image quality to use when resampling images (85%)
  113. cache_all: false # Cache all image by default
  114. cache_perms: '0755' # MUST BE IN QUOTES!! Default cache folder perms. Usually '0755' or '0775'
  115. debug: false # Show an overlay over images indicating the pixel depth of the image when working with retina for example
  116. auto_fix_orientation: false # Automatically fix the image orientation based on the Exif data
  117. media:
  118. enable_media_timestamp: false # Enable media timestamps
  119. unsupported_inline_types: [] # Array of supported media types to try to display inline
  120. allowed_fallback_types: [] # Array of allowed media types of files found if accessed via Page route
  121. auto_metadata_exif: false # Automatically create metadata files from Exif data where possible
  122. session:
  123. enabled: true # Enable Session support
  124. initialize: true # Initialize session from Grav (if false, plugin needs to start the session)
  125. timeout: 1800 # Timeout in seconds
  126. name: grav-site # Name prefix of the session cookie. Use alphanumeric, dashes or underscores only. Do not use dots in the session name
  127. secure: false # Set session secure. If true, indicates that communication for this cookie must be over an encrypted transmission. Enable this only on sites that run exclusively on HTTPS
  128. httponly: true # Set session HTTP only. If true, indicates that cookies should be used only over HTTP, and JavaScript modification is not allowed.
  129. split: true # Sessions should be independent between site and plugins (such as admin)
  130. path:
  131. gpm:
  132. releases: stable # Set to either 'stable' or 'testing'
  133. proxy_url: # Configure a manual proxy URL for GPM (eg 127.0.0.1:3128)
  134. method: 'auto' # Either 'curl', 'fopen' or 'auto'. 'auto' will try fopen first and if not available cURL
  135. verify_peer: true # Sometimes on some systems (Windows most commonly) GPM is unable to connect because the SSL certificate cannot be verified. Disabling this setting might help.
  136. official_gpm_only: true # By default GPM direct-install will only allow URLs via the official GPM proxy to ensure security