README.md

README.md

@@ -1,7 +1,8 @@
 # Keycloak Mailchimp
 
-
 ## Manual config
+A. First way
+
 1. Add this inside the Keycloak `standalone*.xml` you're using:
     ```xml
     <spi name="eventsListener">
@@ -18,10 +19,77 @@
 
 3. Then start.
 
-## Auto config
+B. Second way
+
 1. Run this script `startup.cli`. When doing this, replace `SOME_API_KEY` and `SOME_LIST_ID`
-by your own data.
+   by your own data.
 
 2. Now, add `target/*.jar` files into `providers` folder of your keycloak.
 
 3. Then start.
+
+## Auto config
+
+### Docker
+
+Simply use this preconfigured [docker-compose.yml](./docker-compose.yml), which will use the [Dockerfile](./Dockerfile).
+You need to provide `MAILCHIMP_API_KEY` and `MAILCHIMP_LIST_ID` as environment variable.
+
+1. docker-compose.yml: An example is the following
+```yaml
+version: "3.8"
+
+services:
+
+  keycloak:
+    build: .
+    ports:
+      - 8080:8080
+    environment:
+      KEYCLOAK_USER: admin
+      KEYCLOAK_PASSWORD: password
+      MAILCHIMP_API_KEY: one
+      MAILCHIMP_LIST_ID: two
+```
+
+Here you could simply build using
+```bash
+docker-compose build
+```
+
+and then launch using
+```
+docker-compose up -d
+```
+
+2. Dockerfile: Dockerfile
+
+- First build
+   ```bash
+   docker build -t bayamsell/mailchimp .
+   ```
+- Then run
+   ```bash
+  docker run --rm -e MAILCHIMP_API_KEY=one -e MAILCHIMP_LIST_ID=two -p 8080:8080 bayamsell/mailchimp
+   ```
+
+### Scripts
+
+If your configuration is better adapted to `scripts`, take a look at
+[startup.cli](./startup.cli) and [startup.sh](./startup.sh).
+To use the fist file, you'll need to update the values
+`SOME_API_KEY` and `SOME_LIST_ID` corresponding to `API_KEY` and `LIST_ID`
+
+```bash
+/subsystem=keycloak-server/spi=eventsListener/provider=mailchimp:write-attribute(name=properties.API_KEY,value="SOME_API_KEY")
+/subsystem=keycloak-server/spi=eventsListener/provider=mailchimp:write-attribute(name=properties.LIST_ID,value="SOME_LIST_ID")
+```
+
+## Links
+
+- https://access.redhat.com/documentation/en-us/red_hat_jboss_enterprise_application_platform/7.0/html/management_cli_guide/running_embedded_server
+- https://stackoverflow.com/a/58144078/7748446
+- https://askubuntu.com/a/229592/771659
+- https://docs.wildfly.org/18/Admin_Guide.html
+- https://www.keycloak.org/docs/latest/server_installation/#cli-scripting
+- https://stackoverflow.com/a/23702185/7748446