Installation (#988)

* removing outdated 1.0 migration scripts * Rename scripts to not imply WF11 support only * Remove H2 deployments, those are now in docker * standalone-ha was never supported * Rename mysql script * Adding standalone KC file * Some installation docs
aerogear · Apr 18, 2018 · 0287188 · 0287188
1 parent 9e6e9da
commit 0287188
Show file tree

Hide file tree

Showing 15 changed files with 103 additions and 230 deletions.
diff --git a/databases/README.md b/databases/README.md
@@ -0,0 +1,84 @@
+# Install the UPS with a RDBMS
+
+This guide explains how to configure a fresh WildFly instance and setup the database
+
+__Perquisite:__ Make sure you have the latest version of [WildFly](http://wildfly.org/downloads/), extracted on your machine.
+
+## Database configuration
+
+The UPS does support two database system:
+
+* Postgres (preferred)
+* MySQL
+
+### Postgres
+
+You need a running database, like:
+
+```
+docker run \
+           -p 5432:5432 \
+           -e POSTGRES_PASSWORD=unifiedpush \
+           -e POSTGRES_USER=unifiedpush \
+           -e POSTGRES_DATABASE=unifiedpush \
+           -d postgres:9.6
+```
+
+### MySQL 
+
+You need a running database, like:
+
+```
+docker run \
+           -p 6306:3306 \
+           -e MYSQL_USER=unifiedpush \
+           -e MYSQL_PASSWORD=unifiedpush \
+           -e MYSQL_DATABASE=unifiedpush \
+           -e MYSQL_ROOT_PASSWORD=supersecret \
+           -d mysql:5.6
+```
+
+## Prepare the Wildfly server for UPS deployment
+
+Go to your Wildfly installation and start the server, using the `standalone-full` configuration, like:
+
+```
+$WILDFLY_HOME/bin/standalone.sh -c standalone-full.xml -b 0.0.0.0
+```
+
+__NOTE:__ make sure you have the installation folder of Wildfly exported to `$WILDFLY_HOME`.
+
+We have two shell scripts for setting up the system:
+
+* `prepare_clean_psql_wildfly.sh`
+* `prepare_clean_mysql_wildfly.sh`
+
+Based on your database choice execute one of the scripts, like:
+
+```
+./prepare_clean_psql_wildfly.sh
+```
+
+## UPS deployment
+
+Now the server is running and you can deploy the `WAR` file from the `servers/plain/target` folder.
+This is an unprotected version of the push server.
+
+
+## UPS and Keycloak
+
+We have a Keycloak protected version of the UPS (located in `servers/keycloak/target`), which requires a separated Keycloak server.
+
+For Keycloak we need to provide two `System Properties`:
+* `ups.realm.name` - name of the realm used for UPS
+* `ups.auth.server.url` - fullqualified URI of the Keycloak server
+
+Here is how the command looks like:
+
+```
+$WILDFLY_HOME/bin/standalone.sh -c standalone-full.xml -Dups.realm.name=aerogear -Dups.auth.server.url=http://my-keycloak:PORT/auth -b 0.0.0.0
+```
+
+### Running Keycloak
+
+In the [docker-compose](../docker-compose) folder there is a *Standalone Keycloak* section that explains details on how to run a Keycloak server.
diff --git a/databases/h2-database-config-wildfly.cli b/databases/h2-database-config-wildfly.cli
diff --git a/databases/ha_deployment/deploy-managed-domain.cli b/databases/ha_deployment/deploy-managed-domain.cli
diff --git a/databases/ha_deployment/mysql-database-config-wildfly-full-ha.cli b/databases/ha_deployment/mysql-database-config-wildfly-full-ha.cli
diff --git a/databases/ha_deployment/mysql-database-config-wildfly-managed-domain.cli b/databases/ha_deployment/mysql-database-config-wildfly-managed-domain.cli
diff --git a/databases/migration/README.md b/databases/migration/README.md
diff --git a/databases/migration/keycloak-migration-mysql.sql b/databases/migration/keycloak-migration-mysql.sql
diff --git a/databases/migration/keycloak-migration-postgresql.sql b/databases/migration/keycloak-migration-postgresql.sql
diff --git a/databases/migration/ups-migration-mysql.sql b/databases/migration/ups-migration-mysql.sql
diff --git a/databases/migration/ups-migration-postgresql.sql b/databases/migration/ups-migration-postgresql.sql
diff --git a/databases/prepare_clean_wf11.sh → databases/prepare_clean_mysql_wildfly.sh b/databases/prepare_clean_wf11.sh → databases/prepare_clean_mysql_wildfly.sh
diff --git a/databases/prepare_clean_psql_wf11.sh → databases/prepare_clean_psql_wildfly.sh b/databases/prepare_clean_psql_wf11.sh → databases/prepare_clean_psql_wildfly.sh
diff --git a/databases/unifiedpush-h2-ds.xml b/databases/unifiedpush-h2-ds.xml
diff --git a/docker-compose/README.md b/docker-compose/README.md
@@ -43,3 +43,11 @@ docker run -p 8080:8080 -it aerogear/ups:kc
 ```
 
 This brings up both, Keycloak and the UPS containers. Now, go to `http://localhost:8080/` to login to the UPS!
+
+### Standalone Keycloak 
+
+It might be handy to just run Keycloak in a Linux container, like: 
+
+```
+docker-compose -f keycloak-standalone.yaml up -d
+```
diff --git a/docker-compose/keycloak-standalone.yaml b/docker-compose/keycloak-standalone.yaml
@@ -0,0 +1,11 @@
+version: '2.1'
+
+services:
+  keycloakServer:
+    image: docker.io/jboss/keycloak:3.4.3.Final
+    command: "-b 0.0.0.0 -Dkeycloak.import=/ups-keycloak-config/ups-realm-sample.json"
+    volumes:
+      - ./keycloak-realm:/ups-keycloak-config:z
+    environment:
+      KEYCLOAK_USER: ${KEYCLOAK_USER}
+      KEYCLOAK_PASSWORD: ${KEYCLOAK_PASSWORD}