Commit d161bd5a authored by tom.brewster's avatar tom.brewster

Grammer and vernacular for alfstream.

parent 69854d2d
......@@ -19,6 +19,30 @@ The change log for Alfstream can be found [here](../changelogs/alfstream.md)
* Apache Karaf 4.0+
* The Alfstream Camel Component
### Compilation
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 of the Alfresco amp plugin requires the following:
* Java JDK 7 or above installed
* Gradle installed
### Cloning the repository
You can simply clone down our repository with your gitlab account:
`` git clone https://gitlab.parashift.com.au/open/alfresco-amp-plugin ``
### Publishing to Local Maven
Once you have cloned the repository, it should be published into your gradle environment. This will by default publish to your local computer, but you can adjust build.gradle to publish to another Maven server if it's a requirement with:
```gradle publish```
## Installation (Alfresco)
* Parashift's AlfStream module is a Repo only amp, please follow our [Installation guide](../setup/installation.md) on how to install this module.
......@@ -35,9 +59,9 @@ Karaf is normally stored within the `/opt/apache-karaf-*/` directory where `*` i
To install prerequisite software you will need to do the following:
* Download and install the latest version of Java JDK (version 8): http://www.oracle.com/technetwork/java/javase/downloads/index.html
* Download and install the latest version of Java JDK (version 8): [http://www.oracle.com/technetwork/java/javase/downloads/index.html](http://www.oracle.com/technetwork/java/javase/downloads/index.html)
* Download and install Apache Karaf:
http://karaf.apache.org/download.html
[http://karaf.apache.org/download.html](http://karaf.apache.org/download.html)
* Extract this to a directory such as `C:\apache-karaf-4.0.7`
* Run the application in a terminal with `bin\karaf.bat`
......@@ -100,7 +124,7 @@ To monitor that everything is going OK, you can utilise the web console `hawtio`
#### Camel Routes
In the `Camel` tab, you can see deployed routes that are in Apache Karaf.
In the `Camel` tab of hawtio, you can see deployed routes that are in Apache Karaf.
#### Tracing
......@@ -119,7 +143,7 @@ The logs are accessible via the `Logs` tab. By default the Log Level of `INFO`
### CLI
* run `bin/client` from the karaf directory (normally `/opt/apache-karaf-*/`)
* (Optional) jack up the log to debug for parashift packages:
* (Optional) increase the log to include debug logging for parashift packages:
```
log:set DEBUG com.parashift
......
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