From bd19ba178f5669c8cc8947948676270b0df90d54 Mon Sep 17 00:00:00 2001 From: mike Date: Wed, 2 Oct 2024 13:16:58 -0400 Subject: [PATCH] Install updated index.html --- docs/index.html | 329 +++++++++--------------------------------------- 1 file changed, 58 insertions(+), 271 deletions(-) diff --git a/docs/index.html b/docs/index.html index d0acdf0..f928b10 100644 --- a/docs/index.html +++ b/docs/index.html @@ -132,28 +132,15 @@

Bedework Enterprise Calendar System

  • 6.2. Installing bedework on Ubuntu
    • -
  • 6.3. Installing the quickstart (3.12.x onwards) +
  • 6.3. Deploying servers
    • +
  • 6.4. Configuring wildfly -
    • -
  • 6.4. Deploying servers
    • -
  • 6.5. Configuring wildfly -
    • -
  • 6.6. Configure keycloak saml +
  • 6.5. Configure keycloak saml
  • Setting up databases @@ -162,25 +149,25 @@

    Bedework Enterprise Calendar System

  • MySQL
    • -
  • 6.7. OpenSearch +
  • 6.6. OpenSearch
    • -
  • 6.8. Enabling and Disabling Public Events Registration +
  • 6.7. Enabling and Disabling Public Events Registration
    • -
  • 6.9. Initializing the database +
  • 6.8. Initializing the database
    • @@ -2908,7 +2895,7 @@

    6.1.3. Fast-track demo version

    will also be included.

    -

    These steps have been tested on a mac and on the latest LTS linux.

    +

    These steps have been tested on a mac and on the latest LTS linux. Any examples are for Ubuntu.

    @@ -2929,14 +2916,33 @@

    6.1.3. Fast-track demo version

  • Install jdk 17

    • + + +
    +
    +
    apt install openjdk-17-jdk
    +
    +
    +
    + +
    +
    +
    +
    wget https://github.com/wildfly/galleon/releases/download/5.2.2.Final/galleon-5.2.2.Final.zip
    +
    +
    +
    +

    and unzip.

    +
    +
    +

    • run galleon to install - this is all one command:

      • @@ -3542,228 +3548,9 @@

      6.2. Installing bedework on Ubuntu

      q
    -
    -

    For versions 4.0.0 onwards it is not necessary to install a quickstart. You can install a quickstart if you wish to do development or have convenient access to the sources.

    -
    -
    -

    If you are only interested in having a runnable version for demonstration or production then see the instructions at Install bedework as a wildfly feature

    -
    - -
    -

    6.3. Installing the quickstart (3.12.x onwards)

    -
    -

    The current quickstart is installed by executing a script which will create the quickstart directory and then download, clone and build. In the event of a failure part way through, the script may be restarted with the restart parameter.

    -
    -
    -
    - - - - -
    -
    Note
    -    		 -This requires git 2.x or greater. The clones use a tag rather than branch and this does not work for older gits. -
    -
    -
    -

    The latest script may be downloaded from github. Alternatively clone the bedework repo and use the script at bedework/build/quickstart/linux/installQS.sh

    -
    -
    -

    Specific versions of the script are at:

    -
    -
    - -
    -
    -

    6.3.1. Which version

    -
    -

    The script will ask you if you want the latest, developmentor pre-release version.

    -
    -
    -

    You probably want latest. The dev version is obviously for development and can be very unstable. The pre-release version is ther only for testing of the install script.

    -
    -
    -
    -

    6.3.2. Apacheds

    -
    -

    The script will install apacheds. This will install a directory with some initial ids in place for testing. Ultimately you’ll want to use your own directory service.

    -
    -
    -
    -

    6.3.3. OpenSearch

    -
    -

    You need a running OpenSearch - currently release 1.2.3 The glleon install will provide a script to install a docker image and customize it for the quickstart.

    -
    -
    -

    This requires you to have docker and docker-compose installed first.

    -
    -
    -

    The instructions related to installing a docker image can be found at https://opensearch.org/docs

    -
    -
    -

    After the install is complete use the 2 scripts bwstartosch.sh and bwstoposch.sh to start and stop the docker image.

    -
    -
    -

    If you want to install your own copy and configure it the configuration directory is wildfly/standalone/configuration/bedework/opensearch/config. Use this to replace the config in the downloaded OpenSearch.

    -
    -
    -
    -

    6.3.4. Maven

    -
    -

    Maven is required if you want to install the sources. If not you can skip this section.

    -
    -
    -

    This is a maven project and as usual you need to set up your maven profile in ~/.m2/settings.xml. The script will display a possible settings.xml file with the paths filled in.

    -
    -
    -

    If you want to merge in the profile to an existing settings.xml ensure you also merge in the pluginGroups section.

    -
    -
    -

    The profile does not need to be active by default if you have other profiles. The build process will specify the bedework-qs profile.

    -
    -
    -

    Below is the contents of an example settings.xml file. This file must be set up before allowing the script to continue on to the builds otherwise they will fail during deployment.

    -
    -
    -
    -
    <settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
