-
Notifications
You must be signed in to change notification settings - Fork 21
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update readme.md file. #71
base: develop
Are you sure you want to change the base?
Conversation
|
||
# SSH into the container as the user 'volttron' | ||
$ docker exec -itu volttron volttron1 bash | ||
$> docker exec -itu volttron volttron1 bash |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add instructions as for running volttron commands (say vctl status) from within the container's bash shell
|
||
# Create and start the container that has runs Volttron | ||
$ docker-compose up | ||
$> docker-compose up |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could we add a note saying this should not be repeated once the container is created successfully. As currently setup-platform.py doesn't handle already existing config and hence fails with error. i.e. docker stop and start only after 'docker up' creates the container
git clone https://github.com/VOLTTRON/volttron-docker | ||
cd volttron-docker | ||
|
||
# initialize submodules |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If the default behavior should be to pull volttron image from docker hub, do we need "git submodule" or "docker build" commands?
If so, that should be updated in README, docker-compose.yml should be updated to point to right docker hub image and latest version. And note should be provided for user that docker-compose.yml can be updated to point to different tag if they want to pull a diffferent version.
Provide link to docker image in docker hub
Building locally should probably under development heading.
Also we should mention that docker-compose.yml need to be updated to correct port mapping - if 8443 is already mapped to something else. Or at least mention it in Troubleshooting
``` | ||
|
||
For Volttron instances using ZMQ message bus: | ||
|
||
* Set the master username and password on the Volttron Central Admin page at `https://0.0.0.0:8443/index.html` | ||
* To log in to Volttron Central, open a browser and login to the Volttron web interface: `https://0.0.0.0:8443/vc/index.html` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we have a default browser in the container? Or do you mean using port forwarding from host machine? if so shouldn't url be https://localhost:8443/index.html, where 8443 needs to be updated to whatever is the local mapped port?
Fix formatting on readme documentation.