ExternalVendorCode/OpenMTC
1
0
Fork 0
mirror of https://github.com/OpenMTC/OpenMTC.git synced 2025-01-18 18:46:26 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

minor fixes for documentation

Browse Source
This commit is contained in:
Ronald Steinke 2018-01-10 10:03:43 +01:00
parent ffab3c44e5
commit 2b2a6c1022
2 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/deployment-guide.md
View File

@ -14,7 +14,7 @@ components with:
## How to setup a development environment using Docker? ## How to setup a development environment using Docker?
*Note:* If you do not have a running docker setup, we provide a [docker installation *Note:* If you do not have a running docker setup, we provide a [docker installation
guide](./various.md). Alternativly you can use the [offical docker guide](./various.md). Alternatively you can use the [official docker
documentation](https://docs.docker.com/engine/installation/linux/docker-ce/ubuntu/). documentation](https://docs.docker.com/engine/installation/linux/docker-ce/ubuntu/).
For this scenario, be sure to build Docker container images for following OpenMTC components: For this scenario, be sure to build Docker container images for following OpenMTC components:
@ -32,7 +32,7 @@ prepared in a directory named:
OpenMTC OpenMTC
``` ```
OpenMTC container images will be created through a hiearchy of OpenMTC container images will be created through a hierarchy of
dependent images. For example when creating image 'sdk', a dependent dependent images. For example when creating image 'sdk', a dependent
'base' image will be created. After completing the build process for 'base' image will be created. After completing the build process for
each Docker image, the image is to be found in the machine's local each Docker image, the image is to be found in the machine's local
@ -88,7 +88,7 @@ TODO
**Disclaimer:** *Docker provides commands like export/import and **Disclaimer:** *Docker provides commands like export/import and
save/load. Sadly, it is easy to get confused here. The command save/load. Sadly, it is easy to get confused here. The command
`save` is used to export a Docker image, while the command `load` is `save` is used to export a Docker image, while the command `load` is
used to import this Docker image. Whereas, the coammds export/import used to import this Docker image. Whereas, the commands export/import
are to container instances.* are to container instances.*
Assuming that the Docker images for OpenMTC Gateway and Backend are Assuming that the Docker images for OpenMTC Gateway and Backend are
@ -201,5 +201,5 @@ docker run -d --name gateway -p 0.0.0.0:8000:8000 -e "EXTERNAL_IP=<EXTERNAL_IP
- `<POA>` : An URL that describes the POA fo Backend (e.g. "http://localhost:18000") - `<POA>` : An URL that describes the POA fo Backend (e.g. "http://localhost:18000")
- If you need to know more about detail of `-d` (detach) and the port - If you need to know more about detail of `-d` (detach) and the port
mapping configuration `-p 0.0.0.0:8000:8000`, check out the mapping configuration `-p 0.0.0.0:8000:8000`, check out the
[documenation as provided by Docker](https://docs.docker.com/engine/reference/run/). [documentation as provided by Docker](https://docs.docker.com/engine/reference/run/).

8
doc/reference-doc/gateway-and-backend-configuration.md
View File

@ -106,9 +106,9 @@ TODO: Description
"name": "AnnouncementHandler", "name": "AnnouncementHandler",
"package": "openmtc_cse.plugins.announcement_handler", "package": "openmtc_cse.plugins.announcement_handler",
"disabled": true, "disabled": true,
"config": { "config": {
"auto_announce": false "auto_announce": false
} }
} }
``` ```
@ -213,7 +213,7 @@ Furthermore, a remote CSE resource which contains information about the backend
], ],
"poa": [ "poa": [
"http://localhost:18000" "http://localhost:18000"
], ]
} }
], ],
"interval": 3600, "interval": 3600,