diff --git a/.docker/os2web-subsites/.env.example b/.docker/os2web-subsites/.env.example index 77d6c6943..7c4f11baa 100644 --- a/.docker/os2web-subsites/.env.example +++ b/.docker/os2web-subsites/.env.example @@ -2,6 +2,72 @@ # Copy and rename this file to .env at root of this project. # +# Uncomment and populate as needed. +## Subsite admin UI db creadentials +MYSQL_DATABASE=os2subsites +MYSQL_HOSTNAME=mariadb +MYSQL_ROOT_PASSWORD=root +MYSQL_PASSWORD=os2subsites +MYSQL_PORT=3306 +MYSQL_USER=os2subsites + +## Drupal salt +DRUPAL_HASH_SALT=w-NR7Q2C3URQH6qdRvDPlbxVqdvyGMbsOwyXgtqkdJGNI7FBMbrD79UMx2DDNlSqvfmY-OOKLw +## Domain suffix that would be used for subsites +DOMAIN_SUFFIX=os2subsites.local +## Path to base site config directory +BASE_SUBSITE_CONFIG_DIR=/opt/drupal/config/base.${DOMAIN_SUFFIX}/sync + +# OS2SUBSITE common varaibles. +## Flag for using environment variables +## Comment this variale to use values from `config.sh file` +USE_ENV_CONFIG=1 +## Drupal project root directory +BASEDIR=/opt/drupal +SERVERIP=127.0.0.1 +## Default Drupal profile for subsites. +## Use `base_config` value +PROFILE=base_config +ALLOWED_INSTALL_PROFILES=minimal,os2web +## Email used for subsite admin user. +EMAIL=drupal@bellcom.dk +## Path to +SCRIPTDIR=/opt/drupal/scripts/os2subsites_provision +## Path to drush +DRUSH=/usr/local/bin/drush +## Database creadentials for creating subsite db. +DBHOST=mariadb +DBUSER_HOST=mariadb +## External db provisioning. NOTE: To disable external provisioning you have to JUST comment variable +EXTERNAL_DB_PROVISIONING=1 +PROVISIONING_SOURCES_PATH=/opt/drupal/private/subsite-credentials +## For internal db provisioning you have to specify directory to mysql db files are stored. It's used for db existing check. +#DBDIR=/var/lib/mysql +## Subsite admin pass +ADMINPASS=admin +## Path to subsite vhost template +VHOSTTEMPLATE=${SCRIPTDIR}/../os2subsites_provision/os2subsites-vhost-template +## Drupal document root directory path +MULTISITE=${BASEDIR}/web +## Path to file where subsites registering. +SITESFILE=${MULTISITE}/sites/sites.php +## Temp directory for subsites +TMPDIRBASE=${BASEDIR}/tmp +## Log directory for subsites +LOGDIRBASE=${BASEDIR}/logs +## Session directory for subsites +SESSIONDIRBASE=${BASEDIR}/sessions +## Username for subsite administrator user. User will be created on subsites. +SITEADMIN=subsiteadmin +## Apache webserver username. +APACHEUSER=www-data +## Root user name. Sometimes this variable is empty. +USER=root +# Version of Drupal core. Accepted values 7,8 +DRUPAL=8 +# Additional option for site-install command +INSTALL_OPTIONS= + ## Variable used only in docker-compose.yaml COMPOSE_PROJECT_NAME=os2web-subsites-docker-compose # TAG= diff --git a/.docker/os2web-subsites/.gitignore b/.docker/os2web-subsites/.gitignore index 2293c8cfb..b05cb584b 100644 --- a/.docker/os2web-subsites/.gitignore +++ b/.docker/os2web-subsites/.gitignore @@ -1,3 +1,5 @@ .env volumes/* !volumes/.keep +logs/* +!logs/.keep diff --git a/.docker/os2web-subsites/Dockerfile b/.docker/os2web-subsites/Dockerfile index b0e5cd961..9b8b1b998 100644 --- a/.docker/os2web-subsites/Dockerfile +++ b/.docker/os2web-subsites/Dockerfile @@ -13,6 +13,12 @@ RUN set -eux; \ sudo; \ rm -rf /var/lib/apt/lists/* +# Adding subsites provisioner script. +RUN set -eux; \ + git clone -n https://github.com/bellcom/os2subsite_provision.git /opt/drupal/scripts/os2subsites_provision; \ + cd /opt/drupal/scripts/os2subsites_provision && git checkout 89a7202548462dfbb6946fda9978cfad3e77412b; \ + ln -s /opt/drupal/scripts/os2subsites_provision/8.x/bc_subsites /opt/drupal/web/modules/custom/ + # Adding further site specific data to image. RUN chown -R www-data:www-data /opt/drupal/tmp /opt/drupal/logs /opt/drupal/translations; \ echo " /opt/drupal/web/sites/sites.php; \ @@ -21,6 +27,12 @@ RUN chown -R www-data:www-data /opt/drupal/tmp /opt/drupal/logs /opt/drupal/tran # Additional PHP configuration for OS2Web subsites both CLI and Apache COPY php/os2web-subsites.ini /usr/local/etc/php/conf.d/os2web-subsites.ini +# Add OS2Subsites vhost template +COPY apache/os2subsites-vhost-template /opt/drupal/scripts/os2subsites_provision/os2subsites-vhost-template + +# Copy drupal local settings +COPY settings/*.php /opt/drupal/.docker/os2web-subsites/settings/ + # Adding entry point where required services could be started. COPY entrypoint.sh /usr/bin/ @@ -34,6 +46,9 @@ RUN echo "HOME=/opt/drupal" >> /opt/drupal/.env # Addjusting php runtime. RUN ln -s /usr/local/bin/php /usr/bin/php; +# Allow www-data call scripts. +COPY os2subsite /etc/sudoers.d/os2subsite + ENTRYPOINT ["entrypoint.sh"] CMD ["apache2-foreground"] diff --git a/.docker/os2web-subsites/README.md b/.docker/os2web-subsites/README.md index 6a22a31fe..c37325d89 100644 --- a/.docker/os2web-subsites/README.md +++ b/.docker/os2web-subsites/README.md @@ -23,3 +23,121 @@ Example: ``` `--push` - when you this option build will be pushed to docker hub. + +## Local developemnt through docker + +While main OS2Web solution is using Docksal for local development. It's easier for testing purposes to use bare docker-compose environment for OS2Web sibsutes. + +It expects that all action would be performed on Docker subsites folder .docker/os2web-subsites + + +### Restart docker stack + +docker-compose down +sudo rm -rf volumes/* +docker volume rm os2web-subsites-docker-compose_mysql +docker-compose up -d +docker-compose exec php bash + + + +### Install subsites creator +sudo -E -u www-data drush si --account-pass=admin -y && drush en bc_subsites admin_toolbar_tools -y + + +### Entironments variables + +Define your .env file as it stated below +``` +# +# Copy and rename this file to .env at root of this project. +# + +# Uncomment and populate as needed. +## Subsite admin UI db creadentials +MYSQL_DATABASE=os2subsites +MYSQL_HOSTNAME=mariadb +MYSQL_ROOT_PASSWORD=root +MYSQL_PASSWORD=os2subsites +MYSQL_PORT=3306 +MYSQL_USER=os2subsites + +## Drupal salt +DRUPAL_HASH_SALT=w-NR7Q2C3URQH6qdRvDPlbxVqdvyGMbsOwyXgtqkdJGNI7FBMbrD79UMx2DDNlSqvfmY-OOKLw +## Domain suffix that would be used for subsites +DOMAIN_SUFFIX=os2subsites.local +## Path to base site config directory +BASE_SUBSITE_CONFIG_DIR=/opt/drupal/config/ay-test0604-3.${DOMAIN_SUFFIX}/sync + +# OS2SUBSITE common varaibles. +## Flag for using environment variables +## Comment this variale to use values from `config.sh file` +USE_ENV_CONFIG=1 +## Drupal project root directory +BASEDIR=/opt/drupal +SERVERIP=127.0.0.1 +## Default Drupal profile for subsites. +## Use `base_config` value +PROFILE=base_config +ALLOWED_INSTALL_PROFILES=minimal,os2web +## Email used for subsite admin user. +EMAIL=drupal@bellcom.dk +## Path to +SCRIPTDIR=/opt/drupal/scripts/os2subsites_provision +## Path to drush +DRUSH=/usr/local/bin/drush +## Database creadentials for creating subsite db. +DBHOST=mariadb +DBUSER_HOST=mariadb +### Optional varialbles. Leave it empty to user root as user name. +DB_ROOT_USER=root +### Optional varialbles. Leave it empty to user root user without password from localhost. +DB_ROOT_PASSWORD=root +## External db provisioning. NOTE: To disable external provisioning you have to JUST comment variable +EXTERNAL_DB_PROVISIONING=1 +PROVISIONING_SOURCES_PATH=/opt/drupal/private/subsite-credentials +## For internal db provisioning you have to specify directory to mysql db files are stored. It's used for db existing check. +#DBDIR=/var/lib/mysql +## Subsite admin pass +ADMINPASS=admin +## Path to subsite vhost template +VHOSTTEMPLATE=${SCRIPTDIR}/../os2subsites_provision/os2subsites-vhost-template +## Drupal document root directory path +MULTISITE=${BASEDIR}/web +## Path to file where subsites registering. +SITESFILE=${MULTISITE}/sites/sites.php +## Temp directory for subsites +TMPDIRBASE=${BASEDIR}/tmp +## Log directory for subsites +LOGDIRBASE=${BASEDIR}/logs +## Session directory for subsites +SESSIONDIRBASE=${BASEDIR}/sessions +## Username for subsite administrator user. User will be created on subsites. +SITEADMIN=subsiteadmin +## Apache webserver username. +APACHEUSER=www-data +## Root user name. Sometimes this variable is empty. +USER=root +# Version of Drupal core. Accepted values 7,8 +DRUPAL=8 +# Additional option for site-install command +INSTALL_OPTIONS= + +## Variable used only in docker-compose.yaml +COMPOSE_PROJECT_NAME=os2web-subsites-docker-compose +TAG=2.1.5-rc-BKDK-521 # <---- This value should be one you use for testing. +WEB_SERVER_PORT=8098 +``` + +### Handling domains + +Main domain for subsite creator is localhost:8098 + +NOTE: Port could be different if you changed `WEB_SERVER_PORT` variable. + +Each subsites domain should be defined in your local `/etc/hosts` file like: +``` +127.0.0.1 new-subsite.os2subsites.local +``` + +NOTE: Domain suffix `.os2subsites.local` could be different if you changed `DOMAIN_SUFFIX` variable. diff --git a/.docker/os2web-subsites/apache/000-default.conf b/.docker/os2web-subsites/apache/000-default.conf new file mode 100644 index 000000000..cbc18bb7e --- /dev/null +++ b/.docker/os2web-subsites/apache/000-default.conf @@ -0,0 +1,28 @@ + + + AllowOverride All + Options FollowSymLinks + + + ServerAdmin os2web-subsites@bellcom.dk + DocumentRoot /var/www/html + + ErrorLog ${APACHE_LOG_DIR}/error.log + CustomLog ${APACHE_LOG_DIR}/access.log combined + + SetEnvIf X-Forwarded-Proto https HTTPS=on + + php_admin_value open_basedir /opt/drupal:/usr/share/php + php_value include_path .:/opt/drupal + + php_value log_errors 1 + php_value html_errors 0 + php_value display_errors 0 + php_admin_value error_reporting 1023 + php_value error_log /dev/stderr + + php_value session.save_path /opt/drupal/sessions + php_admin_value upload_max_filesize 128M + php_admin_value post_max_size 128M + php_admin_value upload_tmp_dir /opt/drupal/tmp/default + diff --git a/.docker/os2web-subsites/apache/os2subsites-shared.conf b/.docker/os2web-subsites/apache/os2subsites-shared.conf new file mode 100644 index 000000000..e69de29bb diff --git a/.docker/os2web-subsites/apache/os2subsites-vhost-template b/.docker/os2web-subsites/apache/os2subsites-vhost-template new file mode 100644 index 000000000..6b8d2415d --- /dev/null +++ b/.docker/os2web-subsites/apache/os2subsites-vhost-template @@ -0,0 +1,26 @@ +# DO NOT EDIT THIS VHOST. IT WILL BE MODIFIED BY SCRIPTS. (The includes for access limits and ServerAliases) + + + AllowOverride All + Options FollowSymLinks + + + ServerAdmin domains@bellcom.dk + DocumentRoot /var/www/html + ServerName [domain] + + CustomLog ${APACHE_LOG_DIR}/access.log combined + ErrorLog ${APACHE_LOG_DIR}/error.log + + php_admin_value open_basedir [basedir]:/usr/share/php + php_value include_path .:[basedir] + php_value error_log /dev/stderr + php_value session.save_path [basedir]/sessions/[domain] + php_admin_value upload_tmp_dir [basedir]/tmp/[domain] + + php_value log_errors 1 + php_value html_errors 0 + php_value display_errors 0 + php_admin_value error_reporting 2047 + php_admin_value max_execution_time 180 + diff --git a/.docker/os2web-subsites/docker-compose.yaml b/.docker/os2web-subsites/docker-compose.yaml index 46c3e4b8c..e85f49bf1 100644 --- a/.docker/os2web-subsites/docker-compose.yaml +++ b/.docker/os2web-subsites/docker-compose.yaml @@ -9,8 +9,6 @@ networks: volumes: mysql: driver: local - os2web: - driver: local services: # General application container. @@ -22,10 +20,12 @@ services: - ./logs:/var/log:delegated - ./volumes/drupal/private:/opt/drupal/private - ./volumes/drupal/web/sites:/opt/drupal/web/sites - - ./volumes/apache/sites-availbale:/etc/apache/sites-availbale - - ./volumes/apache/sites-enabled:/etc/apache/sites-enabled + - ./volumes/apache2/sites-available:/etc/apache2/sites-available + - ./volumes/apache2/sites-enabled:/etc/apache2/sites-enabled - ./volumes/config:/opt/drupal/config - ./volumes/crontabs:/var/spool/cron/crontabs + - ./volumes/tmp:/opt/drupal/tmp + #- ../../scripts/os2subsites_provision:/opt/drupal/scripts/os2subsites_provision depends_on: - mariadb ports: @@ -39,8 +39,8 @@ services: mariadb: image: mariadb:latest volumes: - - /var/lib/mysql + - mysql:/var/lib/mysql networks: - backend - environment: - MARIADB_ROOT_PASSWORD: root + env_file: + - .env diff --git a/.docker/os2web-subsites/entrypoint.sh b/.docker/os2web-subsites/entrypoint.sh index 66c603093..e29d86861 100644 --- a/.docker/os2web-subsites/entrypoint.sh +++ b/.docker/os2web-subsites/entrypoint.sh @@ -3,4 +3,56 @@ # Starting cron service. service cron start +# Check basic file structure for subsites creator +if [ ! -f "/etc/apache2/sites-available/000-default.conf" ] +then + cp -f /opt/drupal/.docker/os2web-subsites/apache/000-default.conf /etc/apache2/sites-available/000-default.conf + ln -sf /etc/apache2/sites-available/000-default.conf /etc/apache2/sites-enabled/000-default.conf +fi + +# Check basic file structure for subsites creator +if [ ! -d "/opt/drupal/web/sites/default" ] +then + echo "Default sites folder doesn't exists. Create folder and standard files" + mkdir -p /opt/drupal/web/sites/default/files + cp -f /opt/drupal/.docker/os2web-subsites/settings/default.settings.php /opt/drupal/web/sites/default/default.settings.php + cp -f /opt/drupal/.docker/os2web-subsites/settings/default.settings.php /opt/drupal/web/sites/default/settings.php + echo 'include $app_root . "/" . $site_path . "/settings.local.php";' >> /opt/drupal/web/sites/default/settings.php + cp -f /opt/drupal/.docker/os2web-subsites/settings/settings.local.php /opt/drupal/web/sites/default/settings.local.php + chmod 755 /opt/drupal/web/sites/default /opt/drupal/web/sites/default/settings.php /opt/drupal/web/sites/default/settings.local.php + chown -R www-data:www-data /opt/drupal/web/sites +fi + +# Check basic file structure for subsites creator +if [ ! -f "/opt/drupal/web/sites/sites.php" ] +then + echo "Creating web/sites/sites.php" + echo " /opt/drupal/web/sites/sites.php + chown www-data:www-data /opt/drupal/web/sites/sites.php +fi + +# Check default config dir +if [ ! -f "/opt/drupal/config/default" ] +then + mkdir -p /opt/drupal/config/default + chown www-data:www-data -R /opt/drupal/config +fi + +# Check default temp dir +if [ ! -f "/opt/drupal/tmp/default" ] +then + mkdir -p /opt/drupal/tmp/default + chown www-data:www-data -R /opt/drupal/tmp +fi + +# Check default private dir +if [ ! -f "/opt/drupal/private/default" ] +then + mkdir -p /opt/drupal/private/default + chown www-data:www-data -R /opt/drupal/private +fi + +# Copying shared settings file +cp -f /opt/drupal/.docker/os2web-subsites/settings/shared.settings.php /opt/drupal/web/sites/shared.settings.php + exec "$@" diff --git a/.docker/os2web-subsites/os2subsite b/.docker/os2web-subsites/os2subsite new file mode 100644 index 000000000..ad6244e46 --- /dev/null +++ b/.docker/os2web-subsites/os2subsite @@ -0,0 +1,6 @@ +www-data ALL=(root) NOPASSWD:SETENV: /opt/drupal/scripts/os2subsites_provision/subsite_add_domain.sh +www-data ALL=(root) NOPASSWD:SETENV: /opt/drupal/scripts/os2subsites_provision/subsite_create.sh +www-data ALL=(root) NOPASSWD:SETENV: /opt/drupal/scripts/os2subsites_provision/subsite_delete.sh +www-data ALL=(root) NOPASSWD:SETENV: /opt/drupal/scripts/os2subsites_provision/subsite_remove_domain.sh +www-data ALL=(root) NOPASSWD:SETENV: /opt/drupal/scripts/os2subsites_provision/phase1.sh +www-data ALL=(root) NOPASSWD:SETENV: /opt/drupal/scripts/os2subsites_provision/phase2.sh diff --git a/.docker/os2web-subsites/settings/default.settings.php b/.docker/os2web-subsites/settings/default.settings.php new file mode 100644 index 000000000..e6db51993 --- /dev/null +++ b/.docker/os2web-subsites/settings/default.settings.php @@ -0,0 +1,2 @@ + getenv('MYSQL_DATABASE'), + 'driver' => 'mysql', + 'host' => getenv('MYSQL_HOSTNAME'), + 'namespace' => 'Drupal\\Core\\Database\\Driver\\mysql', + 'password' => getenv('MYSQL_PASSWORD'), + 'port' => getenv('MYSQL_PORT'), + 'prefix' => '', + 'username' => getenv('MYSQL_USER'), +]; + +if (!empty(getenv('DRUPAL_TRUSTED_HOST'))) { + $settings['trusted_host_patterns'] = ['^'.getenv('DRUPAL_TRUSTED_HOST').'$']; +} + +$settings['hash_salt'] = getenv('DRUPAL_HASH_SALT'); + +$settings['file_temp_path'] = '../tmp/default'; +$settings['file_private_path'] = '../private/default'; +$settings['config_sync_directory'] = '../config/default'; + +$config['bc_subsites.settings'] = [ + 'enabled' => TRUE, + 'domain_suffix' => getenv('DOMAIN_SUFFIX'), + 'script_dir' => getenv('SCRIPTDIR'), + 'subsites_config_dir' => '../config', + 'base_subsite_config_dir' => getenv('BASE_SUBSITE_CONFIG_DIR'), + 'allowed_install_profiles' => explode(',', getenv('ALLOWED_INSTALL_PROFILES')), + 'default_profile' => explode(',', getenv('PROFILE')), +]; + +// Passing EXTERNAL_DB_PROVISIONING into Drupal settings. +if (getenv('EXTERNAL_DB_PROVISIONING')) { + $config['bc_subsites.settings']['external_db_provisioning'] = getenv('EXTERNAL_DB_PROVISIONING'); +} + diff --git a/.docker/os2web-subsites/settings/shared.settings.php b/.docker/os2web-subsites/settings/shared.settings.php new file mode 100644 index 000000000..718890224 --- /dev/null +++ b/.docker/os2web-subsites/settings/shared.settings.php @@ -0,0 +1,771 @@ + 'databasename', + * 'username' => 'sqlusername', + * 'password' => 'sqlpassword', + * 'host' => 'localhost', + * 'port' => '3306', + * 'driver' => 'mysql', + * 'prefix' => '', + * 'collation' => 'utf8mb4_general_ci', + * ]; + * @endcode + */ +$databases = []; + +/** + * Customizing database settings. + * + * Many of the values of the $databases array can be customized for your + * particular database system. Refer to the sample in the section above as a + * starting point. + * + * The "driver" property indicates what Drupal database driver the + * connection should use. This is usually the same as the name of the + * database type, such as mysql or sqlite, but not always. The other + * properties will vary depending on the driver. For SQLite, you must + * specify a database file name in a directory that is writable by the + * webserver. For most other drivers, you must specify a + * username, password, host, and database name. + * + * Drupal core implements drivers for mysql, pgsql, and sqlite. Other drivers + * can be provided by contributed or custom modules. To use a contributed or + * custom driver, the "namespace" property must be set to the namespace of the + * driver. The code in this namespace must be autoloadable prior to connecting + * to the database, and therefore, prior to when module root namespaces are + * added to the autoloader. To add the driver's namespace to the autoloader, + * set the "autoload" property to the PSR-4 base directory of the driver's + * namespace. This is optional for projects managed with Composer if the + * driver's namespace is in Composer's autoloader. + * + * For each database, you may optionally specify multiple "target" databases. + * A target database allows Drupal to try to send certain queries to a + * different database if it can but fall back to the default connection if not. + * That is useful for primary/replica replication, as Drupal may try to connect + * to a replica server when appropriate and if one is not available will simply + * fall back to the single primary server (The terms primary/replica are + * traditionally referred to as master/slave in database server documentation). + * + * The general format for the $databases array is as follows: + * @code + * $databases['default']['default'] = $info_array; + * $databases['default']['replica'][] = $info_array; + * $databases['default']['replica'][] = $info_array; + * $databases['extra']['default'] = $info_array; + * @endcode + * + * In the above example, $info_array is an array of settings described above. + * The first line sets a "default" database that has one primary database + * (the second level default). The second and third lines create an array + * of potential replica databases. Drupal will select one at random for a given + * request as needed. The fourth line creates a new database with a name of + * "extra". + * + * You can optionally set a prefix for all database table names by using the + * 'prefix' setting. If a prefix is specified, the table name will be prepended + * with its value. Be sure to use valid database characters only, usually + * alphanumeric and underscore. If no prefix is desired, do not set the 'prefix' + * key or set its value to an empty string ''. + * + * For example, to have all database table prefixed with 'main_', set: + * @code + * 'prefix' => 'main_', + * @endcode + * + * Advanced users can add or override initial commands to execute when + * connecting to the database server, as well as PDO connection settings. For + * example, to enable MySQL SELECT queries to exceed the max_join_size system + * variable, and to reduce the database connection timeout to 5 seconds: + * @code + * $databases['default']['default'] = [ + * 'init_commands' => [ + * 'big_selects' => 'SET SQL_BIG_SELECTS=1', + * ], + * 'pdo' => [ + * PDO::ATTR_TIMEOUT => 5, + * ], + * ]; + * @endcode + * + * WARNING: The above defaults are designed for database portability. Changing + * them may cause unexpected behavior, including potential data loss. See + * https://www.drupal.org/developing/api/database/configuration for more + * information on these defaults and the potential issues. + * + * More details can be found in the constructor methods for each driver: + * - \Drupal\Core\Database\Driver\mysql\Connection::__construct() + * - \Drupal\Core\Database\Driver\pgsql\Connection::__construct() + * - \Drupal\Core\Database\Driver\sqlite\Connection::__construct() + * + * Sample Database configuration format for PostgreSQL (pgsql): + * @code + * $databases['default']['default'] = [ + * 'driver' => 'pgsql', + * 'database' => 'databasename', + * 'username' => 'sqlusername', + * 'password' => 'sqlpassword', + * 'host' => 'localhost', + * 'prefix' => '', + * ]; + * @endcode + * + * Sample Database configuration format for SQLite (sqlite): + * @code + * $databases['default']['default'] = [ + * 'driver' => 'sqlite', + * 'database' => '/path/to/databasefilename', + * ]; + * @endcode + * + * Sample Database configuration format for a driver in a contributed module: + * @code + * $databases['default']['default'] = [ + * 'driver' => 'my_driver', + * 'namespace' => 'Drupal\my_module\Driver\Database\my_driver', + * 'autoload' => 'modules/my_module/src/Driver/Database/my_driver/', + * 'database' => 'databasename', + * 'username' => 'sqlusername', + * 'password' => 'sqlpassword', + * 'host' => 'localhost', + * 'prefix' => '', + * ]; + * @endcode + */ + +/** + * Location of the site configuration files. + * + * The $settings['config_sync_directory'] specifies the location of file system + * directory used for syncing configuration data. On install, the directory is + * created. This is used for configuration imports. + * + * The default location for this directory is inside a randomly-named + * directory in the public files path. The setting below allows you to set + * its location. + */ +# $settings['config_sync_directory'] = '/directory/outside/webroot'; + +/** + * Settings: + * + * $settings contains environment-specific configuration, such as the files + * directory and reverse proxy address, and temporary configuration, such as + * security overrides. + * + * @see \Drupal\Core\Site\Settings::get() + */ + +/** + * Salt for one-time login links, cancel links, form tokens, etc. + * + * This variable will be set to a random value by the installer. All one-time + * login links will be invalidated if the value is changed. Note that if your + * site is deployed on a cluster of web servers, you must ensure that this + * variable has the same value on each server. + * + * For enhanced security, you may set this variable to the contents of a file + * outside your document root; you should also ensure that this file is not + * stored with backups of your database. + * + * Example: + * @code + * $settings['hash_salt'] = file_get_contents('/home/example/salt.txt'); + * @endcode + */ +$settings['hash_salt'] = ''; + +/** + * Deployment identifier. + * + * Drupal's dependency injection container will be automatically invalidated and + * rebuilt when the Drupal core version changes. When updating contributed or + * custom code that changes the container, changing this identifier will also + * allow the container to be invalidated as soon as code is deployed. + */ +# $settings['deployment_identifier'] = \Drupal::VERSION; + +/** + * Access control for update.php script. + * + * If you are updating your Drupal installation using the update.php script but + * are not logged in using either an account with the "Administer software + * updates" permission or the site maintenance account (the account that was + * created during installation), you will need to modify the access check + * statement below. Change the FALSE to a TRUE to disable the access check. + * After finishing the upgrade, be sure to open this file again and change the + * TRUE back to a FALSE! + */ +$settings['update_free_access'] = FALSE; + +/** + * Fallback to HTTP for Update Manager and for fetching security advisories. + * + * If your site fails to connect to updates.drupal.org over HTTPS (either when + * fetching data on available updates, or when fetching the feed of critical + * security announcements), you may uncomment this setting and set it to TRUE to + * allow an insecure fallback to HTTP. Note that doing so will open your site up + * to a potential man-in-the-middle attack. You should instead attempt to + * resolve the issues before enabling this option. + * @see https://www.drupal.org/docs/system-requirements/php-requirements#openssl + * @see https://en.wikipedia.org/wiki/Man-in-the-middle_attack + * @see \Drupal\update\UpdateFetcher + * @see \Drupal\system\SecurityAdvisories\SecurityAdvisoriesFetcher + */ +# $settings['update_fetch_with_http_fallback'] = TRUE; + +/** + * External access proxy settings: + * + * If your site must access the Internet via a web proxy then you can enter the + * proxy settings here. Set the full URL of the proxy, including the port, in + * variables: + * - $settings['http_client_config']['proxy']['http']: The proxy URL for HTTP + * requests. + * - $settings['http_client_config']['proxy']['https']: The proxy URL for HTTPS + * requests. + * You can pass in the user name and password for basic authentication in the + * URLs in these settings. + * + * You can also define an array of host names that can be accessed directly, + * bypassing the proxy, in $settings['http_client_config']['proxy']['no']. + */ +# $settings['http_client_config']['proxy']['http'] = 'http://proxy_user:proxy_pass@example.com:8080'; +# $settings['http_client_config']['proxy']['https'] = 'http://proxy_user:proxy_pass@example.com:8080'; +# $settings['http_client_config']['proxy']['no'] = ['127.0.0.1', 'localhost']; + +/** + * Reverse Proxy Configuration: + * + * Reverse proxy servers are often used to enhance the performance + * of heavily visited sites and may also provide other site caching, + * security, or encryption benefits. In an environment where Drupal + * is behind a reverse proxy, the real IP address of the client should + * be determined such that the correct client IP address is available + * to Drupal's logging, statistics, and access management systems. In + * the most simple scenario, the proxy server will add an + * X-Forwarded-For header to the request that contains the client IP + * address. However, HTTP headers are vulnerable to spoofing, where a + * malicious client could bypass restrictions by setting the + * X-Forwarded-For header directly. Therefore, Drupal's proxy + * configuration requires the IP addresses of all remote proxies to be + * specified in $settings['reverse_proxy_addresses'] to work correctly. + * + * Enable this setting to get Drupal to determine the client IP from the + * X-Forwarded-For header. If you are unsure about this setting, do not have a + * reverse proxy, or Drupal operates in a shared hosting environment, this + * setting should remain commented out. + * + * In order for this setting to be used you must specify every possible + * reverse proxy IP address in $settings['reverse_proxy_addresses']. + * If a complete list of reverse proxies is not available in your + * environment (for example, if you use a CDN) you may set the + * $_SERVER['REMOTE_ADDR'] variable directly in settings.php. + * Be aware, however, that it is likely that this would allow IP + * address spoofing unless more advanced precautions are taken. + */ +# $settings['reverse_proxy'] = TRUE; + +/** + * Specify every reverse proxy IP address in your environment. + * This setting is required if $settings['reverse_proxy'] is TRUE. + */ +# $settings['reverse_proxy_addresses'] = ['a.b.c.d', ...]; + +/** + * Reverse proxy trusted headers. + * + * Sets which headers to trust from your reverse proxy. + * + * Common values are: + * - \Symfony\Component\HttpFoundation\Request::HEADER_X_FORWARDED_FOR + * - \Symfony\Component\HttpFoundation\Request::HEADER_X_FORWARDED_HOST + * - \Symfony\Component\HttpFoundation\Request::HEADER_X_FORWARDED_PORT + * - \Symfony\Component\HttpFoundation\Request::HEADER_X_FORWARDED_PROTO + * - \Symfony\Component\HttpFoundation\Request::HEADER_FORWARDED + * + * Note the default value of + * @code + * \Symfony\Component\HttpFoundation\Request::HEADER_X_FORWARDED_FOR | \Symfony\Component\HttpFoundation\Request::HEADER_X_FORWARDED_HOST | \Symfony\Component\HttpFoundation\Request::HEADER_X_FORWARDED_PORT | \Symfony\Component\HttpFoundation\Request::HEADER_X_FORWARDED_PROTO | \Symfony\Component\HttpFoundation\Request::HEADER_FORWARDED + * @endcode + * is not secure by default. The value should be set to only the specific + * headers the reverse proxy uses. For example: + * @code + * \Symfony\Component\HttpFoundation\Request::HEADER_X_FORWARDED_FOR | \Symfony\Component\HttpFoundation\Request::HEADER_X_FORWARDED_HOST | \Symfony\Component\HttpFoundation\Request::HEADER_X_FORWARDED_PORT | \Symfony\Component\HttpFoundation\Request::HEADER_X_FORWARDED_PROTO + * @endcode + * This would trust the following headers: + * - X_FORWARDED_FOR + * - X_FORWARDED_HOST + * - X_FORWARDED_PROTO + * - X_FORWARDED_PORT + * + * @see \Symfony\Component\HttpFoundation\Request::HEADER_X_FORWARDED_FOR + * @see \Symfony\Component\HttpFoundation\Request::HEADER_X_FORWARDED_HOST + * @see \Symfony\Component\HttpFoundation\Request::HEADER_X_FORWARDED_PORT + * @see \Symfony\Component\HttpFoundation\Request::HEADER_X_FORWARDED_PROTO + * @see \Symfony\Component\HttpFoundation\Request::HEADER_FORWARDED + * @see \Symfony\Component\HttpFoundation\Request::setTrustedProxies + */ +# $settings['reverse_proxy_trusted_headers'] = \Symfony\Component\HttpFoundation\Request::HEADER_X_FORWARDED_FOR | \Symfony\Component\HttpFoundation\Request::HEADER_X_FORWARDED_HOST | \Symfony\Component\HttpFoundation\Request::HEADER_X_FORWARDED_PORT | \Symfony\Component\HttpFoundation\Request::HEADER_X_FORWARDED_PROTO | \Symfony\Component\HttpFoundation\Request::HEADER_FORWARDED; + + +/** + * Page caching: + * + * By default, Drupal sends a "Vary: Cookie" HTTP header for anonymous page + * views. This tells a HTTP proxy that it may return a page from its local + * cache without contacting the web server, if the user sends the same Cookie + * header as the user who originally requested the cached page. Without "Vary: + * Cookie", authenticated users would also be served the anonymous page from + * the cache. If the site has mostly anonymous users except a few known + * editors/administrators, the Vary header can be omitted. This allows for + * better caching in HTTP proxies (including reverse proxies), i.e. even if + * clients send different cookies, they still get content served from the cache. + * However, authenticated users should access the site directly (i.e. not use an + * HTTP proxy, and bypass the reverse proxy if one is used) in order to avoid + * getting cached pages from the proxy. + */ +# $settings['omit_vary_cookie'] = TRUE; + + +/** + * Cache TTL for client error (4xx) responses. + * + * Items cached per-URL tend to result in a large number of cache items, and + * this can be problematic on 404 pages which by their nature are unbounded. A + * fixed TTL can be set for these items, defaulting to one hour, so that cache + * backends which do not support LRU can purge older entries. To disable caching + * of client error responses set the value to 0. Currently applies only to + * page_cache module. + */ +# $settings['cache_ttl_4xx'] = 3600; + +/** + * Expiration of cached forms. + * + * Drupal's Form API stores details of forms in a cache and these entries are + * kept for at least 6 hours by default. Expired entries are cleared by cron. + * + * @see \Drupal\Core\Form\FormCache::setCache() + */ +# $settings['form_cache_expiration'] = 21600; + +/** + * Class Loader. + * + * If the APCu extension is detected, the classloader will be optimized to use + * it. Set to FALSE to disable this. + * + * @see https://getcomposer.org/doc/articles/autoloader-optimization.md + */ +# $settings['class_loader_auto_detect'] = FALSE; + +/** + * Authorized file system operations: + * + * The Update Manager module included with Drupal provides a mechanism for + * site administrators to securely install missing updates for the site + * directly through the web user interface. On securely-configured servers, + * the Update manager will require the administrator to provide SSH or FTP + * credentials before allowing the installation to proceed; this allows the + * site to update the new files as the user who owns all the Drupal files, + * instead of as the user the webserver is running as. On servers where the + * webserver user is itself the owner of the Drupal files, the administrator + * will not be prompted for SSH or FTP credentials (note that these server + * setups are common on shared hosting, but are inherently insecure). + * + * Some sites might wish to disable the above functionality, and only update + * the code directly via SSH or FTP themselves. This setting completely + * disables all functionality related to these authorized file operations. + * + * @see https://www.drupal.org/node/244924 + * + * Remove the leading hash signs to disable. + */ +# $settings['allow_authorize_operations'] = FALSE; + +/** + * Default mode for directories and files written by Drupal. + * + * Value should be in PHP Octal Notation, with leading zero. + */ +# $settings['file_chmod_directory'] = 0775; +# $settings['file_chmod_file'] = 0664; + +/** + * Public file base URL: + * + * An alternative base URL to be used for serving public files. This must + * include any leading directory path. + * + * A different value from the domain used by Drupal to be used for accessing + * public files. This can be used for a simple CDN integration, or to improve + * security by serving user-uploaded files from a different domain or subdomain + * pointing to the same server. Do not include a trailing slash. + */ +# $settings['file_public_base_url'] = 'http://downloads.example.com/files'; + +/** + * Public file path: + * + * A local file system path where public files will be stored. This directory + * must exist and be writable by Drupal. This directory must be relative to + * the Drupal installation directory and be accessible over the web. + */ +# $settings['file_public_path'] = 'sites/default/files'; + +/** + * Private file path: + * + * A local file system path where private files will be stored. This directory + * must be absolute, outside of the Drupal installation directory and not + * accessible over the web. + * + * Note: Caches need to be cleared when this value is changed to make the + * private:// stream wrapper available to the system. + * + * See https://www.drupal.org/documentation/modules/file for more information + * about securing private files. + */ +# $settings['file_private_path'] = ''; + +/** + * Temporary file path: + * + * A local file system path where temporary files will be stored. This directory + * must be absolute, outside of the Drupal installation directory and not + * accessible over the web. + * + * If this is not set, the default for the operating system will be used. + * + * @see \Drupal\Component\FileSystem\FileSystem::getOsTemporaryDirectory() + */ +# $settings['file_temp_path'] = '/tmp'; + +/** + * Session write interval: + * + * Set the minimum interval between each session write to database. + * For performance reasons it defaults to 180. + */ +# $settings['session_write_interval'] = 180; + +/** + * String overrides: + * + * To override specific strings on your site with or without enabling the Locale + * module, add an entry to this list. This functionality allows you to change + * a small number of your site's default English language interface strings. + * + * Remove the leading hash signs to enable. + * + * The "en" part of the variable name, is dynamic and can be any langcode of + * any added language. (eg locale_custom_strings_de for german). + */ +# $settings['locale_custom_strings_en'][''] = [ +# 'forum' => 'Discussion board', +# '@count min' => '@count minutes', +# ]; + +/** + * A custom theme for the offline page: + * + * This applies when the site is explicitly set to maintenance mode through the + * administration page or when the database is inactive due to an error. + * The template file should also be copied into the theme. It is located inside + * 'core/modules/system/templates/maintenance-page.html.twig'. + * + * Note: This setting does not apply to installation and update pages. + */ +# $settings['maintenance_theme'] = 'bartik'; + +/** + * PHP settings: + * + * To see what PHP settings are possible, including whether they can be set at + * runtime (by using ini_set()), read the PHP documentation: + * http://php.net/manual/ini.list.php + * See \Drupal\Core\DrupalKernel::bootEnvironment() for required runtime + * settings and the .htaccess file for non-runtime settings. + * Settings defined there should not be duplicated here so as to avoid conflict + * issues. + */ + +/** + * If you encounter a situation where users post a large amount of text, and + * the result is stripped out upon viewing but can still be edited, Drupal's + * output filter may not have sufficient memory to process it. If you + * experience this issue, you may wish to uncomment the following two lines + * and increase the limits of these variables. For more information, see + * http://php.net/manual/pcre.configuration.php. + */ +# ini_set('pcre.backtrack_limit', 200000); +# ini_set('pcre.recursion_limit', 200000); + +/** + * Add Permissions-Policy header to disable Google FLoC. + * + * By default, Drupal sends the 'Permissions-Policy: interest-cohort=()' header + * to disable Google's Federated Learning of Cohorts feature, introduced in + * Chrome 89. + * + * See https://en.wikipedia.org/wiki/Federated_Learning_of_Cohorts for more + * information about FLoC. + * + * If you don't wish to disable FLoC in Chrome, you can set this value + * to FALSE. + */ +# $settings['block_interest_cohort'] = TRUE; + +/** + * Configuration overrides. + * + * To globally override specific configuration values for this site, + * set them here. You usually don't need to use this feature. This is + * useful in a configuration file for a vhost or directory, rather than + * the default settings.php. + * + * Note that any values you provide in these variable overrides will not be + * viewable from the Drupal administration interface. The administration + * interface displays the values stored in configuration so that you can stage + * changes to other environments that don't have the overrides. + * + * There are particular configuration values that are risky to override. For + * example, overriding the list of installed modules in 'core.extension' is not + * supported as module install or uninstall has not occurred. Other examples + * include field storage configuration, because it has effects on database + * structure, and 'core.menu.static_menu_link_overrides' since this is cached in + * a way that is not config override aware. Also, note that changing + * configuration values in settings.php will not fire any of the configuration + * change events. + */ +# $config['system.site']['name'] = 'My Drupal site'; +# $config['user.settings']['anonymous'] = 'Visitor'; + +/** + * Fast 404 pages: + * + * Drupal can generate fully themed 404 pages. However, some of these responses + * are for images or other resource files that are not displayed to the user. + * This can waste bandwidth, and also generate server load. + * + * The options below return a simple, fast 404 page for URLs matching a + * specific pattern: + * - $config['system.performance']['fast_404']['exclude_paths']: A regular + * expression to match paths to exclude, such as images generated by image + * styles, or dynamically-resized images. The default pattern provided below + * also excludes the private file system. If you need to add more paths, you + * can add '|path' to the expression. + * - $config['system.performance']['fast_404']['paths']: A regular expression to + * match paths that should return a simple 404 page, rather than the fully + * themed 404 page. If you don't have any aliases ending in htm or html you + * can add '|s?html?' to the expression. + * - $config['system.performance']['fast_404']['html']: The html to return for + * simple 404 pages. + * + * Remove the leading hash signs if you would like to alter this functionality. + */ +# $config['system.performance']['fast_404']['exclude_paths'] = '/\/(?:styles)|(?:system\/files)\//'; +# $config['system.performance']['fast_404']['paths'] = '/\.(?:txt|png|gif|jpe?g|css|js|ico|swf|flv|cgi|bat|pl|dll|exe|asp)$/i'; +# $config['system.performance']['fast_404']['html'] = '404 Not Found

