105 |
106 |
107 |
108 | 109 |
110 | HCL Domino Setup completed – Waiting for server to start 111 |
112 |
113 |
114 |
115 |
116 |
117 |
118 |
--------------------------------------------------------------------------------
/dockerfiles/install_dir_volt/install.sh:
--------------------------------------------------------------------------------
1 | #!/bin/bash
2 |
3 | ############################################################################
4 | # Copyright Nash!Com, Daniel Nashed 2019, 2022 - APACHE 2.0 see LICENSE
5 | ############################################################################
6 |
7 | INSTALL_DIR=$(dirname $0)
8 | export LANG=C
9 |
10 | # Include helper functions
11 |
12 | . $INSTALL_DIR/script_lib.sh
13 |
14 | INSTALL_ADDON_DATA_TAR=$DOMDOCK_DIR/install_data_addon_${PROD_NAME}.taz
15 |
16 | # --- Main Install Logic ---
17 |
18 | header "Environment Setup"
19 |
20 | echo "INSTALL_DIR = [$INSTALL_DIR]"
21 | echo "DownloadFrom = [$DownloadFrom]"
22 | echo "Product = [$PROD_NAME]"
23 | echo "Version = [$PROD_VER]"
24 | echo "DominoUserID = [$DominoUserID]"
25 |
26 | # Check for Linux updates if requested
27 | check_linux_update
28 |
29 | cd "$INSTALL_DIR"
30 |
31 | # Download updated software.txt file if available
32 | download_file_ifpresent "$DownloadFrom" software.txt "$INSTALL_DIR"
33 |
34 | # Installing Add-On Product
35 |
36 | header "$PROD_NAME Installation"
37 |
38 | INST_VER=$PROD_VER
39 |
40 | if [ -n "$INST_VER" ]; then
41 |
42 | # If explicitly specified just download and skip calculating hash
43 | if [ -n "$PROD_DOWNLOAD_FILE" ]; then
44 | echo "Info: Not checking download hash for [$PROD_DOWNLOAD_FILE]"
45 | DOWNLOAD_NAME="$PROD_DOWNLOAD_FILE"
46 | download_and_check_hash "$DownloadFrom" "$DOWNLOAD_NAME" $PROD_NAME . nohash
47 | else
48 | get_download_name $PROD_NAME $INST_VER
49 | download_and_check_hash "$DownloadFrom" "$DOWNLOAD_NAME" $PROD_NAME
50 | fi
51 |
52 | else
53 | log_error "No Target Version specified"
54 | exit 1
55 | fi
56 |
57 | header "Installing $PROD_NAME $INST_VER"
58 |
59 | create_directory $DOMINO_USER $DOMINO_GROUP $DIR_PERM
60 |
61 | OSGI_FOLDER="$Notes_ExecDirectory/osgi"
62 | OSGI_VOLT_FOLDER=$OSGI_FOLDER"/volt"
63 | PLUGINS_FOLDER=$OSGI_VOLT_FOLDER"/eclipse/plugins"
64 | VOLT_DATA_DIR=$DOMINO_DATA_PATH"/volt"
65 | LINKS_FOLDER=$OSGI_FOLDER"/rcp/eclipse/links"
66 | LINK_PATH=$OSGI_FOLDER"/volt"
67 | LINK_FILE=$LINKS_FOLDER"/volt.link"
68 |
69 | create_directory "$VOLT_DATA_DIR" $DOMINO_USER $DOMINO_GROUP $DIR_PERM
70 | create_directory "$OSGI_VOLT_FOLDER" root root 755
71 | create_directory "$LINKS_FOLDER" root root 755
72 | create_directory "$PLUGINS_FOLDER" root root 755
73 |
74 | echo 'path='$LINK_PATH > $LINK_FILE
75 |
76 | cd $PROD_NAME
77 | echo "Unzipping files .."
78 | unzip -q *.zip
79 |
80 | echo "Copying files .."
81 | cp -f "templates/"* "$VOLT_DATA_DIR"
82 | cp -f "bundles/"* "$PLUGINS_FOLDER"
83 |
84 | cd ..
85 | remove_directory $PROD_NAME
86 |
87 | header "Final Steps & Configuration"
88 |
89 | # Ensure permissons are set correctly for data directory
90 | chown -R $DOMINO_USER:$DOMINO_GROUP $DOMINO_DATA_PATH
91 |
92 | # Take a backup copy of Product Data Files
93 |
94 | # Set Installed Version
95 | set_version
96 |
97 | # Copy demopack.zip if present in install dir
98 | if [ -e "$INSTALL_DIR/demopack.zip" ]; then
99 | cp "$INSTALL_DIR/demopack.zip" "$DOMDOCK_DIR/demopack.zip"
100 | fi
101 |
102 | cd $DOMINO_DATA_PATH
103 | tar -czf "$INSTALL_ADDON_DATA_TAR" volt ${PROD_NAME}_ver.txt
104 |
105 | remove_directory "$DOMINO_DATA_PATH"
106 | create_directory "$DOMINO_DATA_PATH" "$DOMINO_USER" $DOMINO_GROUP $DIR_PERM
107 |
108 | # Cleanup repository cache to save space
109 | clean_linux_repo_cache
110 |
111 | header "Successfully completed installation!"
112 |
--------------------------------------------------------------------------------
/docs/concept_benefits.md:
--------------------------------------------------------------------------------
1 | ---
2 | layout: default
3 | title: "Community image benefits"
4 | nav_order: 5
5 | parent: "Concept & Overview"
6 | description: "Community image benefits vs. HCL pre-build image"
7 | has_children: false
8 | ---
9 |
10 |
11 | The ready to use container image is built by HCL based on the Domino and Traveler web-kits using the same community build script.
12 | But there are a couple of benefits using the open source container image build script on your own.
13 |
14 | The build script in the project is easy to use and provides [MHS software download](https://my.hcltechsw.com/) automation and comes with a build menu.
15 |
16 | Below are some differences and benefits when building the container image on your own.
17 | A standard vendor build image can't provide the same flexibility and has to focus on the functionality of the product itself.
18 |
19 | When running the open source container image you are running the same HCL provided software with the same level of support.
20 | It's just built on your own in your own environment with software packages downloaded from the MHS instead of using the pre-cooked standard image.
21 |
22 | Specially container environments require flexibility building and enhancing images.
23 |
24 |
25 | ## Differences and benefits using the community image
26 |
27 | - Building the image on your own ensures you have the latest Redhat UBI image 9.x version included. HCL only updates the image at release time.
28 |
29 | - The container image supports Domino add-on packages like the Domino Leap, the REST API and the language pack.
30 |
31 | - It allows to install the latest version of all add-on products of HCL Verse, Nomad Server, Traveler, REST API, Domino Leap as soon they are available.
32 |
33 | - You can build an all in one image or separate images for different server types.
34 |
35 | - The HCL container image only supports the English locale. The community image allows to build with any locale support and adds your build machines locale as the default.
36 |
37 | - The community image comes with full timezone support. The HCL Container image is intended to run in UTC locale.
38 |
39 | - A shipping container image can only include the bare minimum software needed to run the application. To install additional software you would need to create your own container build environment and build a derived image.
40 |
41 | - The community project supports to define your own add-on packages, which can be installed during the build process.
42 |
43 | - By default the community image is built on the latest Redhat UBI 9.x minimum only selecting the packages needed for Domino and adds a couple of additional useful packages.
44 |
45 | - The HCL image is built on the bigger Redhat UBI 9.1 standard image. See details in Redhat blog post [Introducing the Red Hat Universal Base Image ](https://www.redhat.com/en/blog/introducing-red-hat-universal-base-image).
46 |
47 | - The community image also supports to build on other Domino supported base images. This allows full flexibility and also helps you on software testing if you want to run Domino on a different Linux flavor. See [Supported base images](https://opensource.hcltechsw.com/domino-container/concept_environments/#supported-base-images) for details.
48 |
49 | - If you are a C-API developer you can create a build container which allows you to build for different Domino versions using different versions of the C-API SDK. When selecting the C-API option the container provides a ready to use build environment.
50 |
51 | - In case you need additional Linux packages, the container build script allows to specify those packages when building the image.
52 |
--------------------------------------------------------------------------------
/examples/safelinx/nginx.conf:
--------------------------------------------------------------------------------
1 | # NGINX configuration
2 | # -------------------
3 |
4 | # DNUG Lab configuration example
5 | # June 2022, Daniel Nashed
6 | # Copyright Nash!Com, Daniel Nashed 2022 - APACHE 2.0 see LICENSE
7 |
8 | # - Domino HTTPS
9 | # - SafeLinx + Nomad Web
10 | # - Redirect port HTTP to HTTPS
11 | # - Redirec to ACME HTTP-01 challenges to dedicated Domino CertMgr server
12 |
13 | worker_processes auto;
14 |
15 | events {
16 | worker_connections 1024;
17 | use epoll;
18 | }
19 |
20 | http {
21 |
22 | include mime.types;
23 | default_type application/octet-stream;
24 | sendfile on;
25 | keepalive_timeout 65;
26 |
27 | server {
28 |
29 | # Port 80 is redirected to 443
30 | # Only ACME challenges are redirected to CertMgr server
31 |
32 | listen 80 default_server;
33 | listen [::]:80 default_server;
34 | server_name _;
35 |
36 | # Redirect all ACME request to a fixed Domino CertMgr server
37 |
38 | location /.well-known/acme-challenge/ {
39 | return 301 https://linus.lab.dnug.eu$request_uri;
40 | }
41 |
42 | # Redirect to HTTPS on requesting host
43 |
44 | location / {
45 | return 301 https://$host$request_uri;
46 | }
47 | }
48 |
49 | server {
50 |
51 | # Domino HTTPS
52 |
53 | listen 443 ssl http2;
54 | server_name ray.lab.dnug.eu;
55 | add_header Strict-Transport-Security "max-age=31536000; includeSubDomains" always;
56 |
57 | ssl_certificate /local/nginx/wild-lab-dnug.pem;
58 | ssl_certificate_key /local/nginx/wild-lab-dnug.key;
59 |
60 | ssl_protocols TLSv1.2 TLSv1.3;
61 |
62 | ssl_session_cache shared:SSL:5m;
63 | ssl_session_timeout 5m;
64 |
65 | #ssl_ciphers HIGH:!aNULL:!MD5:!SHA1;
66 | ssl_ciphers ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-CHACHA20-POLY1305:ECDHE-RSA-CHACHA20-POLY1305:DHE-RSA-AES128-GCM-SHA256:DHE-RSA-AES256-GCM-SHA384;
67 | ssl_prefer_server_ciphers on;
68 |
69 | access_log off;
70 |
71 | location / {
72 | proxy_set_header Host $host;
73 | proxy_set_header X-Real-IP $remote_addr;
74 | proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
75 |
76 | # Local IP and Domino container port for HTTPS Domino
77 | proxy_pass https://127.0.0.1:444;
78 | }
79 | }
80 |
81 | server {
82 |
83 | # SafeLinx Nomad Web config with Web Sockets
84 |
85 | listen 443 ssl http2;
86 | server_name nomad.lab.dnug.eu;
87 | add_header Strict-Transport-Security "max-age=31536000; includeSubDomains" always;
88 |
89 | ssl_certificate /local/nginx/wild-lab-dnug.pem;
90 | ssl_certificate_key /local/nginx/wild-lab-dnug.key;
91 |
92 | ssl_protocols TLSv1.2 TLSv1.3;
93 |
94 | ssl_session_cache shared:SSL:5m;
95 | ssl_session_timeout 5m;
96 |
97 | #ssl_ciphers HIGH:!aNULL:!MD5:!SHA1;
98 | ssl_ciphers ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-CHACHA20-POLY1305:ECDHE-RSA-CHACHA20-POLY1305:DHE-RSA-AES128-GCM-SHA256:DHE-RSA-AES256-GCM-SHA384;
99 | ssl_prefer_server_ciphers on;
100 |
101 | access_log off;
102 |
103 |
104 | # Redirect base URL to Nomad URL
105 | location = / {
106 | return 301 https://$host/nomad;
107 | }
108 |
109 | location / {
110 |
111 | proxy_set_header Upgrade $http_upgrade;
112 | proxy_set_header Connection "Upgrade";
113 | proxy_set_header Host $host;
114 | proxy_set_header X-Real-IP $remote_addr;
115 | proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
116 | proxy_http_version 1.1;
117 |
118 | # Local IP port for HTTPS SafeLinx
119 | proxy_pass https://127.0.0.1:445;
120 | }
121 | }
122 |
123 | }
124 |
125 |
--------------------------------------------------------------------------------
/docs/concept_autotesting.md:
--------------------------------------------------------------------------------
1 | ---
2 | layout: default
3 | title: "Automation Testing"
4 | nav_order: 7
5 | parent: "Concept & Overview"
6 | description: "Automation Testing"
7 | has_children: false
8 | ---
9 |
10 |
11 | # Introduction
12 |
13 | Automation testing plays and important role in software development.
14 | The community image itself can be part of your automation test infrastructure.
15 |
16 | On the other side also the container image itself needs to be automation tested.
17 | The `testing` directory contains an automation test script, which invokes a Domino server configured via Domino One Touch Setup (OTS) and performs automation tests to ensure the container image is functional.
18 |
19 | The automation test can be added to the build process (`-autotest`) and is performed before the image is tagged latest or with another specific label and before the image is optionally pushed to a registry. The automation test script `AutomationTest.sh` can be also started manually on any Domino container image by specifying the image via `-image=xyz`.
20 |
21 |
22 | # Container label for add-on software
23 |
24 | The main labels are reflecting the Domino version.
25 | Additional software components are added to a combined label `DominoContainer.addons` specifying all additional Domino software added.
26 |
27 | Example: ```"DominoContainer.addons": "ontime=11.1.1,languagepack=DE,verse=3.2.0,nomad=1.0.9-14.0,traveler=14.0,domrestapi=1.0.8,capi=14.0,leap=1.1.3"```
28 |
29 | The add-on software listed in this label is end to end validated by starting the application and querying the corresponding end points. For example for Traveler using the authenticated status query.
30 |
31 | # Example output with add-ons installed
32 |
33 | ```
34 | --------------------------------------------------------------------------------
35 | Test Results
36 | --------------------------------------------------------------------------------
37 |
38 | {
39 | "testResults": {
40 | "harness": "DominoCommunityImage",
41 | "suite": "Regression",
42 | "testClient": "testing.notes.lab",
43 | "testServer": "testing.notes.lab",
44 | "platform": "CentOS Stream 9",
45 | "platformVersion": "9 CentOS Stream",
46 | "hostVersion": "9 CentOS Stream",
47 | "hostPlatform": "CentOS Stream 9",
48 | "testBuild": "14.0",
49 | "containerPlatform": "docker",
50 | "containerPlatformVersion": "24.0.7",
51 | "kernelVersion": "5.14.0-390.el9.x86_64",
52 | "kernelBuildTime": "#1 SMP PREEMPT_DYNAMIC Fri Nov 24 10:44:56 UTC 2023",
53 | "glibcVersion": "2.34",
54 | "timezone": "Etc/UTC",
55 | "javaVersion": "17.0.8.1 2023-08-24",
56 | "dominoAddons": "ontime=11.1.1,languagepack=DE,verse=3.2.0,nomad=1.0.9-14.0,traveler=14.0,domrestapi=1.0.8,capi=14.0,leap=1.1.3",
57 | "testcase": [
58 | {
59 |
60 | ...
61 |
62 | [ SUCCESS ] addon.installed.ontime
63 | [ SUCCESS ] addon.installed.languagepack
64 | [ SUCCESS ] addon.installed.verse
65 | [ SUCCESS ] addon.installed.nomad
66 | [ SUCCESS ] addon.installed.traveler
67 | [ SUCCESS ] addon.installed.domrestapi
68 | [ SUCCESS ] addon.installed.capi
69 | [ SUCCESS ] addon.installed.leap
70 | [ SUCCESS ] domino.jvm.available
71 | [ SUCCESS ] domino.server.running
72 | [ SUCCESS ] domino.http.running
73 | [ SUCCESS ] domino.certificate.available
74 | [ SUCCESS ] domino.server.onetouch.microca-cert
75 | [ SUCCESS ] capi.compile&run
76 | [ SUCCESS ] traveler.server.available
77 | [ SUCCESS ] nomad.server.available
78 | [ SUCCESS ] verse.server.available
79 | [ SUCCESS ] restapi.server.available
80 | [ SUCCESS ] domino-leap.server.available
81 | [ SUCCESS ] domino-leap.server.version
82 | [ SUCCESS ] domino.server.onetouch.createdb
83 | [ SUCCESS ] domino.idvault.create
84 | [ SUCCESS ] domino.backup.create
85 | [ SUCCESS ] startscript.archivelog
86 | [ SUCCESS ] container.health
87 | [ SUCCESS ] startscript.server.restart
88 | [ SUCCESS ] domino.translog.create
89 |
90 | --------------------------------------------------------------------------------
91 |
92 | Success : 27
93 | Error : 0
94 | Total : 27
95 | ```
96 |
97 |
--------------------------------------------------------------------------------
/docs/_config.yml:
--------------------------------------------------------------------------------
1 |
2 | # Site settings
3 | theme: jekyll-theme-minimal
4 | remote_theme: pmarsceill/just-the-docs
5 | title: Domino for Docker Containers
6 | description: Scripts to build HCL Domino container images
7 | version: 1.0
8 | logo: "/assets/images/svg/Domino.svg"
9 | git_url: "https://github.com/HCL-TECH-SOFTWARE/domino-container"
10 | baseurl: "/domino-container"
11 | permalink: pretty
12 | exclude:
13 | [
14 | "*.gemspec",
15 | "*.gem",
16 | "Gemfile",
17 | "Gemfile.lock",
18 | "lib/",
19 | "bin/",
20 | "README.md",
21 | "Rakefile",
22 | ]
23 |
24 | # Set a path/url to a logo that will be displayed instead of the title
25 | #logo: "/assets/images/just-the-docs.png"
26 |
27 | # Enable or disable the site search
28 | # Supports true (default) or false
29 | search_enabled: true
30 | search:
31 | # Split pages into sections that can be searched individually
32 | # Supports 1 - 6, default: 2
33 | heading_level: 2
34 | # Maximum amount of previews per search result
35 | # Default: 3
36 | previews: 5
37 | # Maximum amount of words to display before a matched word in the preview
38 | # Default: 5
39 | preview_words_before: 10
40 | # Maximum amount of words to display after a matched word in the preview
41 | # Default: 10
42 | preview_words_after: 10
43 | # Set the search token separator
44 | # Default: /[\s\-/]+/
45 | # Example: enable support for hyphenated search words
46 | tokenizer_separator: /[\s/]+/
47 | # Display the relative url in search results
48 | # Supports true (default) or false
49 | rel_url: true
50 | # Enable or disable the search button that appears in the bottom right corner of every page
51 | # Supports true or false (default)
52 | button: false
53 |
54 | # Enable or disable heading anchors
55 | heading_anchors: true
56 |
57 | # Aux links for the upper right navigation
58 | aux_links:
59 | "View it on GitHub":
60 | - "https://github.com/HCL-TECH-SOFTWARE/domino-container"
61 |
62 |
63 | # Makes Aux links open in a new tab. Default is false
64 | aux_links_new_tab: true
65 |
66 | # Sort order for navigation links
67 | # nav_sort: case_insensitive # default, equivalent to nil
68 | nav_sort: case_insensitive # Capital letters sorted before lowercase
69 |
70 | # Footer content
71 | # appears at the bottom of every page's main content
72 |
73 | # Back to top link
74 | back_to_top: true
75 | back_to_top_text: "Back to top"
76 |
77 | next_page: true
78 |
79 | footer_content: "HCL Domino Container"
80 |
81 | # Footer last edited timestamp
82 | # last_edit_timestamp: true # show or hide edit time - page must have `last_modified_date` defined in the frontmatter
83 | # last_edit_time_format: "%b %e %Y at %I:%M %p" # uses ruby's time format: https://ruby-doc.org/stdlib-2.7.0/libdoc/time/rdoc/Time.html
84 |
85 | # Footer "Edit this page on GitHub" link text
86 | gh_edit_link: true # show or hide edit this page link
87 | gh_edit_link_text: "Edit this page on GitHub"
88 | # the github URL for your repo
89 | gh_edit_repository: "https://github.com/HCL-TECH-SOFTWARE/domino-container"
90 | gh_edit_branch: "master" # the branch that your docs is served from
91 | gh_edit_source: docs # the source that your files originate from
92 | gh_edit_view_mode: "tree" # "tree" or "edit" if you want the user to jump into the editor immediately
93 |
94 | # Color scheme currently only supports "dark", "light"/nil (default), or a custom scheme that you define
95 | color_scheme: nil
96 |
97 | # Google Analytics Tracking (optional)
98 | # e.g, UA-1234567-89
99 | #ga_tracking: UA-2709176-10
100 | ga_tracking_anonymize_ip: true # Use GDPR compliant Google Analytics settings (true/nil by default)
101 |
102 | plugins:
103 | - jekyll-seo-tag
104 |
105 | highlighter: rouge
106 |
107 | kramdown:
108 | input: GFM
109 | syntax_highlighter: rouge
110 | # syntax_highlighter_opts:
111 | # block:
112 | # line_numbers: true
113 | # compress_html:
114 | # clippings: all
115 | # comments: all
116 | # endings: all
117 | # startings: []
118 | # blanklines: false
119 | # profile: false
120 | # # ignore:
121 | # # envs: all
122 |
--------------------------------------------------------------------------------
/CODE_OF_CONDUCT.md:
--------------------------------------------------------------------------------
1 | ---
2 | layout: default
3 | title: Code of Conduct
4 | parent: Understanding Open Source Obligations
5 | grand_parent: Resources
6 | nav_order: 6
7 | ---
8 |
9 | # Contributor Covenant Code of Conduct
10 |
11 | Projects should foster a positive environment, to ensure active and pleasant participation for all. This is wording for a contributor covenant, amended from [Contributor Covenant 2.0](https://www.contributor-covenant.org/version/2/0/code_of_conduct/).
12 |
13 | ## Our Pledge
14 |
15 | We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
16 |
17 | We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
18 |
19 | ## Our Standards
20 |
21 | Examples of behavior that contributes to a positive environment for our community include:
22 |
23 | -> Demonstrating empathy and kindness toward other people
24 | - Being respectful of differing opinions, viewpoints, and experiences
25 | - Giving and gracefully accepting constructive feedback
26 | - Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
27 | - Focusing on what is best not just for us as individuals, but for the overall community
28 |
29 | Examples of unacceptable behavior include:
30 |
31 | - The use of sexualized language or imagery, and sexual attention or advances of any kind
32 | - Trolling, insulting or derogatory comments, and personal or political attacks
33 | - Public or private harassment
34 | - Publishing others’ private information, such as a physical or email address, without their explicit permission
35 | - Other conduct which could reasonably be considered inappropriate in a professional setting
36 |
37 | ## Enforcement Responsibilities
38 |
39 | Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
40 |
41 | Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
42 |
43 | ## Scope
44 |
45 | This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
46 |
47 | ## Enforcement
48 |
49 | Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the HCL Open Source Project Officer, who is responsible for enforcement, at [ospo.hclsoftware@hcl.com](mailto:ospo.hclsoftware@hcl.com). All complaints will be reviewed and investigated promptly and fairly. The HCL Open Source Project Office is obligated to respect the privacy and security of the reporter of any incident. Details of enforcement policies may be posted separately.
50 |
51 | Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by the HCL Open Source Project Office.
52 |
53 | ## Attribution
54 |
55 | This Code of Conduct is adapted from the Contributor Covenant, version 2.0, available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
56 |
57 | Community Impact Guidelines were inspired by Mozilla’s code of conduct enforcement ladder.
58 |
59 | For answers to common questions about this code of conduct, see the FAQ at https://www.contributor-covenant.org/faq.
60 |
--------------------------------------------------------------------------------
/docs/architecture_startup-cfg-flow.md:
--------------------------------------------------------------------------------
1 | ---
2 | layout: default
3 | title: "Startup & Config Flow"
4 | nav_order: 2
5 | description: "Startup and Configuration Flow"
6 | parent: "Architecture"
7 | has_children: false
8 | ---
9 |
10 | # Domino Docker Startup and Configuration Flow
11 |
12 | This document describes the general setup and update flow used.
13 | The main entry point is called by the container platform and will remain active while the server is running.
14 | It is controlling all setup and update operations if a new server is started or a server is running for the first time with a new/updated image.
15 | The following abstract is mainly intended for understanding the general flow. Please refer to other sections for details about environment variables in detail.
16 |
17 | ## /entrypoint.sh
18 |
19 | Main entry point to run the Domino server.
20 | The logic also takes care of server setup and updates the server without separate parameters specified.
21 | This logic is performed automatically based on the version variables in the container and the image.
22 |
23 | This project leverages the Nash!Com Domino on Linux/Unix start script, from which also the `entrypoint-sh` logic is derived.
24 | The start script is not only useful for start/stop operations, but also provides additional functionality like
25 | generating NSDs, managing logs, creating NSDs, accessing the remote console and many more.
26 | Refer to the Nash!Com start script [documentation](https://nashcom.github.io/domino-startscript/) for details.
27 |
28 | You can customize the start script configuration either by overwriting `/etc/sysconfig/rc_domino_config`
29 | or passing all not explicitly configured parameters via environment variables
30 | (all variables start with `DOMINO_`. Leveraging the start script offers admins the same functionality they already know from Domino on Linux and AIX.
31 |
32 | The following steps are performed by the entry-point script and helper scripts:
33 |
34 | - Setup environment (path, umask, user, etc.)
35 |
36 | - Check if we have a LOGONNAME else we need to patch `/etc/passwd` via `nuid2pw` (only required for K8s deployments with special user-id requirements)
37 |
38 | Note: Important if specifying a UID or running on a platform that needs a separate user per Pod and doesn't take care about it on it's own (K8s).
39 |
40 | - Run `/domino-container/scripts/domino_install_data_copy.sh` (setup & update data directory see below)
41 |
42 |
43 | - Check if server is configured (notes.ini `ServerSetup=` is empty)
44 |
45 | - if not configured run -> `/domino-container/scripts/domino_prestart.sh`
46 |
47 | - If still not configured start setup via listening mode
48 |
49 |
50 | - Start domino running the start script `rc_domino_script`
51 |
52 |
53 | ## domino_install_data_copy.sh
54 |
55 | This script is intended for first data directory deployment or update
56 |
57 | Checks if `/local/notesdata/notes.ini` already exists. if not executes the following logic:
58 |
59 | - Creates directories depending on how the container volumes are mounted
60 | (Directories are recreated if empty and not a mount point)
61 |
62 | - Extracts install `/domino-container/install_data_domino.taz` to `/local/notesdata`
63 | this is the first deployment for a new container.
64 |
65 |
66 | - Checks if version has been updated and copies new templates etc.
67 | - The check is performed via version files in the data directory and in the container to compare if "image file version = version in the data volume"
68 |
69 |
70 | ## domino_prestart.sh
71 |
72 | Automatic configuration in Domino 12 leverages OneTouch Setup.
73 | Earlier versions used a special PDS file automation configuration.
74 | Domino OneTouch Setup is the recommended way since Domino 12 to automatically setup a Domino server.
75 | Older servers will always run into the standard remote configuration mode via `server -listen 1352`.
76 |
77 | This script is used for additional operations before a OneTouch Setup is invoked.
78 |
79 | - If specified downloads and extracts `$CustomNotesdataZip` into `/local/notesdata`
80 |
81 | - Download files and get password variables
82 |
83 | - ( e.g. `server.id`, organization password, trial license file etc)
84 |
85 |
86 | ## Default configuration if no OneTouch Setup is specified
87 |
88 | If no configuration is found and no OneTouch Setup is specified the server will launch the remote setup listening on port 1352.
89 |
90 | The server will be automatically started with `server -listen 1352` as a fall-back.
91 |
--------------------------------------------------------------------------------
/dockerfiles/install_dir_common/healthcheck.sh:
--------------------------------------------------------------------------------
1 | #!/bin/bash
2 |
3 | ############################################################################
4 | # Copyright Nash!Com, Daniel Nashed 2019, 2025 - APACHE 2.0 see LICENSE
5 | ############################################################################
6 | #
7 | # This script defines the health check script
8 | # The "ready" option can be used for a readiness check
9 | #
10 | # The following checks can be configured
11 | #
12 | # 1. Check health check status file if present
13 | # File checked: /tmp/domino_check.txt
14 | #
15 | # 2. Check if port is responding when configured
16 | # Defined in: /local/notesdata/health_port.cfg
17 | #
18 | # 3. Fallback if nothing else is configured
19 | # Check if server process is running
20 | #
21 | # Takes into account service status
22 | #
23 | ############################################################################
24 |
25 |
26 | log()
27 | {
28 | if [ -n "$HEALTH_CHECK_LOG" ]; then
29 | echo "$@" >> "$HEALTH_CHECK_LOG"
30 | fi
31 | }
32 |
33 |
34 | # Health check defines
35 | DOMINO_PID=/tmp/domino.pid
36 | DOMINO_REQEST_FILE=/tmp/domino_request
37 | DOMINO_STATUS_FILE=/tmp/domino_status
38 |
39 | HEALTH_CHECK_PORT_FILE=/local/notesdata/health_port.cfg
40 | HEALTH_CHECK_FILE=/tmp/domino_check.txt
41 | HEALTHY_STRING="OK"
42 |
43 | LOTUS=/opt/hcl/domino
44 |
45 | # We support "ready" checks and by default health checks
46 | if [ "$1" = "ready" ]; then
47 | CHECK_READY=1
48 | fi
49 |
50 |
51 | return_ready()
52 | {
53 | if [ -z "$CHECK_READY" ]; then
54 | return 0
55 | fi
56 |
57 | log "result: $1"
58 | exit $1
59 | }
60 |
61 |
62 | return_health()
63 | {
64 | log "result: $1"
65 | exit $1
66 | }
67 |
68 |
69 | # -- Main logic --
70 |
71 | log ""
72 | log "[$(date -Iseconds)]"
73 |
74 |
75 | # If server is shutdown, report server is running but not ready
76 |
77 | if [ ! -e "$DOMINO_PID" ]; then
78 | log "Server is shutdown"
79 | return_ready 1
80 | return_health 0
81 | fi
82 |
83 | if [ -e "$DOMINO_STATUS_FILE" ]; then
84 | DOMINO_STATUS=$(cat "$DOMINO_STATUS_FILE")
85 | log "Domino status file: [$DOMINO_STATUS_FILE] -> [$DOMINO_STATUS]"
86 | else
87 | DOMINO_STATUS=
88 | fi
89 |
90 |
91 | if [ "$DOMINO_STATUS" = "0" ]; then
92 | return_ready 1
93 | return_health 0
94 | fi
95 |
96 | if [ "$DOMINO_STATUS" = "c" ]; then
97 | return_ready 1
98 | return_health 0
99 | fi
100 |
101 |
102 | # Domino shutdown requested? -> healthy but not ready
103 |
104 | if [ -e "$DOMINO_REQUEST_FILE" ]; then
105 | DOMINO_REQUEST=$(cat $DOMINO_REQUEST_FILE)
106 | log "Request file [$DOMINO_REQUEST_FILE] -> [$DOMINO_REQUEST]"
107 | else
108 | DOMINO_REQUEST=
109 | fi
110 |
111 | if [ "$DOMINO_REQUEST" = "0" ]; then
112 | return_ready 1
113 | return_health 0
114 | fi
115 |
116 |
117 | # 1. Check a health check file
118 |
119 | if [ -n "$HEALTH_CHECK_FILE" ] && [ -e "$HEALTH_CHECK_FILE" ]; then
120 |
121 | if [ -z "$HEALTHY_STRING" ]; then
122 | $HEALTHY_STRING="OK"
123 | fi
124 |
125 | FOUND=$(grep -e "$HEALTHY_STRING" "$HEALTH_CHECK_FILE" | wc -l)
126 |
127 | log "Checking [$HEALTH_CHECK_FILE] for [$HEALTHY_STRING] -> [$FOUND]"
128 |
129 | if [ "$FOUND" = "0" ]; then
130 | return_ready 1
131 | return_health 1
132 | fi
133 |
134 | return_ready 0
135 | return_health 0
136 | fi
137 |
138 |
139 | # 2. Check if configured port is responding (health check can be configured in a file or env variable)
140 |
141 | if [ -n "$HEALTH_CHECK_PORT_FILE" ]; then
142 | if [ -e "$HEALTH_CHECK_PORT_FILE" ]; then
143 | HEALTH_CHECK_PORT=$(cat $HEALTH_CHECK_PORT_FILE)
144 | fi
145 | fi
146 |
147 | if [ -n "$HEALTH_CHECK_PORT" ]; then
148 |
149 | log "Checking ports: [$HEALTH_CHECK_PORT]"
150 |
151 | for port in $HEALTH_CHECK_PORT; do
152 |
153 | timeout 10 bash -c " /dev/null
154 | if [ "$?" != "0" ]; then
155 | log "Port [$port] is down"
156 | return_ready 1
157 | return_health 1
158 | fi
159 |
160 | done
161 |
162 | return_ready 0
163 | return_health 0
164 |
165 | fi
166 |
167 |
168 | # 3. Fallback option: Check if server process is running
169 |
170 | DOMINO_RUNNING=$(ps -ef | grep "$LOTUS/notes" | grep "server" | grep -v " -jc")
171 |
172 | log "Domino Server process line: $DOMINO_RUNNING"
173 |
174 | if [ -z "$DOMINO_RUNNING" ]; then
175 | return_ready 1
176 | return_health 1
177 | else
178 | return_ready 0
179 | return_health 0
180 | fi
181 |
182 | exit 0
183 |
184 |
--------------------------------------------------------------------------------
/dockerfiles/install_dir_safelinx/healthcheck.sh:
--------------------------------------------------------------------------------
1 | #!/bin/bash
2 |
3 | ############################################################################
4 | # Copyright Nash!Com, Daniel Nashed 2019, 2025 - APACHE 2.0 see LICENSE
5 | ############################################################################
6 | #
7 | # This script defines the health check script
8 | # The "ready" option can be used for a readiness check
9 | #
10 | # The following checks can be configured
11 | #
12 | # 1. Check health check status file if present
13 | # File checked: /tmp/domino_check.txt
14 | #
15 | # 2. Check if port is responding when configured
16 | # Defined in: /local/notesdata/health_port.cfg
17 | #
18 | # 3. Fallback if nothing else is configured
19 | # Check if server process is running
20 | #
21 | # Takes into account service status
22 | #
23 | ############################################################################
24 |
25 |
26 | log()
27 | {
28 | if [ -n "$HEALTH_CHECK_LOG" ]; then
29 | echo "$@" >> "$HEALTH_CHECK_LOG"
30 | fi
31 | }
32 |
33 |
34 | # Health check defines
35 | DOMINO_PID=/tmp/domino.pid
36 | DOMINO_REQEST_FILE=/tmp/domino_request
37 | DOMINO_STATUS_FILE=/tmp/domino_status
38 |
39 | HEALTH_CHECK_PORT_FILE=/local/notesdata/health_port.cfg
40 | HEALTH_CHECK_FILE=/tmp/domino_check.txt
41 | HEALTHY_STRING="OK"
42 |
43 | LOTUS=/opt/hcl/domino
44 |
45 | # We support "ready" checks and by default health checks
46 | if [ "$1" = "ready" ]; then
47 | CHECK_READY=1
48 | fi
49 |
50 |
51 | return_ready()
52 | {
53 | if [ -z "$CHECK_READY" ]; then
54 | return 0
55 | fi
56 |
57 | log "result: $1"
58 | exit $1
59 | }
60 |
61 |
62 | return_health()
63 | {
64 | log "result: $1"
65 | exit $1
66 | }
67 |
68 |
69 | # -- Main logic --
70 |
71 | log ""
72 | log "[$(date -Iseconds)]"
73 |
74 |
75 | # If server is shutdown, report server is running but not ready
76 |
77 | if [ ! -e "$DOMINO_PID" ]; then
78 | log "Server is shutdown"
79 | return_ready 1
80 | return_health 0
81 | fi
82 |
83 | if [ -e "$DOMINO_STATUS_FILE" ]; then
84 | DOMINO_STATUS=$(cat "$DOMINO_STATUS_FILE")
85 | log "Domino status file: [$DOMINO_STATUS_FILE] -> [$DOMINO_STATUS]"
86 | else
87 | DOMINO_STATUS=
88 | fi
89 |
90 |
91 | if [ "$DOMINO_STATUS" = "0" ]; then
92 | return_ready 1
93 | return_health 0
94 | fi
95 |
96 | if [ "$DOMINO_STATUS" = "c" ]; then
97 | return_ready 1
98 | return_health 0
99 | fi
100 |
101 |
102 | # Domino shutdown requested? -> healthy but not ready
103 |
104 | if [ -e "$DOMINO_REQUEST_FILE" ]; then
105 | DOMINO_REQUEST=$(cat $DOMINO_REQUEST_FILE)
106 | log "Request file [$DOMINO_REQUEST_FILE] -> [$DOMINO_REQUEST]"
107 | else
108 | DOMINO_REQUEST=
109 | fi
110 |
111 | if [ "$DOMINO_REQUEST" = "0" ]; then
112 | return_ready 1
113 | return_health 0
114 | fi
115 |
116 |
117 | # 1. Check a health check file
118 |
119 | if [ -n "$HEALTH_CHECK_FILE" ] && [ -e "$HEALTH_CHECK_FILE" ]; then
120 |
121 | if [ -z "$HEALTHY_STRING" ]; then
122 | $HEALTHY_STRING="OK"
123 | fi
124 |
125 | FOUND=$(grep -e "$HEALTHY_STRING" "$HEALTH_CHECK_FILE" | wc -l)
126 |
127 | log "Checking [$HEALTH_CHECK_FILE] for [$HEALTHY_STRING] -> [$FOUND]"
128 |
129 | if [ "$FOUND" = "0" ]; then
130 | return_ready 1
131 | return_health 1
132 | fi
133 |
134 | return_ready 0
135 | return_health 0
136 | fi
137 |
138 |
139 | # 2. Check if configured port is responding (health check can be configured in a file or env variable)
140 |
141 | if [ -n "$HEALTH_CHECK_PORT_FILE" ]; then
142 | if [ -e "$HEALTH_CHECK_PORT_FILE" ]; then
143 | HEALTH_CHECK_PORT=$(cat $HEALTH_CHECK_PORT_FILE)
144 | fi
145 | fi
146 |
147 | if [ -n "$HEALTH_CHECK_PORT" ]; then
148 |
149 | log "Checking ports: [$HEALTH_CHECK_PORT]"
150 |
151 | for port in $HEALTH_CHECK_PORT; do
152 |
153 | timeout 10 bash -c " /dev/null
154 | if [ "$?" != "0" ]; then
155 | log "Port [$port] is down"
156 | return_ready 1
157 | return_health 1
158 | fi
159 |
160 | done
161 |
162 | return_ready 0
163 | return_health 0
164 |
165 | fi
166 |
167 |
168 | # 3. Fallback option: Check if server process is running
169 |
170 | DOMINO_RUNNING=$(ps -ef | grep "$LOTUS/notes" | grep "server" | grep -v " -jc")
171 |
172 | log "Domino Server process line: $DOMINO_RUNNING"
173 |
174 | if [ -z "$DOMINO_RUNNING" ]; then
175 | return_ready 1
176 | return_health 1
177 | else
178 | return_ready 0
179 | return_health 0
180 | fi
181 |
182 | exit 0
183 |
184 |
--------------------------------------------------------------------------------
/docs/howto_docker-wsl.md:
--------------------------------------------------------------------------------
1 | ---
2 | layout: default
3 | title: "Docker on WSL2"
4 | nav_order: 5
5 | description: "Docker on WSL2"
6 | parent: "Howto"
7 | has_children: false
8 | ---
9 |
10 | # Introduction
11 |
12 | Microsoft offers [WSL2](https://docs.microsoft.com/en-us/windows/wsl/) a very interesting Linux integration platform,
13 | which is very convenient and flexible for local build and run-time environments.
14 | It can be used as build and run-time environment for Domino on Docker.
15 |
16 | The most flexible setup is to run one of the standard Linux distributions and install a Docker Linux host on the WSL2 instance.
17 | WSL2 is also used in current Docker Desktop installations. Important for a build environment is any Docker or Podman installation with Bash support.
18 |
19 | # Requirements
20 |
21 | Ensure you run at least
22 |
23 | - Windows 10 version 2004 or higher
24 | - Windows 11
25 | - Windows 2022
26 | - Windows 2025
27 |
28 | # Install WSL2
29 |
30 | Today WSL2 should be the default for each new installation.
31 | In case you are running the older WSL version, you have to switch to WSL2.
32 | Refer to details in the reference link below.
33 |
34 | ```
35 | wsl --install
36 | ```
37 |
38 | # Install Linux Distribution
39 |
40 | Once WSL2 is installed, WSL can list all available Linux distributions.
41 |
42 |
43 | ## List available images
44 |
45 | ```
46 | wsl --list --online
47 | ```
48 |
49 |
50 | ## Example installing Ubuntu
51 |
52 | The default distribution is Ubuntu. Make sure you select a LTS version to ensure long term support.
53 |
54 | ```
55 | wsl --install -d Ubuntu-24.04
56 | ```
57 |
58 | Once Ubuntu is installed, it can be launched in multiple ways:
59 |
60 | - Desktop/taskbar icon
61 | - `wsl` command line
62 | - Software like [MobaXterm](https://mobaxterm.mobatek.net/) with WSL integration
63 |
64 |
65 | ## Create a new user
66 |
67 | When the container is launched for the first time, it asks to create a new user.
68 | For a Domino on Docker environment the best first user is `notes`.
69 |
70 | On Ubuntu the `root` user can be switched to via `sudo su -` specifying your `notes` user password.
71 |
72 | ```
73 | sudo su -
74 | ```
75 |
76 | ## Update Ubuntu
77 |
78 | The installed WSL Linux instance is not up to date after installation.
79 |
80 | ```
81 | apt update
82 | apt upgrade
83 | ```
84 |
85 |
86 | ## Install Docker Server
87 |
88 | Ubuntu does not provide the latest Docker versions.
89 |
90 | It is recommended to use the official Docker documentation to ensure to get a recent version.
91 | Follow the steps for [Install Docker Engine](https://docs.docker.com/engine/install/).
92 |
93 | An alternate way to install is to use the Docker convenience script provided by Docker.
94 | It can be automatically downloaded and executed.
95 |
96 | ```
97 | curl -fsSL https://get.docker.com | bash -
98 | ```
99 |
100 | The latest Ubuntu WSL images support systemd. Earlier versions did not support systemd and required work-arounds to start the Docker daemon.
101 | In current Ubuntu versions The Docker server is installed as a systemd services automatically.
102 |
103 |
104 | ## Install JQ
105 |
106 | JQ is the standard tool for working with JSON files.
107 | The domino_container scripts leverage JQ, which is included in all major distributions including Ubuntu.
108 |
109 | ```
110 | apt install jq
111 | ```
112 |
113 |
114 | ## Clone Docker Container Project
115 |
116 | ```
117 | mkdir -p /local/github
118 | cd /local/github
119 | git clone https://github.com/HCL-TECH-SOFTWARE/domino-container.git
120 | ```
121 |
122 | ## Clone Start Script project & Install Nash!Com Domino Container Control Script
123 |
124 | **dominoctl** provides an easy way to configure, run and manage Domino containers.
125 | Check [Domino container control (dominoctl)](https://nashcom.github.io/domino-startscript/dominoctl/) documentation for details.
126 |
127 |
128 | To clone the GitHub project invoke the following command:
129 |
130 | ```
131 | cd /local/github
132 | git clone https://github.com/nashcom/domino-startscript.git
133 | ```
134 |
135 | To install or update dominoctl run the following command
136 |
137 | ```
138 | /local/github/domino-startscript/install_dominoctl
139 | ```
140 |
141 |
142 | ## Check the Docker Client and Server Version
143 |
144 | ```
145 | docker version
146 | ```
147 |
148 |
149 | ## Next Steps
150 |
151 | This completes the setup for your Docker environment.
152 |
153 | Contine with [Quickstart](quickstart.md) to build and run your first container.
154 |
155 |
156 | ## Reference
157 |
158 | [Microsoft WSL2 install documentation](https://docs.microsoft.com/en-us/windows/wsl/install).
159 |
160 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # Domino Docker Containers
2 |
3 | [](https://www.hcl-software.com/domino)
5 | [](https://github.com/nashcom/buil-test/blob/main/LICENSE)
6 |
7 |
8 | This project contains build scripts for HCL Domino Docker/Container images via [dockerfiles](https://docs.docker.com/engine/reference/builder/).
9 | The repository provides the utilities to build HCL Domino Server with the latest software or specific version in a Docker/Container image.
10 | There are separate folders within this repository for Domino add-on HCL products like Traveler and HCL Domino Leap as well.
11 |
12 | ## You are looking to (just) configure & control Domino container instances - not to build containers?
13 |
14 | You are in luck, just at the wrong place. Head over to [Nash!Com's Domino start script](https://github.com/nashcom/domino-startscript) and follow the instructions there. There is no need to use this repository.
15 |
16 | ## Where to get HCL Domino software
17 |
18 | The project uses the official HCL web-kit installers to build container images download from the new official [My HCLSoftware Portal](https://my.hcltechsw.com/).
19 |
20 | - All HCL customers with active maintenance should have a download account
21 | - The [Partner Pack](https://www.hcltechsw.com/resources/partner-connect/resources/partner-pack) provides the same access for HCL Business Partners
22 |
23 | See how to [download software](docs/howto_download-software.md) for details.
24 |
25 | ## Supported environments
26 |
27 | The project is supported on Docker Desktop, Docker Server, Podman, Rancher Desktop, Kubernetes (K8s) and OpenShift.
28 | See detailed information about [supported run-time and build environments](docs/concept_environments.md).
29 |
30 | ## Documentation & Quickstart
31 |
32 | See the [documentation](docs/index.md) and the [Quickstart](docs/quickstart.md) for details
33 |
34 | ## Issues
35 | For issues relating specifically to the Dockerfiles and scripts, please use the [GitHub issue tracker](https://github.com/HCL-TECH-SOFTWARE/domino-container/issues)
36 |
37 | ## Contributing
38 | We welcome contributions following [our guidelines](CONTRIBUTING.md).
39 |
40 | ## Community Support
41 | Special Thanks go to the following people for having provided valuable input to this project
42 |
43 | * [Ulrich Krause](https://www.eknori.de/2017-08-20/domino-on-docker/) for his very early contibutions in this space.
44 | * Matteo Bisi for his [Presentation](https://www.slideshare.net/mbisi/connect2016-1172-shipping-domino).
45 | * [Egor Margineanu](https://www.egmar.ro/) who also can be found on [Github](https://github.com/egmar)
46 | * Thomas Hampel for initiating the original IBM Domino 9.0.1 Docker project
47 | * Daniel Nashed for donating his [startscript](https://github.com/nashcom/domino-startscript) under the [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0.html).
48 |
49 | ## License
50 | The Dockerfiles and associated scripts are licensed under the [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0.html).
51 |
52 | HCL Domino and add-on products are commercial software - The software licenses agreement does not permit further distribution of the docker image that was built using this script!
53 | Refer to the [HCL license home page](https://www.hcl-software.com/resources/license-agreements) for detailed information about the HCL Domino and add-on product license terms.
54 |
55 |
--------------------------------------------------------------------------------
/docs/index.md:
--------------------------------------------------------------------------------
1 | ---
2 | layout: default
3 | title: "Concept & Overview"
4 | nav_order: 2
5 | description: "HCL Domino Container"
6 | has_children: true
7 | ---
8 |
9 | [Quickstart](quickstart.md){: .btn }
10 | [View it on GitHub](https://github.com/HCL-TECH-SOFTWARE/domino-container){: .btn }
11 |
12 | ---
13 |
14 | # Domino Container
15 |
16 | This project contains build scripts for HCL Domino Docker/Container images via [dockerfiles](https://docs.docker.com/engine/reference/builder/).
17 | The repository provides the utilities to build HCL Domino Server with the latest software or specific version in a Docker/Container image.
18 | Additional software ( like HCL Traveler, Verse, Nomad Server) can be added as build options to a Domino container image.
19 |
20 | All required HCL web-kits and fixes are downloaded from a software repository server instead of adding the source installation files to the image directly.
21 | If no remote server is referenced a temporary local [NGINX container](https://hub.docker.com/_/nginx) is started at build time to act as a **software repository server**.
22 |
23 | ## Supported environments
24 |
25 | The project is supported on Docker Desktop, Docker Server, Podman, Rancher Desktop, Kubernetes (K8s) and OpenShift.
26 | See detailed information about [supported run-time and build environments](concept_environments.md)
27 |
28 | ## Where to get HCL Domino software
29 |
30 | The project uses the official HCL web-kit installers to build container images from [My HCLSoftware Portal](https://my.hcltechsw.com/).
31 |
32 | - All HCL customers with active maintenance should have a download account
33 | - The [Partner Pack](https://www.hcltechsw.com/resources/partner-connect/resources/partner-pack) provides the same access for HCL Business Partners
34 |
35 | See how to [download software](howto_download-software.md) for details.
36 |
37 | ## How to download this project
38 |
39 | The recommended method is to clone the download the GitHub project directly via git.
40 | An alternate way is to download the project via as a tar file from the repository page.
41 |
42 | See Howto [Get Domino Container GitHub Repo](howto_github.md) for details.
43 |
44 | ## Building the image(s)
45 |
46 | To build the latest available image
47 |
48 | 1. Download the required software packages to the 'software' directory
49 | 2. From the root folder of this repository issue the following command
50 |
51 | ```bash
52 | ./build.sh domino
53 | ```
54 |
55 | The process will perform all required actions to create the image in the version requested. Usually it takes ~5 to ~8 minutes to build the image (depending on your CPU & disk performance).
56 |
57 |
58 | ## Building an image with additional add-ons
59 |
60 | The community image offers building an image with additional add-on, which can be simply added to the build step. In previous versions HCL Traveler and Domino Leap have been implemented as add-on images on top of the Domino image in a layered approach.
61 | All add-on software can be directly added in a single build step.
62 |
63 | ```
64 | -verse
65 | -nomad
66 | -traveler
67 | -ontime
68 | -leap
69 | -capi
70 | ```
71 |
72 | By default the latest version is selected. But different versions can be optionally specified for each component. Example: `-verse=3.1``
73 |
74 |
75 | ## New build menu
76 |
77 | The project now offers a simple to use build menu, which offers the most common build options.
78 | Invoking `build.sh` without any parameter opens the build menu.
79 |
80 | The build menu can be also invoked via `menu` specifying additional options.
81 |
82 | The versions of the add-ons are automatically selected from current software list.
83 | Just select all desired components and start the build process via pressing a `b`.
84 |
85 |
86 | ```
87 | HCL Domino Container Community Image
88 | ------------------------------------
89 |
90 | (D) HCL Domino [X] 14.5
91 | (O) OnTime [ ]
92 | (V) Verse [X] 3.2.5
93 | (T) Traveler [X] 14.5
94 | (N) Nomad Server [X] 1.0.16
95 | (L) Language Pack [ ]
96 | (R) REST-API [X] 1.1.4
97 | (A) C-API SDK [ ]
98 | (P) Domino Leap [ ]
99 | (J) Domino IQ [ ]
100 |
101 | (M) Prometheus [X] domprom 0.9.2 & Node Exporter 1.9.1
102 | (G) Borg Backup [X] 1.2.8
103 | (X) nshmailx [X] 1.1.0
104 |
105 | (I) Test created image [ ]
106 |
107 | (W) Write selection
108 | (E) Edit selection
109 | (C) Configuration
110 | (H) Help
111 |
112 |
113 | Base Image : RedHat UBI 10
114 |
115 | Select software & Options, [B] to build, [Q] to cancel?
116 |
117 | ```
118 |
119 | Refer to Howto [Run Domino Container GitHub Repo](run_docker.md) how to run a Domino Container on Docker.
120 |
--------------------------------------------------------------------------------
/docs/architecture_components.md:
--------------------------------------------------------------------------------
1 | ---
2 | layout: default
3 | title: "Components"
4 | nav_order: 1
5 | description: "Components involved"
6 | parent: "Architecture"
7 | has_children: false
8 | ---
9 |
10 | # Domino Container Components
11 |
12 | ## build.sh
13 |
14 | Main start point for building docker images.
15 | You can specify the image to build including additional build options and add-on software.
16 |
17 |
18 | ```
19 | ./build.sh domino
20 | ```
21 |
22 | Refer to the command line documentation invoking the script with -h to get the full list of options.
23 | Invoking the build script without parameters brings up a new menu to select which add-ons to install.
24 |
25 |
26 | The file `software.txt` contains an up to date list of current HCL Domino related software.
27 | Unless you specify a distinct version the current version will be installed and tagged as "latest".
28 |
29 | Inside this script you can configure a remote download HTTP(S) target if you are hosting the downloaded software on a different machine.
30 | You can also specify a download directory on your Docker host which will be served by a temporary Docker container running a [NGINX container](https://hub.docker.com/_/nginx) to provide the software.
31 |
32 | The following three options are available
33 | 1. Remote Download specified with example: `DOWNLOAD_FROM=http://192.168.1.1`
34 | 2. Local directory specified with example: `SOFTWARE_DIR=/local/software` hosted via NGINX container
35 | 3. Standard location in the software sub-directory hosted via NGINX server in temporary container
36 |
37 | Before you start you have to download the required software packages.
38 |
39 | ## Directory "software"
40 |
41 | This directory is the default directory to provide Domino software, which are downloaded by the Docker installation script.
42 | The build script checks if your selected software is available on the defined software location and will prompt you which package to download if missing.
43 |
44 | ## software.txt
45 |
46 | This file contains information about the download you have to download depending on what you install.
47 | This file is used to find the right file to download by product and version. And is also used to verify the downloaded image via SHA256 hash.
48 |
49 | The format of the file is as follows:
50 |
51 |
52 | ```
53 | product|version|filename|product-code|sha256-hash
54 | ```
55 |
56 |
57 | Example:
58 | ```
59 | domino|12.0.1|Domino_12.0.1_Linux_English.tar|-|a9d561b05f7b6850ed1230efa68ea1931cfdbb44685aad159613c29fa15e5eea
60 | ```
61 |
62 | ## current_version.txt
63 |
64 | Contains one line per product to define the latest software verison
65 |
66 |
67 | ## Directory "dockerfiles"
68 |
69 | Contains a sub-directory for each product that can be installed.
70 | - `install_dir_domino` contains all files needed to install a HCL Domino server.
71 | - `install_dir_common` contains common components used by other container images like Traveler.
72 |
73 | Those files are copied to /tmp/install_dir during install process and are invoked by the build process.
74 |
75 | # dockerfile
76 |
77 | Main `dockerfile` used to build Domino. All customization and logic is either in the build.sh script or in the installer script.
78 | Each add-on product has it's own file. Example: `dockerfile_traveler`.
79 |
80 | # install_domino.sh
81 |
82 | Contains the install logic and performs the actual install of all components after downloading the software.
83 |
84 |
85 | ## entrypoint.sh
86 |
87 | - Located in `/` owned by root
88 | - Main entry point started when the container is started
89 | - Contains the logic to start and stop the server.
90 | - Contains the logic triggered at first server start to invoke the configuration of the server.
91 |
92 | ## domino_prestart.sh
93 |
94 | - Located in `/domino-container/scripts` owned by root
95 | - Invoked by `entrypoint.sh script` to check which additional configuration is needed before the server is started for the first time
96 |
97 | ## domino_install_data_copy.sh
98 |
99 | - Located in `/domino-container/scripts` owned by root
100 | - Invoked by `entrypoint.sh script` to check if templates and other files have been updated by an image update
101 |
102 | ## healthcheck.sh
103 |
104 | - Located in / owned by root
105 | - Used to check the server health to update the status of the running container
106 | - Current implementation just checks if the server process is running ( for Traveler if the traveler process is running)
107 | - Can be customized for individual requirements. But usually server availability can be checked outside the server.
108 |
109 | ## domino-startscript.taz
110 |
111 | Nash!Com Domino start and management script which supports Docker and contains an installation routine which is Docker aware
112 |
113 |
114 | ## Digram of all directories and components
115 |
116 | 
117 |
--------------------------------------------------------------------------------
/dockerfiles/install_dir_domino/domsetup/domsetup-webroot/domino-ots-setup.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 | 34 |
35 |
36 | 37 |
38 |
Domino First / Additional Server Setup
39 |40 | 41 | 42 |
Drag & drop JSON file or click to select
43 | 44 |
Upload a Domino server OTS JSON configuration file.
45 |Or perform a form based first server Domino setup.
46 |47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | First server setup 55 | 56 | Upload Server.ID 57 | 58 |
59 |
60 | 61 |
62 | 63 | 140 | 141 | 142 | 143 | -------------------------------------------------------------------------------- /docs/assets/images/svg/Domino.svg: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /dockerfiles/install_dir_domino/domsetup/domsetup-webroot/assets/domsetup-logo.svg: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /docs/quickstart.md: -------------------------------------------------------------------------------- 1 | --- 2 | layout: default 3 | title: "Quickstart" 4 | nav_order: 1 5 | description: "HCL Domino Quickstart" 6 | has_children: false 7 | --- 8 | 9 | ## Ensure you have a supported build environment 10 | 11 | The project supports most Linux base environments including [Windows Subsystem for Linux 2 (WSL2)](https://docs.microsoft.com/en-us/windows/wsl/) 12 | 13 | For details check [supported run-time and build environments](concept_environments.md) 14 | 15 | ## Install container environment 16 | 17 | In case you never worked with container on your machine, make sure Docker or Podman is installed. 18 | This project works with Docker and Podman, still our recommendation would be to use Docker, because it takes care about starting containers without creating a separate service per container. 19 | In addition Docker Compose and other functionality works better on Docker. 20 | 21 | For details about installing Docker see howto [Docker on Linux](howto_docker-linux.md) 22 | 23 | If you have no container environment there is a easy to use convenience script to install Docker and perform the following scripts automatically. 24 | 25 | See the [Domino Start Script GitHub page](https://nashcom.github.io/domino-startscript/install_container_env/) for details. 26 | 27 | 28 | ## Clone this project via Git 29 | 30 | ### Install Git software 31 | 32 | Git is a very simple and convenient way to download from GitHub. 33 | The install command depends on the platform (SUSE: zypper, Ubuntu: apt). 34 | "yum" works for any Redhat/CentOS based distribution. 35 | 36 | ``` 37 | yum install git -y 38 | ``` 39 | 40 | On Ubuntu/Debian use 41 | 42 | ``` 43 | apt install git -y 44 | ``` 45 | 46 | ### Create new main directory for the project 47 | 48 | Create a directory where to download Git projects and switch to it. 49 | 50 | Example: 51 | 52 | ``` 53 | mkdir -p /local/github 54 | cd /local/github 55 | ``` 56 | 57 | ### Clone the repository and switch to the directory 58 | 59 | ``` 60 | git clone https://github.com/HCL-TECH-SOFTWARE/domino-container.git 61 | cd domino-container 62 | ``` 63 | 64 | ## Download software from My HCLSoftware Portal 65 | 66 | Before starting the build process, the required HCL web-kits have to be available on the build machine or a remote download location - if configured. 67 | 68 | See howto [download software](howto_download-software.md) for details downloading software from [My HCLSoftware Portal](https://my.hcltechsw.com/). 69 | 70 | ## Build the image 71 | 72 | ``` 73 | ./build domino 74 | ``` 75 | 76 | ## Run container Domino Container Script 77 | 78 | The Nash!Com Domino container script allows you to operate your server. It supports Docker and Podman run-time environments. 79 | 80 | ### Install Domino Container script 81 | 82 | Clone the [start script repository](https://github.com/nashcom/domino-startscript) 83 | 84 | ``` 85 | cd .. 86 | git clone https://github.com/nashcom/domino-startscript.git 87 | cd domino-startscript 88 | ./install_dominoctl 89 | ``` 90 | 91 | ### Configure your container 92 | 93 | The project provides a default configuration. 94 | Usually the default configuration should work for your environment. 95 | You might want to change the container name and other detailed settings. 96 | 97 | 98 | ``` 99 | dominoctl cfg 100 | ``` 101 | 102 | **Note:** The container script by default uses `vi` for editing. 103 | If you prefer a different editor like `nano` or `mcedit` export an environment variable specifying an installed editor of your choice. 104 | Tip: You can also add the variable to your bash profile. 105 | 106 | ``` 107 | export EDIT_COMMAND=nano 108 | ``` 109 | 110 | ### Configure container setup 111 | 112 | Usually environment variables are used for setup. 113 | The following commands opens the environment file, configured for your container. 114 | 115 | ``` 116 | dominoctl env 117 | ``` 118 | 119 | ## Start Domino container 120 | 121 | After specifying the configuration and setup correctly, start the container with the Domino container script. 122 | 123 | ``` 124 | dominoctl start 125 | ``` 126 | 127 | ### Domino live console 128 | 129 | To start a Domino live console, run the console command. 130 | The dominoctl script leverages and `exec` command into the container. 131 | The long version of this command would be `dominoctl domino console`. 132 | 133 | All console commands can be executed via `domino`. 134 | This command passes command line parameters to the `domino` start script. 135 | 136 | ``` 137 | dominoctl console 138 | 139 | ``` 140 | 141 | ## Export container image for external use 142 | 143 | To use the container image on run-time only platforms like a QNAP NAS Docker and Podman can export images to a tar file, which can be imported into any container registry. 144 | 145 | See howto [Export or push image to registries](howto_use_externally.md) for details. 146 | 147 | For running on QNAP and similar environments check [How to run Domino on a QNAP NAS](howto_qnap.md). 148 | 149 | 150 | ## Domino Container Script Diagram 151 | 152 |  153 | -------------------------------------------------------------------------------- /testing/README.md: -------------------------------------------------------------------------------- 1 | # Domino Community Container Image Automation Testing 2 | 3 | The automation test script is intended to test any image build with the Domino container community project. 4 | The main purpose is to ensure quality of the project. The automation test is intended to be run before any submission into the develop branch. 5 | 6 | By default the automation test uses the standard image name **hclcom/domino:latest**. 7 | Using the **-image=my-image** option any community image can be tested. 8 | 9 | The test script requires an image containing the Domino start script. Therefore other images cannot be tested. 10 | 11 | ## Running the automation test script 12 | 13 | ``` 14 | cd testing 15 | ./AutomationTest.sh 16 | ``` 17 | 18 | ## How it works 19 | 20 | - The script brings up a new Domino container **domino-autotesting** with the specified or default image. 21 | - The pre-defined One Touch Setup JSON file **DominoContainerAutoConfig.json** is copied into the started container to configure the Domino server 22 | - Once the server is started, container commands are exectured into the running container 23 | - The data directory is defined as a native volume, where the script can interact with `IBM_TECHNICAL_SUPPORT/console.log` to check for console output. 24 | - Test results are written into a JSON and CSV file in parallel 25 | - After container shutdown the JSON and CSV file information are displayed on the console 26 | 27 | 28 | ## Domino One Touch Setup 29 | 30 | The following main configuration options are currently used to bring up the server 31 | 32 | - Create a first server with standard server tasks + POP3 33 | - Set standard notes.ini best practices 34 | - Create ID vault via One Touch Setup 35 | - CertMgr TLS setup with a MicroCA used to create a server certificate with ECDSA NIST-P 384 36 | - Enable circular transaction log 37 | - Configure basic TLS settings in server document and enable internet sites 38 | - Create a configuration document with a best practices configuration 39 | - Create internet sites for HTTP, LDAP, IMAP, POP3 with TLS enabled 40 | - Create Global Domain document 41 | - Create **domcfg.nsf** 42 | - Create and configure **iwaredir.nsf** 43 | - Configure Traveler if the image has Traveler support 44 | 45 | 46 | ## Additional AutomationTest.sh options 47 | 48 | - `logs` 49 | Show container logs 50 | 51 | - `bash` 52 | Run a container bash 53 | 54 | - `root` 55 | Run bash with root permissions inside container 56 | 57 | - `exec` 58 | Execute a command inside the container 59 | 60 | - `console` 61 | Run live Domino server console 62 | 63 | - `domino` 64 | Run Domino start script command 65 | 66 | - `stop` 67 | Stop container 68 | 69 | - `rm` 70 | Remove container 71 | 72 | - `cleanup` 73 | Cleanup Domino server 74 | 75 | - `-image=image-name` 76 | Specify image to test 77 | 78 | - `-nostop` 79 | Don't stop container after testing (debugging/testing) 80 | 81 | ### Examples 82 | 83 | Bring up the specified Traveler server image and keeps the server running after performing all tests 84 | 85 | ``` 86 | ./AutomationTest.sh -image=hclcom/traveler:12.0.1 -nostop 87 | ``` 88 | 89 | Jump into the running container 90 | 91 | ``` 92 | ./AutomationTest.sh bash 93 | ``` 94 | 95 | 96 | ## Test performed 97 | 98 | - **domino.jvm.available** 99 | Checks if the JVM returns a proper version 100 | 101 | - **domino.server.running** 102 | Checks console, if server process started 103 | 104 | - **domino.http.running** 105 | Checks if HTTL task is running 106 | 107 | - **domino.certificate.available** 108 | Checks if HTTPS responds and the certificate is trusted 109 | 110 | - **domino.server.onetouch.microca-cert** 111 | Checks if the right certificate has been created via One Touch MicroCA configuration 112 | 113 | - **domino.server.onetouch.createdb** 114 | Checks if OneTouch setup created **iwaredir.nsf** 115 | 116 | - **domino.idvault.create** 117 | Checks if ID Vault has been created by One Touch setup 118 | 119 | - **domino.backup.create** 120 | Runs a backup of log.nsf and checks if the backup is available 121 | 122 | - **startscript.archivelog** 123 | Tests the Domino start script `archivelog` command by invoking it remotely and checking the resulting giz file 124 | 125 | - **container.health** 126 | Test if the container health script configured, returns the server is healthy 127 | 128 | - **startscript.server.restart** 129 | Restarts the Domino server inside the container via Domino start script and checks if the server comes up again 130 | 131 | - **domino.translog.create** 132 | Verifies if translog configured via One Touch setup, created transaction log extends after restarting the server 133 | 134 | - **domino.smtp_pop3.mail** 135 | Sends a SMTP mail via STARTTLS and retrieves the message via secure POP3 136 | 137 | ## Traveler image additional tests 138 | 139 | If a Traveler image is detected, automatically perform additional testing 140 | 141 | - **traveler.server.available** 142 | Check the Traveler status URL with the admin user via Traveler status URL 143 | 144 | --------------------------------------------------------------------------------