Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
doc:docker [2019/08/16 12:21] – [Offline openEASE] daniel86doc: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://www.docker.com|Docker]]. Using Docker, we have created a cloud-based infrastructure for providing KnowRob as a service via the Web. This page collects information on the installation and usage of openEASE, a web-service based on [[http://www.docker.com|Docker]]. Using Docker, we have created a cloud-based infrastructure for providing KnowRob as a service via the Web.
 +You can follow the steps described here for any Ubuntu version that has docker independently of the Ubuntu version running inside of openEASE.
  
-===== Installing Web-Browser with WebGL Support ====+===== Installing web-browser with WebGL support ====
  
 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://get.webgl.org/|WebGL is supported]]. When the Browser is installed check that [[https://get.webgl.org/|WebGL is supported]].
  
-===== Installing the Docker daemon =====+===== Installing the docker daemon & docker-compose =====
 Install Docker following the instructions at https://docs.docker.com/engine/installation/linux/ubuntulinux/. Install Docker following the instructions at https://docs.docker.com/engine/installation/linux/ubuntulinux/.
  
 After installation, you need to log out and log in again to have your username added to the new group 'docker'. After installation, you need to log out and log in again to have your username added to the new group 'docker'.
 +
 +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://docs.docker.com/compose/install/
  
  
Line 26: Line 30:
  
  
-===== Setting up WebSocket Authentication =====+===== Setting up WebSocket authentication =====
  
 Clients can communicate with the openEASE webserver using SSL encryption. Clients can communicate with the openEASE webserver using SSL encryption.
Line 35: Line 39:
 **//NOTE//**: Please consider using a trusted certificate when running a production server, browsers will complain about the generated certificate! **//NOTE//**: Please consider using a trusted certificate when running a production server, browsers will complain about the generated certificate!
  
-===== 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 56: 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 password is **1234**. You can change it after logging in for the first time.
-and replace 'XXX' with your admin password: +
-  export OPENEASE_ADMIN_PASSWORD="XXX"+
  
-After you added the export to the .bashrc make sure to log-out and log-in again 
-(e.g., by restarting the terminal). 
- 
-**//NOTE//**: No admin user will be created if this variable is undefined. 
- 
-===== 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="XXX@gmail.com" 
-  export OPENEASE_MAIL_PASSWORD="XXX" 
  
 ===== Selecting a ROS distribution ===== ===== Selecting a ROS distribution =====
Line 83: Line 73:
  
 ===== 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, for example: This information must be included in the environment, for example:
Line 102: Line 94:
   export TWITTER_APP_ID "XXX"   export TWITTER_APP_ID "XXX"
   export TWITTER_APP_SECRET "XXX"   export TWITTER_APP_SECRET "XXX"
 +
 +===== 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="XXX@gmail.com"
 +  export OPENEASE_MAIL_PASSWORD="XXX"
  
 ===== Launching openEASE ===== ===== Launching openEASE =====
Line 110: Line 110:
 Then you can connect to the Web interface at https://localhost. Then you can connect to the Web interface at https://localhost.
  
-===== 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 122: Line 122:
  
 ===== Offline openEASE ===== ===== Offline openEASE =====
-**NOTE: this is nor supported as of 08/19, but the feature will be added again at a later time+**NOTE: this is not supported as of 08/19, but the feature will be added again at a later time
 ** **