Skip to content

Latest commit

 

History

History
132 lines (113 loc) · 6.11 KB

README.md

File metadata and controls

132 lines (113 loc) · 6.11 KB
Raw

ULF README

Specific README files

A viable server setup

  • PHP 5.6 (For 7.0 compatibility the following updates are needed: php 7.0 compatibility)
  • Apache 2.4
  • Debian jessie
  • Mysql 15.1
  • Modules
    • wkhtmltopdf 0.12.5-dev (with patched qt)
      • Used by print module.
  • Search (If default search solution is used)

The profile setup

The install profile contains:

ulf_default theme

  • Uses Ulfiaarhus.dk original images, styles, and templates
  • Used as a base theme for all sites. Each site provides it's custom styles and html overrides in a subtheme with ulf_default as it's base theme.
  • See this readme on info about theme setup.

ulf_admin theme

  • A sub theme of seven
  • Contains backend overrides.

Contributed modules

  • Maintained and updated on a regular basis.

Features modules

  • Each release should include a step where all features be reverted to their default code state.
  • Features modules may contain additional code related to the feature but not maintained through the features module.
  • Overridden features should be prevented by updating the features code. This should help to maintain a smooth release flow.
  • See the individual README.md files for each features module.

Custom modules

  • See the individual README.md files for each module.

search_api_search_node module

  • Integration to search api.
  • Integration to nodejs application.

search_node_page module

  • Provides default configuration for search.
  • Provides default frontend panel panes.

Libraries

  • angular
    • Used by search module and search templates
  • chosen
    • Used by ulf_custom/transportpulje_form module
  • ckeditor
    • The goto wysiwyg editor
  • imagesloaded
    • Used for imagecropping
    • contrib/manualcrop module
  • imgareaselect
    • Used for imagecropping
    • contrib/manualcrop module
  • mailchimp
    • Used by mailchimp module
  • profiler
    • Used by the install profile

Changelog

  • CHANGELOG.md located in the profile folder
  • Logs changes made to the ULF project across all repositories related to ULF.

ulf.install

  • Holds update hooks for the project that are not related to a specific module.

ulf.profile

  • The install profile used for new site installations
  • Uses ulf.install_callbacks.inc file for batch job callbacks
  • Uses profiler library

Registered patches used

Install guide

  • Setup a site file structure as described here
  • Setup a database
  • Create google maps API key as described here
  • Run the installation
    • It is advised to use and follow the ui installation steps @ /install.php
    • Use the ULF install profile
    • If drush is used to run the installation instead of the the advised UI approach, a default configuration is used. You must manually make sure that all the variables are set. e.g.:
      • map configuration
      • translations
      • optional module activation
      • themes
      • search modules
  • Setup search

Test results for php 7.0

Docker setup

Docker related files:

  • ".docker"-folder
    • Contains vhost configuration
  • ".env"-file
    • Contains environment variables for use in Docker
  • docker-compose.yml
    • Holds container setup.

About Docker setup

  • Does not contain search configuration setup.
  • Holds an nginx-service for each site in docker-compose.yml.
  • Uses mailhog/mailhog container.
  • The example.sites.php file holds references to docker hosts defined by nginx containers in docker-compose.yml.
    • This should be copied into a sites.php file with the sites lines uncommented.
    • Uses the prod domain names as folder names.