-          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-          xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0
-                         http://maven.apache.org/xsd/settings-1.0.0.xsd">
-  <pluginGroups>
-    <pluginGroup>org.bedework</pluginGroup>
-  </pluginGroups>
-
-  <profiles>
-    <profile>
-      <id>bedework-3</id>
-      <activation>
-        <activeByDefault>false</activeByDefault>
-      </activation>
-      <properties>
-        <org.bedework.deployment.basedir>$qs</org.bedework.deployment.basedir>
-        <org.bedework.deployment.properties>$qs/bedework/config/wildfly.deploy.properties</org.bedework.deployment.properties>
-      </properties>
-    </profile>
-  </profiles>
-</settings>
    -
    -
    -
    -
    -

    6.3.5. Default Maven Profiles

    -
    -

    Note there appears to be a bug in the use of activeByDefault. -Explicitly specifying a profile with the maven -P parameter is supposed -to deactivate a profile marked as activeByDefault. This is not (always?) -happening.

    -
    -
    -

    If you only have profile marking by default should be fine. To ensure -only one profile (or the expected profiles) are active cd into the project -and try

    -
    -
    -
    -
    mvn -P bedework-3 help:active-profiles
    -
    -
    -
    -
    -

    6.3.6. Settings for build and install

    -
    -

    The bw and install scripts now source a .bw file in the home directory -which can set some defaults.

    -
    -
    -

    To alleviate some of the issues of having multiple maven profiles for bedework -builds set the profile here with the bw-mvnProfile property. Note the setting needs to include the -P.

    -
    -
    -

    When building with maven the profile provides the location of the deployment properties. For the quickstart this is located in the bedework module at bedework/config/wildfly.deploy.properties.

    -
    -
    -

    When using the nobuild option you need to take a copy of that file and modify it according to the needs of your installation. Update the .bw file property bw_deployProps to define the location of the modified property file.

    -
    -
    -

    An example .bw file is:

    -
    -
    -
    -
    #
-# Defaults for bw script
-#
-echo "Setting defaults from .bw"
-bw_mvnProfile="-P bedework_dev"
-
-bw_deployProps="/home/myhome/bwstuff/myprops.properties"
    -
    -
    -
    -
    -

    6.3.7. Security

    -
    -

    During the install an id and password will be set up so that the install process can reindex the data. These will allow use of the cli and the hawtio console.

    -
    -
    -
    -

    6.3.8. Building

    -
    -

    In many cases it is possible to simply cd in to the appropriate directory and do a mvn install with the bedework-3 profile. However there is a bw script which - while taking longer - does build all projects a module depends upon. This avoids the need to work out the dependency orderings of the independent projects. Thus

    -
    -
    -
    -
    ./bw bwcal
    -
    -
    -
    -

    will build a lot of projects eventually building the client project which deploys an ear file.

    -
    -
    -
    -

    6.3.9. Deploying

    -
    -

    As part of the bedework project there is a maven plugin which uses a properties file to handle post-build deployment issues. Essentially the ear or war as built acts as a template for the deployer.

    -
    -
    -

    The deployment process may involve inserting filters for CAS, adding property values to web.xml files, cloning entire wars for calendar suites etc.

    -
    -
    -

    The file bedework/config/wildfly.deploy.properties is the quickstart version of that file.

    -
    -
    -

    When developing your own service the first thing to do is create a repository with your files and copy the above file into that repository. Then set the org.bedework.deployment.properties value in your maven settings.xml to point to that file.

    -
    -
    -

    DO NOT change the org.bedework.deployment.basedir property - unless you move the quickstart. This property is used to locate the wildfly instance.

    -
    -
    -

    6.4. Deploying servers

    +

    6.3. Deploying servers

    It is possible to deploy bedework in a number of configurations. There are the following major components to consider:

    @@ -3815,9 +3602,9 @@

    6.4. Deploying servers

    -

    6.5. Configuring wildfly

    +

    6.4. Configuring wildfly

    -

    6.5.1. Adding an admin account

    +

    6.4.1. Adding an admin account

    cd <quickstart-dir>
