REPO-3061: REPO-3100: Update README.MD in the full-community-packaging project

This commit is contained in:
Andrei Rebegea
2017-12-11 12:45:11 +02:00
parent 5820c74317
commit 9c5c14bc93

60
README.md Normal file
View File

@@ -0,0 +1,60 @@
# Full Community Packaging for Alfreco Content Services
This project contains the code for packaging the entire Alfresco Content Services product Community edition.
## General
### Build:
* ```mvn clean install``` in the root of the project will build everything.
Note: It is not easy to build the full installer locally (and impossible on Windows) so, most likely you don't want to create the installer locally. Comment out the <module>installer</module> in the root pom.xml in order to avoid building the installer locally.
## Docker-compose
Build and start Alfresco Content Services Community using docker-compose, containing:
1. Alfresco Repository for community, with:
1.1. Alfresco Share Services amp
1.2. Alfresco AOS amp
1.3. Alfresco vti-bin war - that helps with AOS integration
1.4. Alfresco Google Docs Repo amp
2. Share, with:
2.1 Alfresco Google Docks Share amp
3. A Postgres DB
4. Solr6
### Instructions:
#### Prerequisite:
* Docker installed locally
* Access to docker-internal.alfresco.com and quiy.io repositories - Platform Services team is working on getting the images in dockerhub registry.
#### Steps
1. Go to **docker-compose** folder
2. Run ```docker-compose up```
3. Check that everything starts up with the browser: http://localhost:8082/alfresco and http://localhost:8080/share and http://localhost:8083/solr/
#### Notes:
* Make sure the local machine has the ports (5432, 8080, 8082, 8083) set up in the docker-compose.yml file free.
* The images used in the docker-compose.yml are images that are build in the 'docker-alfresco' and 'docker-share' subfolders of the project - see the relevant sections below
* If you don't have access to the docker-internal.alfresco.com and quay.io images , or if you want custom data in your docker images, you can use the 'docker-alfresco' and 'docker-share' folders to customize and build your customized docker images that are used in the docker-compose project. Just make sure you use proper tags when you create the images and update the docker-compose.yml with these proper tags that you created.
## Docker images
These images are used to build the images used by the docker-compose.yml project to bring up an ACS Community, similar to what the installer did/does.
The images are based on *pure* _content services_ and _share_ images done by the _acs-packaging_ and _share_ projects and adds the amps and settings necessary for running the images in a similar fashion to what the ACS deployment with the installer did/does.
### Docker Alfresco
1. Go to docker-alfreco folder
2. Run *mvn clean install* if you have not done so
3. Build the docker image: ```docker build . --tag my-acs-repo:6.0.test```
4. Check that the image has been created locally with your desired name/tag: ```docker images```
### Docker Share
1. Go to docker-share folder
2. Run *mvn clean install* if you have not done so
3. Build the docker image: ```docker build . --tag my-share:5.2.test```
4. Check that the image has been created locally with your desired name/tag: ```docker images```
## Distribution zip
In this folder the distribution zip is build. It contains all the war files, libraries, certificates and settings files you need to deploy alfresco on the supported application servers.
## Installer
In this folder the installer binaries are built for all the supported platforms.