Improve docker-compose deployment & documentation

[portal/nonrtric-controlpanel.git] / docker-compose / README.md

diff --git a/docker-compose/README.md b/docker-compose/README.md
index 6a66c0e..d7542a8 100644 (file)
--- a/docker-compose/README.md
+++ b/docker-compose/README.md
@@ -1,4 +1,5 @@
-## License
+# License
+
 Copyright (C) 2020 Nordix Foundation.
 Licensed under the Apache License, Version 2.0 (the "License")
 you may not use this file except in compliance with the License.
@@ -14,11 +15,21 @@ limitations under the License.
 
 For more information about license please see the [LICENSE](LICENSE.txt) file for details.
 
-## O-RAN-SC docker-compose files:
+## O-RAN-SC docker-compose files
+
 The docker compose file helps the user to deploy the components of nonrtric control panel with one command.
 
+NOTE:
+docker image urls & tags are in file ```.env```
+
 To install the Control Panel and gateway, run the following command:
-docker-compose -f docker-compose.yaml -f control-panel/docker-compose.yaml -f nonrtric-gateway/docker-compose.yaml up -d
+
+```shell
+docker-compose --env-file .env -f docker-compose.yaml -f control-panel/docker-compose.yaml -f nonrtric-gateway/docker-compose.yaml up -d
+```
 
 To remove the containers, use the command:
-docker-compose -f docker-compose.yaml -f control-panel/docker-compose.yaml -f nonrtric-gateway/docker-compose.yaml down
+
+```shell
+docker-compose --env-file .env -f docker-compose.yaml -f control-panel/docker-compose.yaml -f nonrtric-gateway/docker-compose.yaml down
+```