Browse Source

update reamde

Amolkirat Singh Mangat 4 years ago
parent
commit
c6969dacfa
1 changed files with 14 additions and 5 deletions
  1. 14 5
      README.md

+ 14 - 5
README.md

@@ -1,14 +1,23 @@
 # cpee-docker
 
-CPEE Dockerfiles for a local installation.
+CPEE local installation via Docker.
 
-Requirements: Docker and Docker Compose
+*Requirements:* Docker and Docker Compose
 
-Download this project (zip or clone) and change into the root dir. 
+Steps:
+- Download this project (zip or clone) and change into the project root dir. 
 
-Run `docker-compose up` in a terminal of your choice (Windows: Powershell, Command Prompt; MacOS: Terminal)
+- Run `docker-compose up` in a terminal of your choice (Windows: Powershell, Command Prompt; MacOS: Terminal)
 
-Now, in your browser, go to `http://localhost:9090/cpee-cockpit/` and have fun!
+
+
+- Now, in your browser, go to `http://localhost:9090/cpee-cockpit/` and have fun!
+
+Notes:
+
+- If you make changes to the `Dockerfile` make sure to run `docker-compose build` to apply new changes.
+
+- You can code and run your endpoints (services) on your host system and access them via cpee from the `localhost` address, as the cpee container directly forwards requests to the localhost. You can undo this in the `docker-compose` file under `network`.