inteligr8/alfresco-sdk
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-sdk.git synced 2025-10-01 14:41:57 +00:00
Code Issues Packages Projects Releases Wiki Activity

Documentation - Working with Enterprise

Browse Source 
Add some articles to explain how to properly configure the development
environment to work with Alfresco Enterprise instead of the Community
version.
This commit is contained in:
Jose Luis Osorno
2019-01-15 13:58:23 +01:00
parent d1fb454772
commit 64d53e0fe6
4 changed files with 126 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
docs/alfresco-transform-service.md
View File

@@ -9,8 +9,7 @@ By default, the _Alfresco Transform Service_ (from now ATS) is not included in t
SDK archetypes.
ATS is only supported in ACS Enterprise and it is distributed as a composition of Docker containers. The docker images required for ATS are available in the
private Alfresco [Quay.io](https://quay.io/) docker registry. You'll need your [Quay.io](https://quay.io/) account credentials to access the Docker images.
If you don't already have these credentials, contact [Alfresco Support](https://support.alfresco.com/).
Alfresco private docker registry at [Quay.io](https://quay.io/). For more information, see [How to configure private Alfresco Docker registry](enterprise-docker-registry.md).
In order to properly configure ATS in a project generated using the Alfresco SDK archetypes it is required to execute 2 steps:
1. Add the containers that conform ATS to the Docker compose file.

20
docs/enterprise-docker-registry.md Normal file
View File

@@ -0,0 +1,20 @@
---
Title: How to configure private Alfresco Docker registry
Added: v3.0.0
Last reviewed: 2019-01-15
---
# How to configure private Alfresco Docker registry
In order to download the Docker images needed to work with Alfresco Enterprise Edition it is required to configure the Alfresco private Docker registry
hosted at [Quay.io](https://quay.io/).
The first matter to consider is to ensure that you have credentials for the Alfresco private Docker registry, where the Alfresco images are stored. You can
request these credentials opening a ticket on the [Alfresco Support Portal](http://support.alfresco.com).
Once you have suitable credentials, you only need to login your docker installation to the Quay.io Docker registry:
```
$ docker login quay.io
```
At this point you have configured Docker to have access to the Alfresco private Docker registry at [Quay.io](https://quay.io/).

31
docs/enterprise-mvn-repo.md Normal file
View File

@@ -0,0 +1,31 @@
---
Title: How to configure private Alfresco Nexus repository
Added: v3.0.0
Last reviewed: 2019-01-15
---
# How to configure private Alfresco Nexus repository
The first matter to consider is to ensure that you have credentials for the Alfresco Private Repository, where the Alfresco artifacts are stored. You can
request these credentials opening a ticket on the [Alfresco Support Portal](http://support.alfresco.com).
Once you have suitable credentials, you need to add support for Alfresco private Maven repository to your configuration. This would typically be done by
adding your access credentials to the `settings.xml` contained in your `~/.m2` directory (for Linux and OS X). On Windows this resolves to
`C:\Users\<username>\.m2`.
To do this, load `settings.xml` into your editor and add the following new server configuration in the `<servers>` section:
```
<server>
<id>alfresco-private-repository</id>
<username>username</username>
<password>password</password>
</server>
```
You will need to replace the placeholder text with your real username and password as allocated by Alfresco. The id value should not be changed as it
is used in the Alfresco SDK project build files to specify the Enterprise artifacts Maven repository.
It is possible to use encrypted passwords here. See the [official Maven documentation](http://maven.apache.org/guides/mini/guide-encryption.html) for details
on how to do this.
At this point you have configured Maven to have access to the Alfresco Private Repository.

74
docs/enterprise.md Normal file
View File

@@ -0,0 +1,74 @@
---
Title: Working with Enterprise
Added: v3.0.0
Last reviewed: 2019-01-15
---
# Working with Enterprise
By default the Alfresco SDK will use Community Edition releases but it can be configured to use Enterprise Edition releases. Here you will learn how to
set up a project to work with an Enterprise Edition release, highlighting the changes required to make it work.
If you would like to work with the Alfresco Enterprise Edition, then this requires just a few property changes and a license installation. You also need
to have access to the private Alfresco Nexus repository and the private Alfresco Quay.io Docker registry. See:
* [How to configure private Alfresco Nexus repository](enterprise-mvn-repo.md).
* [How to configure private Alfresco Docker registry](enterprise-docker-registry.md).
## Installing the license
The very first task to complete is about installing an enterprise license, otherwise the server will remain in read-only mode. This task is required if and
only if you used the All-In-One archetype or the Platform JAR archetype to generate your project. If you used the Share JAR archetype to generate your project,
feel free to ignore this task and move on the next one.
If you are an Alfresco Partner or Customer, you can request an enterprise license by you opening a ticket on the [Alfresco Support Portal](http://support.alfresco.com).
The Enterprise license is nothing more and nothing less than a file with `lic` extension. The Enterprise license file goes into `src/main/docker/license`
folder (this folder will be located under the platform JAR submodule if you're using the All-In-One archetype). The license will be copied into the ACS Docker
container before it is started. The license file name doesn't matter, but make sure that you keep it simple and maintain the `lic` extension.
## Configuring the Enterprise release
The configuration of the Enterprise version is straightforward when using the `pom.xml` configuration file stored in the root folder of your project.
You'll need to update the following settings in the `pom.xml` file:
* Change the _bill of materials_ (BOM) dependency name:
```
<alfresco.bomDependencyArtifactId>acs-packaging</alfresco.bomDependencyArtifactId>
```
* Change the Docker ACS image name:
```
<docker.acs.image>alfresco/alfresco-content-repository</docker.acs.image>
```
Changing these parameters instructs the project to use the proper maven dependencies and Docker images.
Depending on the needs of your project, it will probably be necessary to change the `org.alfresco:alfresco-remote-api` dependency to
`org.alfresco:alfresco-enterprise-remote-api` or adding any other enterprise dependency like `org.alfresco:alfresco-enterprise-repository`. In any case,
it won't be necessary to include the version of any of these dependencies due to the addition of the BOM dependency in the `dependencyManagement`
section of the parent `pom.xml` file.
## Configuring the Enterprise version
The configuration of the Enterprise version is straightforward when using the `pom.xml` configuration file stored in the root folder of your project.
You'll need to update the following settings in the `pom.xml` file:
```
<alfresco.platform.version>6.0.0.2</alfresco.platform.version>
<alfresco.share.version>6.0</alfresco.share.version>
```
Making use of the Alfresco SDK 4.0 it is no longer required the configuration of the Alfresco Surf versions. The inclusion of the BOM and the custom Docker
images will take care of that task automatically for you.
## Purging the project data and running the project
Once all the previous configuration is done, you only need to purge any possible old data (persistent data from the Docker containers), rebuild and restart
the project.
```
$ ./run.sh purge
$ ./run.sh build_start
```
If you're using Windows, you'll need to use the `run.bat` script instead of `run.sh`.