Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
doc:docker [2019/08/16 12:17] – [Installing dockerized KnowRob] daniel86 | doc:docker [2020/03/09 13:55] (current) – [Setting up admin user] daniel86 | ||
---|---|---|---|
Line 2: | Line 2: | ||
This page collects information on the installation and usage of openEASE, a web-service based on [[http:// | This page collects information on the installation and usage of openEASE, a web-service based on [[http:// | ||
+ | You can follow the steps described here for any Ubuntu version that has docker independently of the Ubuntu version running inside of openEASE. | ||
- | ===== Installing | + | ===== Installing |
Firefox is by far the most tested browser. Packages in ubuntu repositories should work with KnowRob. | Firefox is by far the most tested browser. Packages in ubuntu repositories should work with KnowRob. | ||
Line 13: | Line 14: | ||
When the Browser is installed check that [[https:// | When the Browser is installed check that [[https:// | ||
- | ===== Installing the Docker | + | ===== Installing the docker |
Install Docker following the instructions at https:// | Install Docker following the instructions at https:// | ||
After installation, | After installation, | ||
+ | |||
+ | In addition, you will need to install docker-compose which is used for the orchestration of the openEASE application. | ||
+ | Install instrucitons for docker-compose can be found here: https:// | ||
Line 26: | Line 30: | ||
- | ===== Setting up WebSocket | + | ===== Setting up WebSocket |
Clients can communicate with the openEASE webserver using SSL encryption. | Clients can communicate with the openEASE webserver using SSL encryption. | ||
Line 32: | Line 36: | ||
cd ./ | cd ./ | ||
./ | ./ | ||
- | |||
- | This certificate must be included in the web server container (the certificate will be mounted as host volume inside of the docker container). Make sure to remove any old web server container | ||
- | that doesn' | ||
- | docker rm -f nginx | ||
**// | **// | ||
- | ===== Setting up Experiment Logs ===== | + | ===== Setting up experiment logs ===== |
**NOTE: this is subject of change, experiment logs will be inserted differently soon (DB 08/19)** | **NOTE: this is subject of change, experiment logs will be inserted differently soon (DB 08/19)** | ||
Line 60: | Line 60: | ||
The volume container is automatically created based on the environment variable next time you start the openEASE webserver. | The volume container is automatically created based on the environment variable next time you start the openEASE webserver. | ||
- | ===== Setting up Admin User ===== | + | ===== Setting up admin user ===== |
The admin user is automatically created when the webserver starts for the first time. | The admin user is automatically created when the webserver starts for the first time. | ||
- | The password is taken from an environment variable. Please add following environment variable to your .bashrc | + | The default |
- | and replace ' | + | |
- | export OPENEASE_ADMIN_PASSWORD=" | + | |
- | After you added the export to the .bashrc make sure to log-out and log-in again | ||
- | (e.g., by restarting the terminal). | ||
- | |||
- | **// | ||
- | |||
- | ===== Setting up Password Recovery ===== | ||
- | |||
- | For production servers, you might want a working password recovery mechanism. | ||
- | This requires a mail account that is used for sending the recovery mails. | ||
- | Add two more environment variables to the .bash.rc: | ||
- | export OPENEASE_MAIL_USERNAME=" | ||
- | export OPENEASE_MAIL_PASSWORD=" | ||
===== Selecting a ROS distribution ===== | ===== Selecting a ROS distribution ===== | ||
Line 86: | Line 72: | ||
export OPENEASE_ROS_DISTRIBUTION=" | export OPENEASE_ROS_DISTRIBUTION=" | ||
- | It is required, that you have a container named '' | ||
- | locally installed. | ||
===== Setting up mesh repositories ===== | ===== Setting up mesh repositories ===== | ||
+ | **NOTE: this is subject of change, meshes will be part of episodic memory soon (DB 08/19)** | ||
+ | |||
Meshes can be downloaded from custom **git** or **svn** repositories. | Meshes can be downloaded from custom **git** or **svn** repositories. | ||
This information must be included in the environment, | This information must be included in the environment, | ||
Line 108: | Line 94: | ||
export TWITTER_APP_ID " | export TWITTER_APP_ID " | ||
export TWITTER_APP_SECRET " | export TWITTER_APP_SECRET " | ||
+ | |||
+ | ===== Setting up password recovery (optional) ===== | ||
+ | |||
+ | For production servers, you might want a working password recovery mechanism. | ||
+ | This requires a mail account that is used for sending the recovery mails. | ||
+ | Add two more environment variables to the .bash.rc: | ||
+ | export OPENEASE_MAIL_USERNAME=" | ||
+ | export OPENEASE_MAIL_PASSWORD=" | ||
===== Launching openEASE ===== | ===== Launching openEASE ===== | ||
Line 116: | Line 110: | ||
Then you can connect to the Web interface at https:// | Then you can connect to the Web interface at https:// | ||
- | ===== Setting up Mongo Logs ===== | + | ===== Setting up mongo server |
Mongo dumps are included in the episode data downloaded from the FTP. | Mongo dumps are included in the episode data downloaded from the FTP. | ||
Line 128: | Line 122: | ||
===== Offline openEASE ===== | ===== Offline openEASE ===== | ||
+ | **NOTE: this is not supported as of 08/19, but the feature will be added again at a later time | ||
+ | ** | ||
openEASE is a webapp and thus components may require active internet connection. | openEASE is a webapp and thus components may require active internet connection. |