mirror of
https://github.com/Alfresco/alfresco-transform-core.git
synced 2025-08-14 17:58:27 +00:00
ATS: tweaks to top-level README + fix a few typos
This commit is contained in:
18
README.md
18
README.md
@@ -52,6 +52,7 @@ and Alfresco Maven repository:
|
|||||||
```
|
```
|
||||||
|
|
||||||
#### Docker
|
#### Docker
|
||||||
|
|
||||||
The core T-Engine images are available on Docker Hub:
|
The core T-Engine images are available on Docker Hub:
|
||||||
* [alfresco/alfresco-imagemagick](https://hub.docker.com/r/alfresco/alfresco-imagemagick)
|
* [alfresco/alfresco-imagemagick](https://hub.docker.com/r/alfresco/alfresco-imagemagick)
|
||||||
* [alfresco/alfresco-pdf-renderer](https://hub.docker.com/r/alfresco/alfresco-pdf-renderer)
|
* [alfresco/alfresco-pdf-renderer](https://hub.docker.com/r/alfresco/alfresco-pdf-renderer)
|
||||||
@@ -59,13 +60,28 @@ The core T-Engine images are available on Docker Hub:
|
|||||||
* [alfresco/alfresco-tika](https://hub.docker.com/r/alfresco/alfresco-tika)
|
* [alfresco/alfresco-tika](https://hub.docker.com/r/alfresco/alfresco-tika)
|
||||||
* [alfresco/alfresco-transform-misc](https://hub.docker.com/r/alfresco/alfresco-transform-misc)
|
* [alfresco/alfresco-transform-misc](https://hub.docker.com/r/alfresco/alfresco-transform-misc)
|
||||||
|
|
||||||
|
Unless you plan to deploy & scale each independently, the above five are also combined into a single Core AIO ("All-In-One"):
|
||||||
|
* [alfresco/alfresco-transform-core-aio](https://hub.docker.com/r/alfresco/alfresco-transform-core-aio)
|
||||||
|
|
||||||
|
For ACS Enterprise subscribers, the above T-Engine images are also available in [Quay.io](https://quay.io/alfresco).
|
||||||
|
|
||||||
|
### Alfresco Content Services Deployments
|
||||||
|
|
||||||
|
For containerized reference deployments (of either Alfresco Community or ACS Enterprise) see ACS Deployment project:
|
||||||
|
|
||||||
|
* [Docker Compose](https://github.com/Alfresco/acs-deployment/tree/master/docs/docker-compose#readme)
|
||||||
|
* [Helm / Kubernetes](https://github.com/Alfresco/acs-deployment/tree/master/docs/helm#readme)
|
||||||
|
|
||||||
|
For non-containerized reference deployment, see Ansible Playbook project:
|
||||||
|
|
||||||
|
* [Ansible Playbooks](https://github.com/Alfresco/alfresco-ansible-deployment#readme)
|
||||||
|
|
||||||
### Release Process
|
### Release Process
|
||||||
|
|
||||||
For a complete walk-through check out the
|
For a complete walk-through check out the
|
||||||
[build-and-release.MD](https://github.com/Alfresco/alfresco-transform-core/tree/master/docs/build-and-release.md)
|
[build-and-release.MD](https://github.com/Alfresco/alfresco-transform-core/tree/master/docs/build-and-release.md)
|
||||||
under the `docs` folder.
|
under the `docs` folder.
|
||||||
|
|
||||||
|
|
||||||
### Contributing guide
|
### Contributing guide
|
||||||
|
|
||||||
Please use [this guide](https://github.com/Alfresco/alfresco-repository/blob/master/CONTRIBUTING.md)
|
Please use [this guide](https://github.com/Alfresco/alfresco-repository/blob/master/CONTRIBUTING.md)
|
||||||
|
@@ -49,7 +49,7 @@ src/main/java/org/alfresco/transformer/Application.java
|
|||||||
~~~
|
~~~
|
||||||
|
|
||||||
* *TransformerName*Controller.java - A [Spring Boot](https://projects.spring.io/spring-boot/) Controller that
|
* *TransformerName*Controller.java - A [Spring Boot](https://projects.spring.io/spring-boot/) Controller that
|
||||||
extends AbstractTransformerController to handel requests. It implements a few methods including *transformImpl*
|
extends AbstractTransformerController to handle requests. It implements a few methods including *transformImpl*
|
||||||
which is intended to perform the actual transform. Generally the transform is done in a sub class of
|
which is intended to perform the actual transform. Generally the transform is done in a sub class of
|
||||||
*JavaExecutor*, when a Java library is being used or *AbstractCommandExecutor*, when an external process is used.
|
*JavaExecutor*, when a Java library is being used or *AbstractCommandExecutor*, when an external process is used.
|
||||||
Both are sub interfaces of *Transformer*.
|
Both are sub interfaces of *Transformer*.
|
||||||
@@ -153,7 +153,7 @@ Transform requests are handled by the *AbstractTransformerController*, but are e
|
|||||||
* POST requests (a direct http request from a client) where the transform options are passed as parameters, the source is supplied as a multipart file and
|
* POST requests (a direct http request from a client) where the transform options are passed as parameters, the source is supplied as a multipart file and
|
||||||
the response is a file download.
|
the response is a file download.
|
||||||
* POST request (a request via a message queue) where the transform options are supplied as JSON and the response is also JSON.
|
* POST request (a request via a message queue) where the transform options are supplied as JSON and the response is also JSON.
|
||||||
The source and target content is read from a location accessible to both the client and the transfomer.
|
The source and target content is read from a location accessible to both the client and the transformer.
|
||||||
|
|
||||||
**Example JSON request body**
|
**Example JSON request body**
|
||||||
```javascript
|
```javascript
|
||||||
@@ -228,6 +228,6 @@ The build plan is available in [TravisCI](https://travis-ci.com/Alfresco/alfresc
|
|||||||
|
|
||||||
## Contributing guide
|
## Contributing guide
|
||||||
|
|
||||||
Please use [this guide](https://github.com/Alfresco/alfresco-repository/blob/master/CONTRIBUTING.md)
|
Please use [this guide](https://github.com/Alfresco/alfresco-community-repo/blob/master/CONTRIBUTING.md)
|
||||||
to make a contribution to the project.
|
to make a contribution to the project.
|
||||||
|
|
||||||
|
@@ -96,7 +96,7 @@ The config can be found under `alfresco-transform-core\<t-engine-name>\src\main\
|
|||||||
**Limitations**:
|
**Limitations**:
|
||||||
* For a transformOptions to be referenced in a different T-engine, another transformer
|
* For a transformOptions to be referenced in a different T-engine, another transformer
|
||||||
with the complete definition of the transformOptions needs to return the config to the client.
|
with the complete definition of the transformOptions needs to return the config to the client.
|
||||||
* In a transformOptions definition it is not allowed to use a reference to another tranformOption.
|
* In a transformOptions definition it is not allowed to use a reference to another transformOption.
|
||||||
|
|
||||||
### Transformers
|
### Transformers
|
||||||
* **transformers** - A list of transformer definitions.
|
* **transformers** - A list of transformer definitions.
|
||||||
@@ -113,7 +113,7 @@ The config can be found under `alfresco-transform-core\<t-engine-name>\src\main\
|
|||||||
**maxSourceSizeBytes** and a **priority** value.
|
**maxSourceSizeBytes** and a **priority** value.
|
||||||
* *maxSourceSizeBytes* is used to set the upper size limit of a transformation.
|
* *maxSourceSizeBytes* is used to set the upper size limit of a transformation.
|
||||||
* If not specified, the default value for maxSourceSizeBytes is **unlimited**.
|
* If not specified, the default value for maxSourceSizeBytes is **unlimited**.
|
||||||
* *priority* it is used by clients to determine which transfomer to call or by T-engines
|
* *priority* it is used by clients to determine which transformer to call or by T-engines
|
||||||
with multiple transformers to determine which one to use. In the above Tika snippet,
|
with multiple transformers to determine which one to use. In the above Tika snippet,
|
||||||
both *TikaAuto* and *TextMining* have the capability to transform *"application/msword"*
|
both *TikaAuto* and *TextMining* have the capability to transform *"application/msword"*
|
||||||
into *"text/xml"*, the transformer containing the source-target media type with higher priority will be chosen by the
|
into *"text/xml"*, the transformer containing the source-target media type with higher priority will be chosen by the
|
||||||
|
Reference in New Issue
Block a user