Skip to content

armgit / core

Public Imported from GitHub
0

100% open-source IoT Platform - Integrate your devices, add intelligence, build custom apps

Updated README.md

Rich Turnerbd2b49578715
diff --git a/README.md b/README.md
index b077e2459..248d811aa 100644
--- a/README.md
+++ b/README.md
@@ -2,92 +2,51 @@
[Source](https://github.com/openremote/openremote) **·** [Documentation](https://github.com/openremote/openremote/wiki) **·** [Community](https://groups.google.com/forum/#!forum/openremotecommunity) **·** [Issues](https://github.com/openremote/openremote/issues) **·** [Docker Images](https://hub.docker.com/u/openremote/) **·** [OpenRemote Inc.](https://openremote.io)
-## Getting started with OpenRemote
-
We are currently working on v3 of the OpenRemote platform. This is **beta** software that should be used only for development.
If you want to try OpenRemote v2, [read the OpenRemote v2 documentation](https://github.com/openremote/Documentation/wiki).
-## Contributing to OpenRemote
-
-We work with Java, Groovy, JavaScript, Gradle, Docker, and a wide range of APIs and protocol implementations. Clone or checkout this project and send us pull requests.
-
-First, checkout this project or at a minimum, get the Docker Compose [profiles](profile/).
+## Quickstart
-You'll need [Docker Community Edition](https://www.docker.com/) for Windows, macOS, or Linux.
+Checkout this project or at a minimum, get the Docker Compose [profiles](profile/) and ensure you have [Docker Community Edition](https://www.docker.com/) installed, then either use images from docker hub (easiest) or build the images locally first.
-Also see our [developer guide](https://github.com/openremote/openremote/wiki) for more details.
-
-### Starting a demo stack
-
-A demo stack can be started with downloaded dependencies and images (you only have to get the [profiles](profile/)):
+### Use images from Docker Hub
+We publish our docker images to [Docker Hub](https://hub.docker.com/u/openremote/), please be aware that the published images may be out of date compared to the codebase, if you want to run the latest code then you may need to build the images first. To run a demo using Docker Hub images simply run the following command from the repo root (or directory containing the `profile` directory if you only downloaded the profiles):
```
docker-compose -p openremote -f profile/demo.yml up --no-build
```
-Access the manager UI and API on https://localhost/ with username `admin` and password `secret`. Accept the 'insecure' self-signed SSL certificate.
-
-The console app of `customerA` can be accessed on https://localhost/console/customerA/ with username `testuser3` and password `testuser3`.
-
-Stop the stack and remove all unused data volumes (on your host!) with:
+### Build images locally
+Alternatively you can build the docker images locally, to do this please refer to the [Developer Guide](https://github.com/openremote/openremote/wiki/Developer-Guide%3A-Building-the-code) to build the code, once the code is built
```
-docker-compose -p openremote -f profile/demo.yml down
-docker volume prune
-```
-
-More configuration options of the images are documented [in the deploy.yml profile](https://github.com/openremote/openremote/blob/master/profile/deploy.yml).
-
-### Preserving demo data
-
-To keep your data, don't delete the Docker volumes `openremote_manger-data` and `openremote_postgresql-data` between restarts. You must also change `SETUP_WIPE_CLEAN_INSTALL` to `false` in `demo.yml`!
-
-### Building images from source
-
-If you want to build the images instead of downloading them, execute (ensure you have required dev dependencies installed as described in the [developer guide](https://github.com/openremote/openremote/wiki)):
-
-```
-./gradlew clean installDist
docker-compose -p openremote -f profile/demo.yml up --build
```
-### Using `dev` profiles
+Once you have running docker containers you can Access the manager UI and API on https://localhost/ with username `admin` and password `secret`. Accept the 'insecure' self-signed SSL certificate.
+
+The console app of `customerA` can be accessed on https://localhost/customerA/ with username `testuser3` and password `testuser3`.
-Also consider using the `dev` profiles if you want to change code, they will run required services in the background for various development/build tasks. The whole stack in development mode can be started with:
+Stop the stack and remove all unused data volumes (alternatively delete only the openremote volumes if you don't want all unused volumes to be removed) with:
```
-./gradlew clean installDist
-docker-compose -p openremote -f profile/dev.yml up --build
+docker-compose -p openremote -f profile/demo.yml down
+docker volume prune
```
-### Committing changes
+To preserve data between restarts, don't delete the Docker volumes `openremote_deployment-data` and `openremote_postgresql-data` between restarts. You must also change `SETUP_WIPE_CLEAN_INSTALL` to `false` in `demo.yml`!
-Perform a clean build, delete all data volumes (!), and run all tests before committing:
+More configuration options of the images are documented [in the deploy.yml profile](https://github.com/openremote/openremote/blob/master/profile/deploy.yml).
-```
-docker volume prune
-docker-compose -p openremote -f profile/dev-testing.yml up -d
-./gradlew clean build installDist
-docker-compose -p openremote -f profile/dev-testing.yml down
-docker build -t openremote/proxy:latest haproxy
-docker build -t openremote/postgresql:latest postgresql
-docker build -t openremote/keycloak:latest keycloak
-docker build -t openremote/manager:latest manager/build/install/manager
-```
-Push images to [Docker Hub](https://hub.docker.com/u/openremote):
+## Contributing to OpenRemote
-```
-docker login
-docker push openremote/proxy:latest
-docker push openremote/postgresql:latest
-docker push openremote/keycloak:latest
-docker push openremote/manager:latest
-```
+We work with Java, Groovy, JavaScript, Gradle, Docker, and a wide range of APIs and protocol implementations. Clone or checkout this project and send us pull requests, ensure that code is covered by tests and that the full test suite passes.
For more information and how to set up a development environment, see the [Developer Guide](https://github.com/openremote/openremote/wiki).
+
## Discuss OpenRemote
Join us on the [community group](https://groups.google.com/forum/#!forum/openremotecommunity).
diff --git a/container/src/main/java/org/openremote/container/security/CORSFilter.java b/container/src/main/java/org/openremote/container/security/CORSFilter.java
index cf44699b5..65dea1272 100644
--- a/container/src/main/java/org/openremote/container/security/CORSFilter.java
+++ b/container/src/main/java/org/openremote/container/security/CORSFilter.java
@@ -10,7 +10,6 @@ import javax.servlet.FilterConfig;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
-import javax.servlet.http.HttpServletResponseWrapper;
import javax.servlet.http.HttpSession;
import javax.ws.rs.HttpMethod;
import java.io.IOException;
diff --git a/manager/src/main/java/org/openremote/manager/system/HealthStatusService.java b/manager/src/main/java/org/openremote/manager/system/HealthStatusService.java
index 33d63c46c..b67d093d5 100644
--- a/manager/src/main/java/org/openremote/manager/system/HealthStatusService.java
+++ b/manager/src/main/java/org/openremote/manager/system/HealthStatusService.java
@@ -21,7 +21,6 @@ package org.openremote.manager.system;
import org.openremote.container.Container;
import org.openremote.container.ContainerService;
-import org.openremote.container.web.WebService;
import org.openremote.manager.web.ManagerWebService;
import org.openremote.model.system.HealthStatusProvider;
import org.openremote.model.system.StatusResource;
@@ -54,7 +53,7 @@ public class HealthStatusService implements ContainerService {
}
container.getService(ManagerWebService.class).getApiSingletons().add(
- new StatusResourceImpl(healthStatusProviderList)
+ new StatusResourceImpl(healthStatusProviderList)
);
}
@@ -64,7 +63,8 @@ public class HealthStatusService implements ContainerService {
if (healthStatusProvider instanceof ContainerService) {
((ContainerService) healthStatusProvider).start(container);
}
- } }
+ }
+ }
@Override
public void stop(Container container) throws Exception {