Not Found

The requested URL "@path" was not found on this server.

'; + +/** + * Load services definition file. + */ +$settings['container_yamls'][] = $app_root . '/' . $site_path . '/services.yml'; + +/** + * Override the default service container class. + * + * This is useful for example to trace the service container for performance + * tracking purposes, for testing a service container with an error condition or + * to test a service container that throws an exception. + */ +# $settings['container_base_class'] = '\Drupal\Core\DependencyInjection\Container'; + +/** + * Override the default yaml parser class. + * + * Provide a fully qualified class name here if you would like to provide an + * alternate implementation YAML parser. The class must implement the + * \Drupal\Component\Serialization\SerializationInterface interface. + */ +# $settings['yaml_parser_class'] = NULL; + +/** + * Trusted host configuration. + * + * Drupal core can use the Symfony trusted host mechanism to prevent HTTP Host + * header spoofing. + * + * To enable the trusted host mechanism, you enable your allowable hosts + * in $settings['trusted_host_patterns']. This should be an array of regular + * expression patterns, without delimiters, representing the hosts you would + * like to allow. + * + * For example: + * @code + * $settings['trusted_host_patterns'] = [ + * '^www\.example\.com$', + * ]; + * @endcode + * will allow the site to only run from www.example.com. + * + * If you are running multisite, or if you are running your site from + * different domain names (eg, you don't redirect http://www.example.com to + * http://example.com), you should specify all of the host patterns that are + * allowed by your site. + * + * For example: + * @code + * $settings['trusted_host_patterns'] = [ + * '^example\.com$', + * '^.+\.example\.com$', + * '^example\.org$', + * '^.+\.example\.org$', + * ]; + * @endcode + * will allow the site to run off of all variants of example.com and + * example.org, with all subdomains included. + */ + +/** + * The default list of directories that will be ignored by Drupal's file API. + * + * By default ignore node_modules and bower_components folders to avoid issues + * with common frontend tools and recursive scanning of directories looking for + * extensions. + * + * @see \Drupal\Core\File\FileSystemInterface::scanDirectory() + * @see \Drupal\Core\Extension\ExtensionDiscovery::scanDirectory() + */ +$settings['file_scan_ignore_directories'] = [ + 'node_modules', + 'bower_components', +]; + +/** + * The default number of entities to update in a batch process. + * + * This is used by update and post-update functions that need to go through and + * change all the entities on a site, so it is useful to increase this number + * if your hosting configuration (i.e. RAM allocation, CPU speed) allows for a + * larger number of entities to be processed in a single batch run. + */ +$settings['entity_update_batch_size'] = 50; + +/** + * Entity update backup. + * + * This is used to inform the entity storage handler that the backup tables as + * well as the original entity type and field storage definitions should be + * retained after a successful entity update process. + */ +$settings['entity_update_backup'] = TRUE; + +/** + * Node migration type. + * + * This is used to force the migration system to use the classic node migrations + * instead of the default complete node migrations. The migration system will + * use the classic node migration only if there are existing migrate_map tables + * for the classic node migrations and they contain data. These tables may not + * exist if you are developing custom migrations and do not want to use the + * complete node migrations. Set this to TRUE to force the use of the classic + * node migrations. + */ +$settings['migrate_node_migrate_type_classic'] = FALSE; + +/** + * Load local development override configuration, if available. + * + * Create a settings.local.php file to override variables on secondary (staging, + * development, etc.) installations of this site. + * + * Typical uses of settings.local.php include: + * - Disabling caching. + * - Disabling JavaScript/CSS compression. + * - Rerouting outgoing emails. + * + * Keep this code block at the end of this file to take full effect. + */ +# +# if (file_exists($app_root . '/' . $site_path . '/settings.local.php')) { +# include $app_root . '/' . $site_path . '/settings.local.php'; +# } diff --git a/.gitignore b/.gitignore index 44428fbee..8ed68ba71 100644 --- a/.gitignore +++ b/.gitignore @@ -33,6 +33,9 @@ !/web/libraries/iframe !/web/libraries/jquery-ui-touch-punch +# Subsites +/scripts/os2subsites_provision + # Ignore files generated by PhpStorm /.idea/ diff --git a/README.md b/README.md index 265de986a..30dacfc1e 100644 --- a/README.md +++ b/README.md @@ -38,6 +38,10 @@ drush en os2web_pagebuilder os2web_spotbox * Enable other modules from OS2Web category and setup them on demand. +## Local development + +OS2Web subsites - See [.docker/os2web-subsites/README.md](.docker/os2web-subsites/README.md) + ## Contribution OS2Web Hjemmeside projects is opened for new features and os course bugfixes.