Skip to content

Commit

Permalink
add docs
Browse files Browse the repository at this point in the history
  • Loading branch information
pmacius committed Sep 18, 2024
1 parent ba80f4d commit 048fe8c
Show file tree
Hide file tree
Showing 3 changed files with 87 additions and 0 deletions.
62 changes: 62 additions & 0 deletions share/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
# Alfresco share image

## Description

This Docker file is used to build an Alfresco share image.

## Building the image

Make sure all required artifacts are present in the build context `share/`.
You can put them manually in the `share/` folder (for example if that's a
custom module of yours), or use the script `./scripts/fetch-artifacts.sh` to
download them from Alfresco's Nexus.

Then, you can build the image from the root of this git repository with the
following command:

```bash
docker buildx bake share
```

## Running the image

### Alfresco share configuration

All preperties you would normally add in the alfresco-global.properties file can
be added in the `JAVA_OPTS` environment variable to the container.

For example, to set the database URL, you can use the following environment
variable:

```bash
docker run -e JAVA_OPTS="-Dalfresco.host=localhost" \
alfresco-share:mytag
```

Example set of variables for docker-compose file:

```yaml

alfresco-connector-ms365:
image: localhost/alfresco-share:YOUR-TAG
environment:
JAVA_OPTS: ""
REPO_HOST: alfresco
REPO_PORT: 8080
CSRF_FILTER_REFERER:
CSRF_FILTER_ORIGIN:
USE_SSL: false

```

- `JAVA_OPTS` - A set of properties that are picked up by the JVM inside the container
- `REPO_HOST` - Share needs to know how to register itself with Alfresco. The default value is `localhost`
- `REPO_PORT` - Share needs to know how to register itself with Alfresco. The default value is `8080`
- `CSRF_FILTER_REFERER` - CSRF Referrer
- `CSRF_FILTER_ORIGIN` - CSRF Origin
- `USE_SSL` - Enables ssl use if set to `true`. The default value is `false`


> If the image is meant to be used with the Alfresco Content Services Helm
> chart, you can use other [higher level means of
> configuration](https://github.com/Alfresco/alfresco-helm-charts/blob/main/charts/alfresco-share/README.md).
24 changes: 24 additions & 0 deletions share/amps/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Alfresco share AMPs

Place here your Alfresco module Packages (AMPs) to be installed in the Alfresco
share.

AMP packages should have the `.amp` extension and stick to the Alfresco module
packaging format as described in the [Alfresco
documentation](https://docs.alfresco.com/content-services/latest/develop/extension-packaging/#alfresco-module-package-amp).

The [in-process Alfresco
SDK](https://docs.alfresco.com/content-services/latest/develop/sdk/) provides a
way to build well structured AMPs.

> Note that AMPs are not the recommanded way to extend Alfresco. You should
> prefer using the Alfresco SDK to build your extensions as JARs even better,
> use the [out-of-process Alfresco
> SDK](https://docs.alfresco.com/content-services/latest/develop/oop-sdk/) to
> build Docker images with your extensions.
By default the `scripts/fetch-artifacts.sh` script will fetch the following AMPs from the Alfresco Nexus repository:

* alfresco-googledrive-share

You can replace those, remove them to keep only the ones you need or add more.
1 change: 1 addition & 0 deletions share/distribution/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,4 @@ web-server/
|_Catalina/
|_localhost/
```
Do changes to `share-config-custom.xml` according to your needs.

0 comments on commit 048fe8c

Please sign in to comment.