@@ -3852,12 +3639,12 @@ 
    6.5.1. Adding an admin account
    -

    6.6. Configure keycloak saml

    +

    6.5. Configure keycloak saml

    Saml seems to need a certificate for signing. A self-signed cert will do.

    -

    6.6.1. Create a self-signed cert.

    +

    6.5.1. Create a self-signed cert.

    # Generate private key
@@ -4149,7 +3936,7 @@ 
    MySQL
    -

    6.7. OpenSearch

    +

    6.6. OpenSearch

    Bedework uses OpenSearch as the indexer engine. As objects are created destroyed and updated they are indexed through calls to the indexer. The indexer can run as a local application, useful for development - or as an external service - which will be required for clustering.

    @@ -4197,7 +3984,7 @@

    6.7. OpenSearch

    Use specific names for the cluster and nodes.

    -

    6.7.1. Installing OpenSearch

    +

    6.6.1. Installing OpenSearch

    There are a number of options available. The deployed wildfly demo server has a script to deploy a docker image of OpenSearch. First ensure docker is installed on your system and running then execute:

    @@ -4249,7 +4036,7 @@

    6.7.1. Installing OpenSearch

    -

    6.7.2. Installing a runnable OpenSearch

    +

    6.6.2. Installing a runnable OpenSearch

    If you wish to install OpenSearch as a runnable service there are instructions on running a minimal version without any security. You will need to copy the configuration and possibly the data from the deployed demo wildfly.

    @@ -4276,15 +4063,15 @@

    6.7.2. Installing a runnable OpenSear

    -

    6.8. Enabling and Disabling Public Events Registration

    +

    6.7. Enabling and Disabling Public Events Registration

    -

    6.8.1. Enabling Public Events Registration

    +

    6.7.1. Enabling Public Events Registration

    The public events registration system is enabled by default if you have installed Bedework with the data available in the quickstart.

    -

    6.8.2. Disabling Public Events Registration

    +

    6.7.2. Disabling Public Events Registration

    If you wish to disable the public events registration system remove the "Eventreg admin token" from the System Preferences in the jmx console:

    @@ -4313,7 +4100,7 @@

    6.8.2. Disabling Public Events Re

    -

    6.8.3. Enabling Public Events Registration (possibly after upgrade from a previous release)

    +

    6.7.3. Enabling Public Events Registration (possibly after upgrade from a previous release)

    First ensure that the CalWs interface is available. This is the SOAP service that the event registration service uses o communicate with bedework. In system.xml make sure the <calSoapWsURI> element is present and has the same value as the soap:address element in pubcalws-soap/wssvc.wsdl (this requires better explanation - it’s a file deployed in the bw-xml ear)

    @@ -4414,7 +4201,7 @@

    -

    6.8.4. Notifications from EventReg

    +

    6.7.4. Notifications from EventReg

    The event registration service will send notifications to the calendar engine when changes take place that might require notifying users. The event registration service calls the calendar engine notification web service (not to be confused with the notification engine). This web service allows the core engine to add notifications to the accounts of subscribed users. It is the job of the notification engine to forward those via email or some other service.

    @@ -4435,7 +4222,7 @@

    6.8.4. Notifications from EventReg

    -

    6.9. Initializing the database

    +

    6.8. Initializing the database

    If running with mysql the built in hibernate schema export doesn’t work - mysql jdbc does not support it.

    @@ -4476,7 +4263,7 @@

    6.9. Initializing the database

    -

    6.9.1. (Re)build bw-xml

    +

    6.8.1. (Re)build bw-xml

    The synch engine uses an extension of CalWS to communicate with bedework. It requires that the wsdl file contain the location of bedework. This is configured into the deploy.properties file - only one change for the synch engine should be necessary. Set the location of (one of) your application servers in the following.

    @@ -4536,7 +4323,7 @@

    6.9.1. (Re)build bw-xml

    -

    6.9.2. Validating locations.

    +

    6.8.2. Validating locations.

    When an event arrives at the receiving end with an "X-BEDEWORK-LOCATION" property if the String value of the x-property is …​ === Locations in bedework

    @@ -4546,7 +4333,7 @@

    6.9.2. Validating locations.

    -

    6.9.3. Searching for public locations

    +

    6.8.3. Searching for public locations

    There is a web service endpoint which can be used to search for public locations. It takes a filter expression as a parameter and will return <a limited?> number

    @@ -6160,7 +5947,7 @@

    Previous versions of this document<