WebSight Blueprint

WebSight Blueprint is a sample project built on top of the Websight CMS Community Edition.

It contains demo pages:

• Luna in three variants (no-code, low-code, custom-code)
• Puresight
• Kyanite - personal template

Those pages are built with Howlite and Kyanite component libraries.

Playground

Set up a local on-demand environment with the released WebSight CMS CE Docker images by running:

curl https://docs.websight.io/scripts/get.sh | sh

and then see the results on localhost:8080/apps/websight/index.html/content::spaces (credentials are wsadmin/wsadmin).

For more details see our Authoring Quick Start Guide.

Websight Technologies

Find out what technologies the Dynamic Solutions team has used to design, build and launch WebSight.

CMS

Websight CMS makes use of the following technologies:

CMS Runtime

The following technologies are used for running WebSight:

CMS Supportive

The following technologies are used to support the process of delivery:

Design and Prototype

The following technologies are used in designing and prototyping:

Development

You need to have Java 17 installed to build the project.

To build the project, run:

./mvnw clean package

To start a local instance (with debugging enabled on port 7777), run:

JAVA_DEBUG_OPTS="-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=*:7777"
export JAVA_OPTS="${JAVA_OPTS} ${JAVA_DEBUG_OPTS}"

distribution/target/dependency/org.apache.sling.feature.launcher/bin/launcher \
  -f distribution/target/slingfeature-tmp/feature-websight-cms-starter-tar.json \
  -D org.osgi.service.http.port=8888

The logs will be available at launcher/logs directory.

Then open http://localhost:8888/ in a Web browser and log in using the credentials wsadmin/wsadmin.

For more details please refer to our Developers quick start guide.

Run modes

Running the starter WebSight CMS project requires selecting OAK Node Storage mode. To choose the mode, run the distribution with one of the following configuration files:

• feature-websight-cms-starter-tar.json - starts the project with the TAR Segment NodeStore mode (uses the local file system, by default ./launcher directory)
• feature-websight-cms-starter-mongo.json - starts the project with the MongoDB Document NodeStore mode (requires MongoDB instance)

To run the stater project with MongoDB run:

docker run -d -p 27017:27017 --env MONGO_INITDB_ROOT_USERNAME=mongoadmin \
  --env MONGO_INITDB_ROOT_PASSWORD=mongoadmin mongo
  
MONGODB_HOST=localhost && MONGODB_PORT=27017 && distribution/target/dependency/org.apache.sling.feature.launcher/bin/launcher \
  -f distribution/target/slingfeature-tmp/feature-websight-cms-starter-mongo.json

Project structure

• applications - components related code and scripts
  • luna-custom-code - contains code related to custom-code version of the Luna project
    • backend - contains application elements (components, templates, etc.) and Java code
    • frontend - contains frontend elements (scss, ts, fonts etc.)
  • luna-low-code - contains code related to low-code version of the Luna project
    • backend - contains application elements (components, templates, etc.) and Java code
    • frontend - contains frontend elements (scss, ts, fonts etc.)
  • puresight - contains code related to Puresight project
    • backend - contains application elements (components, templates, etc.) and Java code
    • frontend - contains frontend elements (scss, ts, fonts etc.)
    • content - contains initial content related to the project
• content - contains sample content created with use of application
• distribution - builds a distribution (Sling OSGi Feature) of the project
• tests - responsible for the automatic distribution validation
  • content - contains content used for end-to-end tests
  • end-to-end - end-to-end tests validating distribution

Executing end-to-end tests

Check the tests README for more details.

Docker

You can run a containerized version of the project by building the Docker image with the following command:

docker build -t ds/websight-cms-starter .

And running it with:

docker run -p 8888:8080 --name websight-cms --rm \
  --mount source=segment-store-repository,target=/websight/launcher/repository ds/websight-cms-starter

By default, the tar mode is used.

You can find an example WebSight CMS Starter with MongoDB setup in the CMS Helm Chart.

StreamX

The WebSight Blueprint integrates seamlessly with StreamX. To launch a StreamX instance, use the StreamX CLI with a mesh.yaml configuration file. You can find a reference configuration in the StreamX Commerce Accelerator GitHub repository.

Note: WebSight Starter is pre-configured to shorten paths within published page content. However, for this to function, a mandatory matching configuration must be added to the mesh/configs/rest-ingestion.properties file in your cloned StreamX Commerce Accelerator repository. The feature requires both sides to be configured correctly to work.

Important: Do not commit these changes to the repository.

streamx.proxy.config.subject-regex-rewrite.types.pages.types=com.streamx.blueprints.page.published.v1,com.streamx.blueprints.page.unpublished.v1
streamx.proxy.config.subject-regex-rewrite.types.pages.patterns.config1.match-pattern=^(:?)/published/puresight/pages/(.*)
streamx.proxy.config.subject-regex-rewrite.types.pages.patterns.config1.rewrite-pattern=$1/$2

streamx.proxy.config.subject-regex-rewrite.types.assets.types=com.streamx.blueprints.asset.published.v1,com.streamx.blueprints.asset.unpublished.v1
streamx.proxy.config.subject-regex-rewrite.types.assets.patterns.config1.match-pattern=^(:)?/published/puresight/assets/(.*)
streamx.proxy.config.subject-regex-rewrite.types.assets.patterns.config1.rewrite-pattern=$1/assets/$2

When you have both WebSight and StreamX up and running, you can set up ingestion from WebSight to StreamX:

1. Add both Docker containers for StreamX Ingestion and Websight to the same Docker network, by executing the script
2. Navigate to Apache Felix console at http://localhost:8888/system/console/configMgr and perform the following changes:
3. In "com.streamx.sling.connector.impl.StreamxPublicationServiceImpl", change enabled to true
4. In "com.streamx.sling.connector.impl.StreamxClientConfigImpl~puresight", change streamxUrl to http://rest-ingestion.proxy:8080

Publish sample page to test communication

1. Go to http://localhost:8888/apps/websight
2. Open the Puresight space
3. Open the Homepage page
4. In the top-right corner, click Publish
5. On the Unpublished references detected popup, click Publish
6. Verify the page is published to StreamX by visiting http://localhost:8084/homepage.html

Contributing

Please read our Contributing Guide before submitting a Pull Request to the project.

Community support

To support us, you may follow the project at:

• feel free to star this repository, open issues, and start discussions
• linkedin.com/company/websight-io/
• twitter.com/websight_io

Documentation

See our dedicated repository for the WebSight CMS documentation, or view our documentation live:

• User guide
• Developer guide

License

WebSight Blueprint, Kyanite components and Howlite components are open-source with Apache License 2.0 license.

WebSight CMS Community Edition is free to use for everyone (terms of use).