Commit 0fafcb2f authored by peter's avatar peter

Adjust alfstream and alfstream sync wording

parent 0f2deb81
......@@ -71,13 +71,56 @@ Please follow the below steps to install the amps and setup the environment
You will need to install the following modules:
* Alfresco Dynamic Extensions 1.4.2 +
* Alfresco Dynamic Extensions 1.4.2 which you can [download from here](https://github.com/xenit-eu/dynamic-extensions-for-alfresco/releases/download/1.4.2/com.github.dynamicextensionsalfresco-1.4.2.amp)
* Alfstream version 1.7.x or above
* This Module (Alfstream Sync)
Install all 3 amps on both sides.
#### Alfresco Full Site Sync Configuration
### Karaf Setup
#### Installing Karaf for Alfstream
!!!note
You will need to run an instance Karaf on both sides for two way sync. If you only run one instance, then the sync will only work one-way
Follow these steps for each side:
* Make sure you have downloaded the provided alfstream sync `kar` file to put into the deploy directory
* Follow the instructions for installing Karaf from here: [alfstream](alfstream.md#installation-karaf)
* Create a or update the config file at `/opt/apache-karaf-{version}/etc/com.parashift.cfg` with the following properties:
* `alfstream.local.url`: the Local alfresco instance (normally localhost, but could be a different server)
* `alfstream.local.username`: the Local alfresco admin username
* `alfstream.local.password`: the Local alfresco admin password
* `alfstream.remote.url`: the Remote alfresco instance
* `alfstream.remote.username`: the Remote alfresco admin username
* `alfstream.remote.password`: the Remote alfresco admin password
* `alfstream.sync.persist.file`: the file used to store the last sync status
As an example:
```
alfstream.remote.url=http://sidea.dev.parashift.local:8080/alfresco
alfstream.remote.username=admin
alfstream.remote.password=admin
alfstream.local.url=http://localhost:8080/alfresco
alfstream.local.username=admin
alfstream.local.password=admin
alfstream.sync.persist.file=persist/alfstream-sync
```
* Add the provided `kar` file to the deploy directory.
#### Testing and Monitoring
Follow the steps here to enable debug logging for `com.parashift`: [alfstream](alfstream.md#monitoring-karaf)
### Alfresco Full Site Sync Configuration
If you need to synchronise entire sites, we need to let Share know to update its cache whenever there has been a change to the site configuration (dashboards, themes, etc..)
......@@ -118,63 +161,3 @@ curl --request POST \
--header 'content-type: application/json' \
--data '{ "path": "alfresco/site-data/pages/site/test-sync-full-site/dashboard.xml", "token": "ParashiftRocks!" }'
```
### Karaf Setup
#### Installing Karaf for Alfstream
With the node aspects in Alfresco, we construct a two-way camel route which will:
* Listen for changes to any nodes with the `alfs:sync` aspect
* Filter out any nodes with the sync state of `Not Synced`
* Change the `alfs_syncState` from `Inactive` to `Not Synced`
* Capture any exception thrown during the node sync process and update the node with error message
You will need to follow this step on both sides:
* Follow the instructions for installing Karaf/Alfstream from here: [alfstream](alfstream.md)
* Create a or update the config file at `/opt/apache-karaf-{version}/etc/com.parashift.cfg` with the following properties:
* `alfstream.local.url`: the Local alfresco instance (normally localhost, but could be a different server)
* `alfstream.local.username`: the Local alfresco admin username
* `alfstream.local.password`: the Local alfresco admin password
* `alfstream.remote.url`: the Remote alfresco instance
* `alfstream.remote.username`: the Remote alfresco admin username
* `alfstream.remote.password`: the Remote alfresco admin password
* `alfstream.sync.persist.file`: the file used to store the last sync status
As an example:
```
alfstream.remote.url=http://sidea.dev.parashift.local:8080/alfresco
alfstream.remote.username=admin
alfstream.remote.password=admin
alfstream.local.url=http://localhost:8080/alfresco
alfstream.local.username=admin
alfstream.local.password=admin
alfstream.sync.persist.file=persist/alfstream-sync
```
Since `1.2.2`, we provide default values in [alfstream-sync-blueprint.xml](../examples/alfstream-sync-blueprint.xml) for local alfstream configurations and persist file as shown below:
```
alfstream.local.url=http://localhost:8080/alfresco
alfstream.local.username=admin
alfstream.local.password=admin
alfstream.sync.persist.file=persist/alfstream-sync
```
You only need to provide remote related alfstream configurations if the default values work for you.
* Since `1.2.2` you can create a KAR Bundle:
* Download or navigate to where you have stored the [alfstream module](https://gitlab.parashift.com.au/parashift-modules/alfstream)
* Run `gradle publishToMavenLocal` to publish the artifact
* In the camel directory of alfstream-sync, run `gradle generateKar`
* Copy the generated KAR archive to the `deploy` directory of karaf, the example path like `/opt/apache-karaf-{version}/deploy`.
#### Testing and Monitoring
Follow the steps here to enable debug logging for `com.parashift`: [alfstream](alfstream.md#monitoring-karaf)
......@@ -10,7 +10,7 @@ The change log for Alfstream can be found [here](../changelogs/alfstream.md)
### Alfresco
* Alfresco Dynamic Extensions
* Alfresco Dynamic Extensions 1.4.2 which you can [download from here](https://github.com/xenit-eu/dynamic-extensions-for-alfresco/releases/download/1.4.2/com.github.dynamicextensionsalfresco-1.4.2.amp)
* Java version 8
* Version 5.0 and Above
......@@ -23,7 +23,7 @@ The change log for Alfstream can be found [here](../changelogs/alfstream.md)
We have created a plugin for gradle called the alfresco amp plugin which is a requirement for compiling all of our modules.
###Installing the Alfresco Amp Plugin
### Installing the Alfresco Amp Plugin
Installing of the Alfresco amp plugin requires the following:
......@@ -188,20 +188,7 @@ You will need a log level set to debug within karaf:
### Two Way Blueprint
File: [examples/alfstream-two-way-blueprint.xml](../examples/alfstream-two-way-blueprint.xml)
The two way blueprint will synchronise between two instances of Alfresco. This will synchronise all files and folders within a site called `test`.
You will need to set the following configuration properties:
* `alfstream.local.url`: the Local alfresco instance (normally localhost, but could be a different server)
* `alfstream.local.username`: the Local alfresco admin username
* `alfstream.local.password`: the Local alfresco admin password
* `alfstream.remote.url`: the Remote alfresco instance
* `alfstream.remote.username`: the Remote alfresco admin username
* `alfstream.remote.password`: the Remote alfresco admin password
[Alfstream Sync](./alfstream-sync.md) is used to provide two way syncing between Alfresco instances.
### Upsert Blueprint
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment