https://github.com/xenit-eu/care4alf

https://github.com/xenit-eu/care4alf

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/xenit-eu/care4alf
• Owner: xenit-eu
• License: lgpl-3.0
• Created: 2022-12-15T08:44:25.000Z (about 2 years ago)
• Default Branch: master
• Last Pushed: 2024-03-25T15:40:07.000Z (9 months ago)
• Last Synced: 2024-08-07T13:37:49.186Z (5 months ago)
• Language: Java
• Size: 2.51 MB
• Stars: 0
• Watchers: 3
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: license.txt

Awesome Lists containing this project

README

        
# Care4Alf

> [![Xenit Logo](https://xenit.eu/wp-content/uploads/2017/09/XeniT_Website_Logo.png)](https://xenit.eu/open-source)

> 

> Care4alf is a part of the Xenit Open Source Tooling around Alfresco.

> Xenit is company with high expertise and a strong team centered around Alfresco.

> If you'd like to learn more about our [tools](https://xenit.eu/open-source), [services](https://xenit.eu/alfresco) and [products](https://xenit.eu/alfresco-products)

> please visit our [website](https://xenit.eu).

## Important note

Version 4 marks the final release of Care4Alf. This repository has now been archived and is no longer maintained.

As this version concludes the active maintenance and development of Care4Alf, we encourage users to transition to 

[OOTBee Support Tools](https://github.com/OrderOfTheBee/ootbee-support-tools) as replacement for Care4Alf.

Care4Alf 4.0.0 drops supports for several Alfresco versions. The remaining supported Alfresco versions are:

- Alfresco 6.2.x

- Alfresco 7.3.x

- Alfresco 7.4.x

For other Alfresco versions, we recommend continuing with Care4Alf version 3.x.

## Build

Run `./gradlew :c4a-impl:care4alf-6x:assemble` to build a jar for alfresco 6x.

Change version number in module to 7 for alfresco 7

These jars can be deployed on Alfresco with Dynamic Extensions 2.0.1 or later.

## Test

You can run the integration tests with `./gradlew :c4a-test:test-6x:integrationTest` for Alfresco 6. 

The containers will automatically shut down after the

tests are completed. If you want to run the integration tests several times without always needing to restart the

containers, use `./gradlew:c4a-test:test-6x:composeUp`, followed by

`./gradlew :c4a-test:test-6x:integrationTestLocal -Pport=`.

## Extend

Add new module webscripts to the `xenit.care4alf.module` package. Make sure to annotate with the `care4alf` family.

Provide html (named .html) in the resources/eu/xenit/care4alf/web/partials directory.

Additionally, add your module id and description to `c4a-impl/src/main/resources/eu/xenit/care4alf/web/js/c4a/c4aModules.js`

## Monitoring

There are 2 ways to integrate monitoring:

1) Collect metrics using json endpoint alfresco/s/xenit/care4alf/monitoring/vars

2) Configure c4a to write to a graphite endpoint, see Graphite integration

### Graphite integration

Enable writing monitoring metrics to Graphite endpoint:

    c4a.monitoring.graphite.enabled=true

    c4a.monitoring.graphite.prefix=c4a.

    c4a.monitoring.graphite.host=

    c4a.monitoring.graphite.port=2003

    

Optionally you can enable/disable specific metrics using:

    c4a.monitoring.metric..enabled=true

    c4a.monitoring.metric.documenttypes.enabled=true

    c4a.monitoring.metric.repository.enabled=false

    c4a.monitoring.metric.residualproperties.enabled=false

### Accessing the Care4Alf Console

Access the Care4Alf console by accessing `http://server:port/alfresco/s/xenit/care4alf/`