diff --git a/.docker/apache/conf/httpd.conf b/.docker/apache/conf/httpd.conf deleted file mode 100644 index bec3bbf..0000000 --- a/.docker/apache/conf/httpd.conf +++ /dev/null @@ -1,553 +0,0 @@ -# -# This is the main Apache HTTP server configuration file. It contains the -# configuration directives that give the server its instructions. -# See for detailed information. -# In particular, see -# -# for a discussion of each configuration directive. -# -# Do NOT simply read the instructions in here without understanding -# what they do. They're here only as hints or reminders. If you are unsure -# consult the online docs. You have been warned. -# -# Configuration and logfile names: If the filenames you specify for many -# of the server's control files begin with "/" (or "drive:/" for Win32), the -# server will use that explicit path. If the filenames do *not* begin -# with "/", the value of ServerRoot is prepended -- so "logs/access_log" -# with ServerRoot set to "/usr/local/apache2" will be interpreted by the -# server as "/usr/local/apache2/logs/access_log", whereas "/logs/access_log" -# will be interpreted as '/logs/access_log'. - -# -# ServerRoot: The top of the directory tree under which the server's -# configuration, error, and log files are kept. -# -# Do not add a slash at the end of the directory path. If you point -# ServerRoot at a non-local disk, be sure to specify a local disk on the -# Mutex directive, if file-based mutexes are used. If you wish to share the -# same ServerRoot for multiple httpd daemons, you will need to change at -# least PidFile. -# -ServerRoot "/usr/local/apache2" - -# -# Mutex: Allows you to set the mutex mechanism and mutex file directory -# for individual mutexes, or change the global defaults -# -# Uncomment and change the directory if mutexes are file-based and the default -# mutex file directory is not on a local disk or is not appropriate for some -# other reason. -# -# Mutex default:logs - -# -# Listen: Allows you to bind Apache to specific IP addresses and/or -# ports, instead of the default. See also the -# directive. -# -# Change this to Listen on specific IP addresses as shown below to -# prevent Apache from glomming onto all bound IP addresses. -# -#Listen 12.34.56.78:80 -Listen 80 - -# -# Dynamic Shared Object (DSO) Support -# -# To be able to use the functionality of a module which was built as a DSO you -# have to place corresponding `LoadModule' lines at this location so the -# directives contained in it are actually available _before_ they are used. -# Statically compiled modules (those listed by `httpd -l') do not need -# to be loaded here. -# -# Example: -# LoadModule foo_module modules/mod_foo.so -# -#LoadModule mpm_event_module modules/mod_mpm_event.so -LoadModule mpm_prefork_module modules/mod_mpm_prefork.so -#LoadModule mpm_worker_module modules/mod_mpm_worker.so -LoadModule authn_file_module modules/mod_authn_file.so -#LoadModule authn_dbm_module modules/mod_authn_dbm.so -#LoadModule authn_anon_module modules/mod_authn_anon.so -#LoadModule authn_dbd_module modules/mod_authn_dbd.so -#LoadModule authn_socache_module modules/mod_authn_socache.so -LoadModule authn_core_module modules/mod_authn_core.so -LoadModule authz_host_module modules/mod_authz_host.so -LoadModule authz_groupfile_module modules/mod_authz_groupfile.so -LoadModule authz_user_module modules/mod_authz_user.so -#LoadModule authz_dbm_module modules/mod_authz_dbm.so -#LoadModule authz_owner_module modules/mod_authz_owner.so -#LoadModule authz_dbd_module modules/mod_authz_dbd.so -LoadModule authz_core_module modules/mod_authz_core.so -#LoadModule authnz_ldap_module modules/mod_authnz_ldap.so -#LoadModule authnz_fcgi_module modules/mod_authnz_fcgi.so -LoadModule access_compat_module modules/mod_access_compat.so -LoadModule auth_basic_module modules/mod_auth_basic.so -#LoadModule auth_form_module modules/mod_auth_form.so -#LoadModule auth_digest_module modules/mod_auth_digest.so -#LoadModule allowmethods_module modules/mod_allowmethods.so -#LoadModule isapi_module modules/mod_isapi.so -#LoadModule file_cache_module modules/mod_file_cache.so -#LoadModule cache_module modules/mod_cache.so -#LoadModule cache_disk_module modules/mod_cache_disk.so -#LoadModule cache_socache_module modules/mod_cache_socache.so -LoadModule socache_shmcb_module modules/mod_socache_shmcb.so -#LoadModule socache_dbm_module modules/mod_socache_dbm.so -#LoadModule socache_memcache_module modules/mod_socache_memcache.so -#LoadModule socache_redis_module modules/mod_socache_redis.so -#LoadModule watchdog_module modules/mod_watchdog.so -#LoadModule macro_module modules/mod_macro.so -#LoadModule dbd_module modules/mod_dbd.so -#LoadModule bucketeer_module modules/mod_bucketeer.so -#LoadModule dumpio_module modules/mod_dumpio.so -#LoadModule echo_module modules/mod_echo.so -#LoadModule example_hooks_module modules/mod_example_hooks.so -#LoadModule case_filter_module modules/mod_case_filter.so -#LoadModule case_filter_in_module modules/mod_case_filter_in.so -#LoadModule example_ipc_module modules/mod_example_ipc.so -#LoadModule buffer_module modules/mod_buffer.so -#LoadModule data_module modules/mod_data.so -#LoadModule ratelimit_module modules/mod_ratelimit.so -LoadModule reqtimeout_module modules/mod_reqtimeout.so -#LoadModule ext_filter_module modules/mod_ext_filter.so -#LoadModule request_module modules/mod_request.so -LoadModule include_module modules/mod_include.so -LoadModule filter_module modules/mod_filter.so -#LoadModule reflector_module modules/mod_reflector.so -#LoadModule substitute_module modules/mod_substitute.so -#LoadModule sed_module modules/mod_sed.so -#LoadModule charset_lite_module modules/mod_charset_lite.so -#LoadModule deflate_module modules/mod_deflate.so -LoadModule xml2enc_module modules/mod_xml2enc.so -#LoadModule proxy_html_module modules/mod_proxy_html.so -#LoadModule brotli_module modules/mod_brotli.so -LoadModule mime_module modules/mod_mime.so -#LoadModule ldap_module modules/mod_ldap.so -LoadModule log_config_module modules/mod_log_config.so -#LoadModule log_debug_module modules/mod_log_debug.so -#LoadModule log_forensic_module modules/mod_log_forensic.so -#LoadModule logio_module modules/mod_logio.so -#LoadModule lua_module modules/mod_lua.so -LoadModule env_module modules/mod_env.so -#LoadModule mime_magic_module modules/mod_mime_magic.so -#LoadModule cern_meta_module modules/mod_cern_meta.so -#LoadModule expires_module modules/mod_expires.so -LoadModule headers_module modules/mod_headers.so -#LoadModule ident_module modules/mod_ident.so -#LoadModule usertrack_module modules/mod_usertrack.so -#LoadModule unique_id_module modules/mod_unique_id.so -LoadModule setenvif_module modules/mod_setenvif.so -LoadModule version_module modules/mod_version.so -#LoadModule remoteip_module modules/mod_remoteip.so -LoadModule proxy_module modules/mod_proxy.so -#LoadModule proxy_connect_module modules/mod_proxy_connect.so -#LoadModule proxy_ftp_module modules/mod_proxy_ftp.so -#LoadModule proxy_http_module modules/mod_proxy_http.so -LoadModule proxy_fcgi_module modules/mod_proxy_fcgi.so -#LoadModule proxy_scgi_module modules/mod_proxy_scgi.so -#LoadModule proxy_uwsgi_module modules/mod_proxy_uwsgi.so -#LoadModule proxy_fdpass_module modules/mod_proxy_fdpass.so -#LoadModule proxy_wstunnel_module modules/mod_proxy_wstunnel.so -#LoadModule proxy_ajp_module modules/mod_proxy_ajp.so -#LoadModule proxy_balancer_module modules/mod_proxy_balancer.so -#LoadModule proxy_express_module modules/mod_proxy_express.so -#LoadModule proxy_hcheck_module modules/mod_proxy_hcheck.so -#LoadModule session_module modules/mod_session.so -#LoadModule session_cookie_module modules/mod_session_cookie.so -#LoadModule session_crypto_module modules/mod_session_crypto.so -#LoadModule session_dbd_module modules/mod_session_dbd.so -#LoadModule slotmem_shm_module modules/mod_slotmem_shm.so -#LoadModule slotmem_plain_module modules/mod_slotmem_plain.so -#LoadModule ssl_module modules/mod_ssl.so -#LoadModule optional_hook_export_module modules/mod_optional_hook_export.so -#LoadModule optional_hook_import_module modules/mod_optional_hook_import.so -#LoadModule optional_fn_import_module modules/mod_optional_fn_import.so -#LoadModule optional_fn_export_module modules/mod_optional_fn_export.so -#LoadModule dialup_module modules/mod_dialup.so -#LoadModule http2_module modules/mod_http2.so -#LoadModule proxy_http2_module modules/mod_proxy_http2.so -#LoadModule md_module modules/mod_md.so -#LoadModule lbmethod_byrequests_module modules/mod_lbmethod_byrequests.so -#LoadModule lbmethod_bytraffic_module modules/mod_lbmethod_bytraffic.so -#LoadModule lbmethod_bybusyness_module modules/mod_lbmethod_bybusyness.so -#LoadModule lbmethod_heartbeat_module modules/mod_lbmethod_heartbeat.so -LoadModule unixd_module modules/mod_unixd.so -#LoadModule heartbeat_module modules/mod_heartbeat.so -#LoadModule heartmonitor_module modules/mod_heartmonitor.so -#LoadModule dav_module modules/mod_dav.so -LoadModule status_module modules/mod_status.so -LoadModule autoindex_module modules/mod_autoindex.so -#LoadModule asis_module modules/mod_asis.so -#LoadModule info_module modules/mod_info.so -#LoadModule suexec_module modules/mod_suexec.so - - #LoadModule cgid_module modules/mod_cgid.so - - - #LoadModule cgi_module modules/mod_cgi.so - -#LoadModule dav_fs_module modules/mod_dav_fs.so -#LoadModule dav_lock_module modules/mod_dav_lock.so -#LoadModule vhost_alias_module modules/mod_vhost_alias.so -#LoadModule negotiation_module modules/mod_negotiation.so -LoadModule dir_module modules/mod_dir.so -#LoadModule imagemap_module modules/mod_imagemap.so -#LoadModule actions_module modules/mod_actions.so -#LoadModule speling_module modules/mod_speling.so -#LoadModule userdir_module modules/mod_userdir.so -LoadModule alias_module modules/mod_alias.so -LoadModule rewrite_module modules/mod_rewrite.so - - -# -# If you wish httpd to run as a different user or group, you must run -# httpd as root initially and it will switch. -# -# User/Group: The name (or #number) of the user/group to run httpd as. -# It is usually good practice to create a dedicated user and group for -# running httpd, as with most system services. -# -User www-data -Group www-data - - - -# 'Main' server configuration -# -# The directives in this section set up the values used by the 'main' -# server, which responds to any requests that aren't handled by a -# definition. These values also provide defaults for -# any containers you may define later in the file. -# -# All of these directives may appear inside containers, -# in which case these default settings will be overridden for the -# virtual host being defined. -# - -# -# ServerAdmin: Your address, where problems with the server should be -# e-mailed. This address appears on some server-generated pages, such -# as error documents. e.g. admin@your-domain.com -# -ServerAdmin drift@bellcom.dk - -# -# ServerName gives the name and port that the server uses to identify itself. -# This can often be determined automatically, but we recommend you specify -# it explicitly to prevent problems during startup. -# -# If your host doesn't have a registered DNS name, enter its IP address here. -# -#ServerName www.example.com:80 - -# -# Deny access to the entirety of your server's filesystem. You must -# explicitly permit access to web content directories in other -# blocks below. -# - - AllowOverride none - Require all denied - - -# -# Note that from this point forward you must specifically allow -# particular features to be enabled - so if something's not working as -# you might expect, make sure that you have specifically enabled it -# below. -# - -# -# DocumentRoot: The directory out of which you will serve your -# documents. By default, all requests are taken from this directory, but -# symbolic links and aliases may be used to point to other locations. -# -DocumentRoot "/var/www/web" - - # - # Possible values for the Options directive are "None", "All", - # or any combination of: - # Indexes Includes FollowSymLinks SymLinksifOwnerMatch ExecCGI MultiViews - # - # Note that "MultiViews" must be named *explicitly* --- "Options All" - # doesn't give it to you. - # - # The Options directive is both complicated and important. Please see - # http://httpd.apache.org/docs/2.4/mod/core.html#options - # for more information. - # - Options Indexes FollowSymLinks - - # - # AllowOverride controls what directives may be placed in .htaccess files. - # It can be "All", "None", or any combination of the keywords: - # AllowOverride FileInfo AuthConfig Limit - # - AllowOverride All - - # - # Controls who can get stuff from this server. - # - Require all granted - - -# -# DirectoryIndex: sets the file that Apache will serve if a directory -# is requested. -# - - DirectoryIndex index.php index.html - - -# -# The following lines prevent .htaccess and .htpasswd files from being -# viewed by Web clients. -# - - Require all denied - - -# -# ErrorLog: The location of the error log file. -# If you do not specify an ErrorLog directive within a -# container, error messages relating to that virtual host will be -# logged here. If you *do* define an error logfile for a -# container, that host's errors will be logged there and not here. -# -ErrorLog /proc/self/fd/2 - -# -# LogLevel: Control the number of messages logged to the error_log. -# Possible values include: debug, info, notice, warn, error, crit, -# alert, emerg. -# -LogLevel warn - - - # - # The following directives define some format nicknames for use with - # a CustomLog directive (see below). - # - LogFormat "%h %l %u %t \"%r\" %>s %b \"%{Referer}i\" \"%{User-Agent}i\"" combined - LogFormat "%h %l %u %t \"%r\" %>s %b" common - - - # You need to enable mod_logio.c to use %I and %O - LogFormat "%h %l %u %t \"%r\" %>s %b \"%{Referer}i\" \"%{User-Agent}i\" %I %O" combinedio - - - # - # The location and format of the access logfile (Common Logfile Format). - # If you do not define any access logfiles within a - # container, they will be logged here. Contrariwise, if you *do* - # define per- access logfiles, transactions will be - # logged therein and *not* in this file. - # - CustomLog /proc/self/fd/1 common - - # - # If you prefer a logfile with access, agent, and referer information - # (Combined Logfile Format) you can use the following directive. - # - #CustomLog "logs/access_log" combined - - - - # - # Redirect: Allows you to tell clients about documents that used to - # exist in your server's namespace, but do not anymore. The client - # will make a new request for the document at its new location. - # Example: - # Redirect permanent /foo http://www.example.com/bar - - # - # Alias: Maps web paths into filesystem paths and is used to - # access content that does not live under the DocumentRoot. - # Example: - # Alias /webpath /full/filesystem/path - # - # If you include a trailing / on /webpath then the server will - # require it to be present in the URL. You will also likely - # need to provide a section to allow access to - # the filesystem path. - - # - # ScriptAlias: This controls which directories contain server scripts. - # ScriptAliases are essentially the same as Aliases, except that - # documents in the target directory are treated as applications and - # run by the server when requested rather than as documents sent to the - # client. The same rules about trailing "/" apply to ScriptAlias - # directives as to Alias. - # - ScriptAlias /cgi-bin/ "/usr/local/apache2/cgi-bin/" - - - - - # - # ScriptSock: On threaded servers, designate the path to the UNIX - # socket used to communicate with the CGI daemon of mod_cgid. - # - #Scriptsock cgisock - - -# -# "/usr/local/apache2/cgi-bin" should be changed to whatever your ScriptAliased -# CGI directory exists, if you have that configured. -# - - AllowOverride None - Options None - Require all granted - - - - # - # Avoid passing HTTP_PROXY environment to CGI's on this or any proxied - # backend servers which have lingering "httpoxy" defects. - # 'Proxy' request header is undefined by the IETF, not listed by IANA - # - RequestHeader unset Proxy early - - - - # - # TypesConfig points to the file containing the list of mappings from - # filename extension to MIME-type. - # - TypesConfig conf/mime.types - - # - # AddType allows you to add to or override the MIME configuration - # file specified in TypesConfig for specific file types. - # - #AddType application/x-gzip .tgz - # - # AddEncoding allows you to have certain browsers uncompress - # information on the fly. Note: Not all browsers support this. - # - #AddEncoding x-compress .Z - #AddEncoding x-gzip .gz .tgz - # - # If the AddEncoding directives above are commented-out, then you - # probably should define those extensions to indicate media types: - # - AddType application/x-compress .Z - AddType application/x-gzip .gz .tgz - - # - # AddHandler allows you to map certain file extensions to "handlers": - # actions unrelated to filetype. These can be either built into the server - # or added with the Action directive (see below) - # - # To use CGI scripts outside of ScriptAliased directories: - # (You will also need to add "ExecCGI" to the "Options" directive.) - # - #AddHandler cgi-script .cgi - - # For type maps (negotiated resources): - #AddHandler type-map var - - # - # Filters allow you to process content before it is sent to the client. - # - # To parse .shtml files for server-side includes (SSI): - # (You will also need to add "Includes" to the "Options" directive.) - # - #AddType text/html .shtml - #AddOutputFilter INCLUDES .shtml - - -# -# The mod_mime_magic module allows the server to use various hints from the -# contents of the file itself to determine its type. The MIMEMagicFile -# directive tells the module where the hint definitions are located. -# -#MIMEMagicFile conf/magic - -# -# Customizable error responses come in three flavors: -# 1) plain text 2) local redirects 3) external redirects -# -# Some examples: -#ErrorDocument 500 "The server made a boo boo." -#ErrorDocument 404 /missing.html -#ErrorDocument 404 "/cgi-bin/missing_handler.pl" -#ErrorDocument 402 http://www.example.com/subscription_info.html -# - -# -# MaxRanges: Maximum number of Ranges in a request before -# returning the entire resource, or one of the special -# values 'default', 'none' or 'unlimited'. -# Default setting is to accept 200 Ranges. -#MaxRanges unlimited - -# -# EnableMMAP and EnableSendfile: On systems that support it, -# memory-mapping or the sendfile syscall may be used to deliver -# files. This usually improves server performance, but must -# be turned off when serving from networked-mounted -# filesystems or if support for these functions is otherwise -# broken on your system. -# Defaults: EnableMMAP On, EnableSendfile Off -# -#EnableMMAP off -#EnableSendfile on - -# Supplemental configuration -# -# The configuration files in the conf/extra/ directory can be -# included to add extra features or to modify the default configuration of -# the server, or you may simply copy their contents here and change as -# necessary. - -# Server-pool management (MPM specific) -#Include conf/extra/httpd-mpm.conf - -# Multi-language error messages -#Include conf/extra/httpd-multilang-errordoc.conf - -# Fancy directory listings -#Include conf/extra/httpd-autoindex.conf - -# Language settings -#Include conf/extra/httpd-languages.conf - -# User home directories -#Include conf/extra/httpd-userdir.conf - -# Real-time info on requests and configuration -#Include conf/extra/httpd-info.conf - -# Virtual hosts -#Include conf/extra/httpd-vhosts.conf - -# Local access to the Apache HTTP Server Manual -#Include conf/extra/httpd-manual.conf - -# Distributed authoring and versioning (WebDAV) -#Include conf/extra/httpd-dav.conf - -# Various default settings -#Include conf/extra/httpd-default.conf - -# Configure mod_proxy_html to understand HTML4/XHTML1 - -Include conf/extra/proxy-html.conf - - -# Secure (SSL/TLS) connections -#Include conf/extra/httpd-ssl.conf -# -# Note: The following must must be present to support -# starting without SSL on platforms with no /dev/random equivalent -# but a statically compiled-in mod_ssl. -# - -SSLRandomSeed startup builtin -SSLRandomSeed connect builtin - - -# Include the virtual host configurations: -IncludeOptional conf/sites-enabled/*.conf diff --git a/.docker/apache/example.com.conf.template b/.docker/apache/example.com.conf.template deleted file mode 100644 index 73d098a..0000000 --- a/.docker/apache/example.com.conf.template +++ /dev/null @@ -1,39 +0,0 @@ - - - Options FollowSymLinks - AllowOverride All - # Uncommenting below will only allow a limited number of Bellcom IPs access to the site - #Include /etc/apache2/limit-bellcom.conf - - - ServerAdmin domains@bellcom.dk - ServerName example.com - - DocumentRoot /var/www/web - - # SimpleSAMLphp - SetEnv SIMPLESAMLPHP_CONFIG_DIR /var/www/simplesamlphp/config - Alias /simplesaml /var/www/vendor/simplesamlphp/simplesamlphp/www - - - - # For Apache 2.2: - Order allow,deny - Allow from all - - - # For Apache 2.4: - Require all granted - - - - # php_admin_value open_basedir /var/www/web:/usr/share/php:/var/www/simplesamlphp - - # Proxying php requests through port 9000 to the php container - - SetHandler "proxy:fcgi://php:9000" - - - CustomLog /var/www/logs/access.log combined - ErrorLog /var/www/logs/error.log - diff --git a/.docker/os2forms/Dockerfile b/.docker/os2forms/Dockerfile new file mode 100644 index 0000000..5452856 --- /dev/null +++ b/.docker/os2forms/Dockerfile @@ -0,0 +1,62 @@ +FROM drupal:8-apache-buster + +# Installing additional dependencies. +RUN set -eux; \ + apt update; \ + apt install -qq -y \ + libxml2-dev \ + libldap2-dev \ + git \ + wget \ + zip \ + mariadb-client-10.3 \ + cron; \ + docker-php-ext-configure ldap --with-libdir=lib/x86_64-linux-gnu/ && \ + docker-php-ext-install soap ldap + +# Removing standard Drupal core and loading OS2Web project. +WORKDIR /opt +# Getting recent state of master branch. +ARG OS2FORMS8_TAG +RUN set -eux; \ + rm -rf drupal; \ +# PRODUCTION SETTINGS +# Loading OS2Forms via tags. +# wget https://github.com/os2forms/os2forms8/archive/$OS2FORMS8_TAG.tar.gz; \ +# tar -xzvf $OS2FORMS8_TAG.tar.gz; \ +# rm $OS2FORMS8_TAG.tar.gz; \ +# mv os2forms8-$OS2FORMS8_TAG drupal +# DEVELOPMENT SETTINGS +# Loading OS2Forms from branch to avoid development releases. + wget https://github.com/OS2Forms/os2forms8/archive/docker.zip; \ + unzip docker.zip; \ + rm docker.zip; \ + mv os2forms8-docker drupal +WORKDIR /opt/drupal + +# Loading composer dependencies and configuring project folders. +RUN set -eux; \ + composer self-update --1; \ + export COMPOSER_HOME="$(mktemp -d)"; \ + composer global require hirak/prestissimo;\ + COMPOSER_MEMORY_LIMIT=-1 composer install; \ + chown -R www-data:www-data web/sites web/modules web/themes; \ + # delete composer cache. + rm -rf "$COMPOSER_HOME" + +# Adding further site specific data to image. +RUN mkdir -p files; \ + mkdir -p private; \ + mkdir -p config/sync; \ + mkdir -p tmp; \ + rm -rf /opt/drupal/web/sites/default/files; \ + ln -sf /opt/drupal/files /opt/drupal/web/sites/default/files; \ + # Adjusting ownership + chown -R www-data:www-data /opt/drupal/private /opt/drupal/files /opt/drupal/config/sync /opt/drupal/tmp /opt/drupal/logs; \ + chmod g+s -R /opt/drupal/private /opt/drupal/files /opt/drupal/config/sync + +# Adding custom apache configuration with PHP value and log settings. +COPY apache/000-default.conf /etc/apache2/sites-enabled/000-default.conf + +# Adding Drupal settings. +COPY drupal/settings.local.php /opt/drupal/web/sites/default/ diff --git a/.docker/os2forms/README.md b/.docker/os2forms/README.md new file mode 100644 index 0000000..31fbae2 --- /dev/null +++ b/.docker/os2forms/README.md @@ -0,0 +1,37 @@ +# OS2Forms8 docker image + +Purpose of this image to run OS2Forms8 project in dockerized environment. + +Image based on official [Drupal image](https://hub.docker.com/_/drupal) + +Image includes all functional project files inside (PHP code, Composer dependencies). + +Drupal content files should be attached as [Volumes](https://docs.docker.com/storage/volumes/) to container: +* public files - `/opt/drupal/files` +* private files - `/opt/drupal/private` + +## Environment settings + +There are available following environment settings: + +### Mysql database +* MYSQL_HOSTNAME - mysql service host name +* MYSQL_DATABASE - mysql service database name +* MYSQL_PORT - mysql service port +* MYSQL_USER - mysql service user +* MYSQL_PASSWORD - mysql service password + +### Drupal +* DRUPAL_HASH_SALT - define drupal hash salt. Uses in `settings.php` file + +## Build image + +To build image use `build.sh` script with git tag of OS2Forms8 project release as first argument. +NOTE: You should have existing tag for OS2Web project before. + +Example: +``` +./build.sh [tag-name] --push +``` + +`--push` - when you this option build will be pushed to docker hub. diff --git a/.docker/os2forms/apache/000-default.conf b/.docker/os2forms/apache/000-default.conf new file mode 100644 index 0000000..bcb7f5e --- /dev/null +++ b/.docker/os2forms/apache/000-default.conf @@ -0,0 +1,30 @@ + + # There is no host restriction here. + # Restriction should be implemented on upper levels. + #ServerName example.com + ServerAdmin webmaster@localhost + DocumentRoot /var/www/html + + ErrorLog ${APACHE_LOG_DIR}/error.log + CustomLog ${APACHE_LOG_DIR}/access.log combined + + # SimpleSAMLphp settings + SetEnv SIMPLESAMLPHP_CONFIG_DIR /opt/drupal/simplesamlphp/config + Alias /simplesaml /opt/drupal/vendor/simplesamlphp/simplesamlphp/www + + Require all granted + + + + # PHP Custom settings + 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 150 + php_admin_value upload_tmp_dir /opt/drupal/tmp + diff --git a/.docker/os2forms/build.sh b/.docker/os2forms/build.sh new file mode 100755 index 0000000..3badfda --- /dev/null +++ b/.docker/os2forms/build.sh @@ -0,0 +1,32 @@ +#!/bin/bash + +if [ $# -eq 0 ]; then + echo "WARNING: There was no tag-name provided!" + echo "Script usage is: './build.sh tag-name'" + echo "Example: './build.sh 1.0.3'" + exit 0 +fi + +echo "Updating base image" +docker image pull drupal:8-apache-buster + +echo "Building OS2Forms image with tag $1" +docker build ./ --build-arg OS2FORMS8_TAG=$1 -t os2forms/os2forms8:$1 + +if [ "$2" = "--push" ]; then + echo "Authorization to https://hub.docker.com. :" + echo "Login:" + read -s DOCKERHUB_LOGIN + echo "Password:" + read -s DOCKERHUB_PASS + echo "Authorization..." + echo $DOCKERHUB_PASS | docker login --username $DOCKERHUB_LOGIN --password-stdin + + if [ $? -eq 0 ]; then + echo "Pushing image to docker hub ..." + docker push os2forms/os2forms8:$1 + echo "Check your image here https://hub.docker.com/repository/docker/os2forms/os2forms8" + else + echo "Image is not pushed to docker hub :(" + fi; +fi; diff --git a/.docker/os2forms/drupal/settings.local.php b/.docker/os2forms/drupal/settings.local.php new file mode 100644 index 0000000..70e50f7 --- /dev/null +++ b/.docker/os2forms/drupal/settings.local.php @@ -0,0 +1,19 @@ + 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'), +]; + +$settings['hash_salt'] = getenv('DRUPAL_HASH_SALT'); +$settings['trusted_host_patterns'] = empty(getenv('DRUPAL_TRUSTED_HOST')) ? NULL : ['^'.getenv('DRUPAL_TRUSTED_HOST').'$']; + +$settings['config_sync_directory'] = '../config/sync'; +$settings['file_temp_path'] = '../tmp'; +$settings['file_private_path'] = '../private'; diff --git a/.docker/php/logs/.keep b/.docker/os2forms/logs/.keep similarity index 100% rename from .docker/php/logs/.keep rename to .docker/os2forms/logs/.keep diff --git a/.docker/php/Dockerfile b/.docker/php/Dockerfile deleted file mode 100644 index bb1caac..0000000 --- a/.docker/php/Dockerfile +++ /dev/null @@ -1,48 +0,0 @@ -FROM php:7.4-fpm-buster - -WORKDIR "/var/www" - -ARG DEBIAN_FRONTEND=noninteractive - -# Essentials and php modules. -# Yarn issue: https://github.com/yarnpkg/yarn/issues/2821 -RUN apt-get update \ - && apt-get remove cmdtest \ - && apt-get install -qq -y \ - build-essential \ - git wget cron \ - libfreetype6-dev \ - libjpeg62-turbo-dev \ - libpng-dev \ - mariadb-client-10.3 \ - libzip-dev zip unzip \ - libicu-dev \ - libxml2-dev \ - vim \ - && docker-php-ext-configure gd --with-freetype --with-jpeg \ - && docker-php-ext-install -j$(nproc) gd \ - && docker-php-ext-configure zip \ - && docker-php-ext-install zip \ - && docker-php-ext-install pdo pdo_mysql \ - && docker-php-ext-configure intl \ - && docker-php-ext-install intl \ - && docker-php-ext-install soap \ - && docker-php-ext-install xml \ - && docker-php-ext-install opcache - -# pecl extensions -#RUN pecl install redis-5.1.1 \ -# && pecl install xdebug-2.8.1 \ -# && docker-php-ext-enable redis xdebug - -# Composer -RUN curl -sS https://getcomposer.org/installer | php -- --install-dir=/usr/local/bin --filename=composer - -# Drush launcher -RUN curl -fsSL "https://github.com/drush-ops/drush-launcher/releases/latest/download/drush.phar" -o /usr/local/bin/drush && chmod +x /usr/local/bin/drush - -# Cache tool -# https://github.com/gordalina/cachetool -#RUN curl -sO https://github.com/gordalina/cachetool/releases/latest/download/cachetool.phar \ -# && chmod +x cachetool.phar \ -# && mv cachetool.phar /usr/local/bin/cachetool diff --git a/.docker/php/custom.ini b/.docker/php/custom.ini deleted file mode 100644 index 5bb1949..0000000 --- a/.docker/php/custom.ini +++ /dev/null @@ -1,31 +0,0 @@ -; =-=-=-= Error logging =-=-=-= -error_reporting = E_STRICT -log_errors = On -display_errors = Off -html_errors = Off -error_log = /var/logs/php.log - -; =-=-=-= Misc =-=-=-= -date.timezone = UTC -memory_limit = 256M -upload_max_filesize = 20M -post_max_size = 20M -max_execution_time = 600 -default_socket_timeout = 3600 -request_terminate_timeout = 600 - -; =-=-=-= Xdebug =-=-=-= -; xdebug.remote_host="host.docker.internal" -; xdebug.remote_connect_back=1 -; xdebug.remote_port=9000 -; xdebug.idekey=PHPSTORM -; xdebug.remote_autostart=0 -; xdebug.remote_enable=1 -; xdebug.cli_color=0 -; xdebug.profiler_enable=0 -; xdebug.profiler_output_dir="/var/logs/profiling" -; xdebug.remote_handler=dbgp -; xdebug.remote_mode=req -; xdebug.var_display_max_children=-1 -; xdebug.var_display_max_data=-1 -; xdebug.var_display_max_depth=-1 \ No newline at end of file diff --git a/.env.example b/.env.example index 61fd4b0..016ccfe 100755 --- a/.env.example +++ b/.env.example @@ -17,13 +17,17 @@ # ]; # # Uncomment and populate as needed. -# APP_ENV=dev -# DATA_PATH_HOST=~/.docker/data -# MYSQL_ROOT_PASSWORD=5up3r_57r0nk_p455w0rd -# MYSQL_DATABASE=lorge_database -# MYSQL_USER=database_user -# MYSQL_PASSWORD=5up3r_53cr37_p455w0rd -# COMPOSE_PROJECT_NAME=os2forms -# -# Another common use case is to set Drush's --uri via environment. -# DRUSH_OPTIONS_URI=http://example.com +# MYSQL_ROOT_PASSWORD= +# MYSQL_DATABASE= +# MYSQL_HOSTNAME= +# MYSQL_USER= +# MYSQL_PASSWORD= +# MYSQL_PORT= +# DRUPAL_HASH_SALT= +# DRUPAL_TRUSTED_HOST= + +# OS2Forms8 image tag. See https://hub.docker.com/repository/docker/os2forms/os2forms8 +# OS2FORMS8_TAG= + +# Port that is used on host machine for reaching out application +# WEB_SERVER_PORT=80 diff --git a/.gitignore b/.gitignore index e1fa2a9..de580eb 100755 --- a/.gitignore +++ b/.gitignore @@ -11,8 +11,22 @@ /web/sites/*/settings.php /web/sites/*/settings.local.php -# Ignore Drupal's file directory +# Ignore config files. It's not supposed to use configuration management flow. +/config/ + +# Ignore Drupal's file directory and other project sensitive information. /web/sites/*/files/ +logs/* +!logs/.gitkeep +tmp/* +!tmp/.gitkeep +files/* +!files/.gitkeep +private/* +!private/.gitkeep +simplesamlphp/* +!simplesamlphp/README.md +!simplesamlphp/config/.gitkeep # Ignore SimpleTest multi-site environment. /web/sites/simpletest @@ -28,9 +42,8 @@ !/.docksal/commands/rebuild-test # docker stuff -logs/*.log -.docker/logs/*.log .docker/php/logs/*.log +.docker/mariadb/data .docker/apache/logs/*.log .docker/apache/conf/sites-enabled/*.conf /.csslintrc @@ -45,4 +58,4 @@ logs/*.log /index.php /robots.txt /update.php -/web.config \ No newline at end of file +/web.config diff --git a/README.md b/README.md index 8a337da..7bf9a90 100755 --- a/README.md +++ b/README.md @@ -1,54 +1,215 @@ -# OS2Forms Drupal 8 project [![Build Status](https://travis-ci.org/OS2Forms/os2forms8.svg?branch=master)](https://travis-ci.org/OS2Forms/os2forms8) +# OS2Forms Drupal 8 project -## Usage +[![Build Status](https://travis-ci.org/OS2Forms/os2forms8.svg?branch=master)](https://travis-ci.org/OS2Forms/os2forms8) -* Clone the repository +## Getting Started - ``` - git clone git@github.com:OS2Forms/os2forms8.git - ``` -* Rename your installation if needed +These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system. -* Go to the installation and start composer - ``` - composer install - ``` -* Follow the regular install process, select ```OS2Forms8``` as install profile. -* After installation is done, enable OS2Forms by: - ``` - drush en os2forms, os2forms_nemid, os2forms_dawa, os2forms_sbsys - ``` -* Enable `Custom theme` for project. This is a recommended theme that has minimum settings, - so you will need to add all required blocks into proper regions afterwards. +### Traditional -### Drupal settings +#### Installing -Main Drupal setting file `web/sites/default/settings.php` has been added to git index. -By this way all os2forms projects are getting default settings, like temporary -directory, private directory, sync directory. +1. Clone the git repository + ```sh + git clone git@github.com:OS2Forms/os2forms8.git + ``` -All project's sensitive configuration should be stored in `settings.local.php` -file. This file will be included from main `settings.php` settings. +2. Enter the newly created project directory + ```sh + cd os2forms8 + ``` -#### Multisite/Subsite configuration. +3. Install dependencies + ```sh + composer install + ``` -On multisite solution main Drupal setting file`web/sites/default/settings.php` -should be included into subsite's `settings.php` file. The easiest way to get -the new configuration on a subsite is to copy prepared template -`web/sites/subsite.settings.php` and add DB configuration, salt. +4. Install drupal based on OS2Forms profile. Make sure you substitute the following variables: + * db_pass + * db_user + * db_host + * db_name + * account_password + * site_name + ```sh + drush si os2forms8 --db-url=mysql://db_pass:db_user@db_host/db_name --account-pass=account_password --site-name="site_name" + ``` -Hint to generate salt string: +### With Docksal + +#### Prerequisites + +* [Docksal](https://docksal.io/) + +#### Installing + +1. Clone the git repository + ```sh + git clone git@github.com:OS2Forms/os2forms8.git + ``` + +2. Enter the newly created project directory + ```sh + cd os2forms8 + ``` + +3. Start docksal environment + ```sh + fin start + ``` + +4. Install dependencies and enable modules + ```sh + fin rebuild-test + ``` + +5. Create local settings + ```sh + cp web/sites/example.settings.local.php web/sites/default/settings.local.php + ``` + +6. Configure trusted hosts in settings.local.php (add the following if not present) + ```php + // web/sites/default/settings.local.php + + $settings['trusted_host_patterns'] = ['^os2forms8.docksal$', '^localhost$']; + ``` + +You should now be able to browse to the application at `http://os2forms8.docksal` + +## Deployment + +These instructions will get you a copy of the project up and running on a live system. +For a more detailed description, you could look at the `web/core/INSTALL.txt` [here](./web/core/INSTALL.txt). + +### Prerequisites + +* A HTTP server such as [Apache](https://httpd.apache.org/) that supports PHP +* A database service such as [MySQL](https://www.mysql.com/) +* PHP 7 with the following extensions enabled: + * gd + * curl + * simplexml + * xml + * dom + * soap + * mbstring + * database specific extension such as the mysql extension +* [Composer](https://getcomposer.org/) + +### Installing + +1. Clone the git repository +```sh +git clone git@github.com:OS2Forms/os2forms8.git ``` -drush php-eval 'echo \Drupal\Component\Utility\Crypt::randomBytesBase64(55) . "\n";' + +2. Enter the newly created project directory +```sh +cd os2forms8 ``` -## Contribution +3. Install dependencies without development dependencies +```sh +composer install --no-dev +``` + +4. Generate a salt string and insert it in web/sites/default/settings.php + ```sh + # Generate salt string - this will output a new salt string + ./vendor/bin/drush php-eval 'echo \Drupal\Component\Utility\Crypt::randomBytesBase64(55) . "\n";' + ``` + + ```php + // web/sites/default/settings.php + $settings['hash_salt'] = ''; // Insert the generated salt string here + ``` + +5. Configure trusted hosts in web/sites/default/settings.php. + For more information on how to write this, see the section for [Trusted Host settings](https://www.drupal.org/docs/installing-drupal/trusted-host-settings) + in the official Drupal installation guide. + ```php + // web/sites/default/settings.php + + $settings['trusted_host_patterns'] = ['']; + ``` +6. Visit the url for the os2forms application and follow the instructions + * Select the os2forms install profile for a default os2forms installation -OS2Forms projects is an opened for new features and os course bugfixes. -If you have any suggestion, or you found a bug in project, you are very welcome -to create an issue in github repository issue tracker. -For issue description there is expected that you will provide clear and -sufficient information about your feature request or bug report. +7. Enable OS2Forms modules + ```sh + ./vendor/bin/drush en os2forms, os2forms_nemid, os2forms_dawa, os2forms_sbsys + ``` + +## Contributing + +OS2Forms projects is open for new features and os course bugfixes. If you have any suggestion, or you found a bug in project, you are very welcome to create an issue in github repository issue tracker. For issue description there is expected that you will provide clear and sufficient information about your feature request or bug report. + +### Development environment + +For development purposes there has been included development environment driven +by [Docksal](https://docksal.io/). You can find all settings related to in +`/.docksal` folder. + +See official manual on [how to install docksal](https://docksal.io/installation) on your local +development machine. + +Since you have installed docksal it's easy to get installed default installation. +Use following commands: +``` +# Clone project if you didn't do it yet +git clone git@github.com:OS2Forms/os2forms8.git os2forms8-dev +cd os2forms8-dev +# Start docksal environment +fin start +``` +As result, you will get URL like `http://os2forms8-dev.docksal` that is going to + be used for access os2forms application. + +Run `fin help` to see commands you may need. You see [more information about docksal `fin` command](https://docs.docksal.io/fin/fin/) + +Most useful commands: +- `fin start/stop/restart` - start/stop/restart environment +- `fin bash` - get ssh access in CLI container +- `fin drush [comnnand]` - run drush command from host mashine in CLI container +- `fin composer [comnnand]` - run composer command from host mashine in CLI container +- `fin exec 'command'` - run any command from host machine in CLI container + +### Install default installation + +To get default installation just run `fin rebuild-test` command. Docksal will +create default os2forms installation for you. + +Before start using it you need to add trusted hosts settings. See next section. + +### Upload existing db +If you have existing database you want to upload and use, then you have to +configure Drupal settings (see section above). NOTE: It's recommended to add +settings `settings.local.php` file. + +Default db service credentials: + +``` +$databases['default']['default'] = array ( + 'database' => 'default', + 'username' => 'root', + 'password' => 'root', + 'prefix' => '', + 'host' => 'db', + 'port' => '', + 'namespace' => 'Drupal\\Core\\Database\\Driver\\mysql', + 'driver' => 'mysql', +); +``` + +Use `fin bash` or `fin drush [command]` to upload your database + +You also need to add the rest drupal settings such as salt, sync/tmp folders, +trusted hosts +``` +$settings['trusted_host_patterns'] = ['^os2forms8-dev.docksal$', '^localhost$']; +``` ### Code review policy See [OS2Forms code review policy](https://github.com/OS2Forms/docs#code-review) diff --git a/docker-compose.yaml b/docker-compose.yaml index 5bfdd6d..2bc2df4 100644 --- a/docker-compose.yaml +++ b/docker-compose.yaml @@ -1,8 +1,6 @@ version: '3.7' networks: - frontend: - driver: bridge backend: driver: bridge @@ -11,55 +9,27 @@ volumes: driver: local services: - php: - build: - context: ./.docker/php - container_name: php + image: os2forms/os2forms8:${OS2FORMS8_TAG} + env_file: + - .env + ports: + - ${WEB_SERVER_PORT}:80 volumes: - - ./.docker/php/custom.ini:/usr/local/etc/php/conf.d/custom.ini:ro,delegated - - ./:/var/www:delegated - - ./.docker/php/logs:/var/log:delegated + - ./simplesamlphp:/opt/drupal/simplesamlphp depends_on: - mariadb - expose: - - "9000" networks: - backend - environment: - - APP_ENV=${APP_ENV} restart: always mariadb: image: mariadb:latest - container_name: mariadb - volumes: - - ${DATA_PATH_HOST}/mariadb:/var/lib/mysql:delegated - - ./.docker/mariadb/my.cnf:/etc/mysql/conf.d/my.cnf:ro,delegated - environment: - - MYSQL_ROOT_PASSWORD=${MYSQL_ROOT_PASSWORD} - - MYSQL_DATABASE=${MYSQL_DATABASE} - - MYSQL_USER=${MYSQL_USER} - - MYSQL_PASSWORD=${MYSQL_PASSWORD} - expose: - - "3306" - networks: - - backend - restart: always - - apache: - image: httpd:latest - container_name: apache - ports: - - "80:80" + env_file: + - .env volumes: - - ./:/var/www:delegated - - ./.docker/apache/conf/httpd.conf:/usr/local/apache2/conf/httpd.conf - - ./.docker/apache/conf/sites-enabled:/usr/local/apache2/conf/sites-enabled:delegated - - ./.docker/apache/logs:/var/log/apache:delegated - depends_on: - - php + - .docker/mariadb/data:/var/lib/mysql:delegated + - .docker/mariadb/my.cnf:/etc/mysql/conf.d/my.cnf:ro,delegated networks: - backend - - frontend restart: always diff --git a/logs/.keep b/files/.gitkeep similarity index 100% rename from logs/.keep rename to files/.gitkeep diff --git a/logs/.gitkeep b/logs/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/simplesamlphp/README.md b/simplesamlphp/README.md new file mode 100755 index 0000000..d148d70 --- /dev/null +++ b/simplesamlphp/README.md @@ -0,0 +1,25 @@ +# SimplesamlPHP configuration + +Purpose of this directory to store SimplesamlPHP configuration. + +SimplesamlPHP library code manages via composer and stored in `vendor/simplesamlphp` + +Configuration from this directory attached to application via vhost settings in apache server +like: + +``` + SetEnv SIMPLESAMLPHP_CONFIG_DIR /var/www/html/simplesamlphp/config + Alias /simplesaml /var/www/vendor/simplesamlphp/simplesamlphp/www +``` + +In example above is assumes that your project installed in `/var/www` directory. + +## Recommended + +Recommended directories configuration in `simplesamlphp/config/config.php` file: +``` + 'certdir' => '/project/root/path/simplesamlphp/cert/', + 'loggingdir' => '/project/root/path/logs/simplesamlphp/', + 'datadir' => '/project/root/path/simplesamlphp/data/', + 'tempdir' => '/project/root/path/tmp/simplesamlphp', +``` diff --git a/tmp/.gitkeep b/tmp/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/web/health-check.php b/web/health-check.php new file mode 100644 index 0000000..bf0b80b --- /dev/null +++ b/web/health-check.php @@ -0,0 +1,50 @@ +handle($request); + $result = 'NOK'; + // Only 200 response code is allowed for valid health check. + if ($response->getStatusCode() == 200) { + http_response_code($response->getStatusCode()); + $result = 'OK'; + } + else { + $stderr = fopen('php://stderr', 'w'); + fwrite($stderr,print_r($result, 1) . "\n"); + fwrite($stderr,print_r($response, 1) . "\n"); + fclose($stderr); + } +} +catch (\Exception $exception) { + $result = 'NOK' . PHP_EOL; + $result .= $exception->getMessage(); + $fh = fopen('php://stderr','w'); + fwrite($fh, $result . "\n"); + fclose($fh); +} + +print $result;