Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Alfredapi 541/installdeps #199

Merged
merged 4 commits into from
Feb 21, 2024
Merged

Alfredapi 541/installdeps #199

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
87235c7
ALFREDAPI-541: Format swagger.json
WimCrols Feb 21, 2024
d8b8943
ALFREDAPI-541: Update swagger.json version to 5.0.0
WimCrols Feb 21, 2024
2b0cbfe
ALFREDAPI-541: Add install instructions for alfresco-mvc
WimCrols Feb 21, 2024
89126c4
ALFREDAPI-541: Update Changelog
WimCrols Feb 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ The artifact name of `apix-interface` has been changed to `alfred-api-interface`
* [ALFREDAPI-537](https://xenitsupport.jira.com/browse/ALFREDAPI-537): Fix conflicts between artifacts when publishing to Sonatype
* [ALFREDAPI-538](https://xenitsupport.jira.com/browse/ALFREDAPI-538): Fixed issue where errors related to jackson library conflicts would occurs while Alfresco is running
* [ALFREDAPI-540](https://xenitsupport.jira.com/browse/ALFREDAPI-540): Realign interface artifact name
* [ALFREDAPI-541](https://xenitsupport.jira.com/browse/ALFREDAPI-541): Clarify dependency installation instructions

### Removed

Expand Down
4,219 changes: 4,218 additions & 1 deletion docs/swagger-ui/swagger.json
View file
Open in desktop

Large diffs are not rendered by default.

33 changes: 31 additions & 2 deletions docs/user/user-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -742,9 +742,38 @@ Currently Alfred API supports the following Alfresco versions:
* 7.3
* 7.4

Note that previous versions of Alfred API needed
Alfred API depends on the [Alfresco MVC framework](https://github.com/dgradecak/alfresco-mvc) version `8.0.0`.
Installation depends on the tools that you use to build and install, but below are examples of a few common ways.
Further details can be found on its [README](https://github.com/dgradecak/alfresco-mvc/blob/master/README.md).

(Note that previous versions of Alfred API needed
[Dynamic Extensions For Alfresco](https://github.com/xenit-eu/dynamic-extensions-for-alfresco).
Since version 5.0.0, however, Dynamic Extensions is no longer needed.
Since version 5.0.0, however, Dynamic Extensions is no longer needed.)


### Install with Gradle

An example when using Gradle and the
[Alfresco Docker Gradle plugin](https://github.com/xenit-eu/alfresco-docker-gradle-plugin/blob/master/docs/02-plugin-docker-alfresco.md)
is:
```groovy
alfrescoSM group: 'com.gradecak.alfresco-mvc', name: 'alfresco-mvc-rest', version: '8.0.0'
alfrescoSM group: 'com.gradecak.alfresco-mvc', name: 'alfresco-mvc-aop', version: '8.0.0'
alfrescoAmp group: 'eu.xenit.alfred.api', name: 'alfred-api-74', version: '5.0.0'
```
Note above example also installs Alfred API as AMP.

### Install manually

If you install your Alfresco manually, you can download the JARs directly from
[Maven Central](https://search.maven.org/search?q=g:com.gradecak.alfresco-mvc)
and place them on your Tomcat's classpath.

```bash
cp alfresco-mvc-aop-8.0.0.jar /usr/local/tomcat/shared/lib/
cp alfresco-mvc-rest-8.0.0.jar /usr/local/tomcat/shared/lib/
```


## Artifacts
### Prebuilt
Expand Down
Loading