Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionLast revisionBoth sides next revision | ||
doc:docker [2017/01/10 10:41] – [PostgresDB] daniel86 | doc:docker [2020/03/09 13:55] – [Setting up admin user] daniel86 | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== | + | ====== |
- | This page collects information on the installation and usage of KnowRob with [[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:// | ||
- | ===== Installing dockerized KnowRob ===== | ||
- | The next step is to clone the KnowRob Docker repository to get some utility scripts, and to pull the docker images for KnowRob from [[https:// | + | ===== Installing openEASE ===== |
- | git clone --recursive https:// | + | |
- | cd docker | + | |
- | ./ | + | |
+ | The next step is to clone the openEASE repository: | ||
+ | git clone https:// | ||
- | ===== 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. | ||
For local testing you can generate a certificate with following commands: | For local testing you can generate a certificate with following commands: | ||
- | cd ./nginx-proxy/certs/ | + | cd ./openease/certs/ |
./ | ./ | ||
- | |||
- | 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)** | ||
Experiment logs can be downloaded via a public FTP server that is hosted in the network of | Experiment logs can be downloaded via a public FTP server that is hosted in the network of | ||
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 84: | Line 70: | ||
openEASE depends on rosjava. There are ubuntu packages available for ROS **hydro** and **indigo**. | openEASE depends on rosjava. There are ubuntu packages available for ROS **hydro** and **indigo**. | ||
indigo is used by default, but you can change the ROS distribution by extending your environment: | indigo is used by default, but you can change the ROS distribution by extending your environment: | ||
- | 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, | ||
- | export OPENEASE_MESHES=" | + | export OPENEASE_MESHES=" |
export OPENEASE_MESHES=" | export OPENEASE_MESHES=" | ||
export OPENEASE_MESHES=" | export OPENEASE_MESHES=" | ||
- | export OPENEASE_MESHES=" | + | export OPENEASE_MESHES=" |
- | ===== Setting up remote login ===== | + | ===== Setting up remote login (optional) |
openEASE allows you to sign in via oAuth. | openEASE allows you to sign in via oAuth. | ||
You have to register the openEASE app and acquire authentication and secret token from the service. | You have to register the openEASE app and acquire authentication and secret token from the service. | ||
Line 109: | Line 95: | ||
export TWITTER_APP_SECRET " | export TWITTER_APP_SECRET " | ||
- | ===== Launching the Web interface | + | ===== Setting up password recovery (optional) |
- | The Web interface runs in its own container. On the one hand, this app provides the Web GUI, on the other hand it manages the container infrastructure, | + | |
- | | + | 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 ===== | ||
+ | openEASE uses //docker-compose// | ||
+ | |||
+ | docker-compose up | ||
| | ||
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 125: | Line 119: | ||
A table with a row for each experiment is shown then. Press the " | A table with a row for each experiment is shown then. Press the " | ||
right most column in order to import the mongo logs for one of the experiments. | right most column in order to import the mongo logs for one of the experiments. | ||
+ | |||
===== 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. | ||
Line 180: | Line 177: | ||
With Ubuntu, you can stop the server by executing following command: | With Ubuntu, you can stop the server by executing following command: | ||
sudo service mongodb stop | sudo service mongodb stop | ||
+ | | ||
==== Other docker problems ==== | ==== Other docker problems ==== |