Merge pull request #162 from web-arena-x/shuyanzhou-patch-2

Update README.md

environment_docker/README.md

@@ -2,18 +2,19 @@
 This REAME file host the instructions for our Docker images and quick start guide for starting up websites used in WebArena.
 
 # Table of Content
-- [Pre-installed Amazon Machine Image](#pre-installed-amazon-machine-image)
-- [Environment Reset](#environment-reset)
-- [Shopping Website (OneStopShop)](#shopping-website--onestopshop-)
-- [E-commerce Content Management System (CMS)](#e-commerce-content-management-system--cms-)
-- [Social Forum Website (Reddit)](#social-forum-website--reddit-)
-- [Gitlab Website](#gitlab-website)
-- [Wikipedia Website](#wikipedia-website)
-- [Map](#map)
-- [Homepage](#homepage)
-- [Documentation sites](#documentation-sites)
-
-## Pre-installed Amazon Machine Image
+- [Pre-installed Amazon Machine Image (Recommended)](#pre-installed-amazon-machine-image-recommended)
+   * [Environment reset](#environment-reset)
+- [Individual Website](#individual-website)
+   * [Shopping Website (OneStopShop)](#shopping-website-onestopshop)
+   * [E-commerce Content Management System (CMS)](#e-commerce-content-management-system-cms)
+   * [Social Forum Website (Reddit)](#social-forum-website-reddit)
+   * [Gitlab Website](#gitlab-website)
+   * [Wikipedia Website](#wikipedia-website)
+   * [Homepage](#homepage)
+   * [Map](#map)
+   * [Documentation sites](#documentation-sites)
+
+## Pre-installed Amazon Machine Image (Recommended)
 We provide AMI which have all the websites pre-installed. You can use the AMI to start a new EC2 instance.
 
 ```
@@ -62,7 +63,7 @@ docker exec gitlab gitlab-ctl reconfigure
 You should be able to access your environment websites now, and stop reading.
 However, if you are unable to use AWS AMI, read below to set up on your own machine.
 
-## Environment Reset
+### Environment reset
 After evaluating the 812 examples, reset the environment to the initial state
 ```bash
 # stop and remove the images
@@ -76,7 +77,11 @@ docker run --name forum -p 9999:80 -d postmill-populated-exposed-withimg
 <repeat the commands in step 5 above>
 ```
 
-## Shopping Website (OneStopShop)
+## Individual Website
+We highly recommend setting up the environments with AMI introduced above, but we also list the steps to setting up individual websites below. This allows you to setup selected websites locally.
+
+
+### Shopping Website (OneStopShop)
 
 Download the image tar from the following mirrors:
 - https://drive.google.com/file/d/1gxXalk9O0p9eu1YkIJcmZta1nvvyAJpA/view?usp=sharing
@@ -95,7 +100,7 @@ docker exec shopping /var/www/magento2/bin/magento cache:flush
 Now you can visit `http://<your-server-hostname>:7770`.
 
 
-## E-commerce Content Management System (CMS)
+### E-commerce Content Management System (CMS)
 
 Download the image tar from the following mirrors:
 - https://drive.google.com/file/d/1See0ZhJRw0WTTL9y8hFlgaduwPZ_nGfd/view?usp=sharing
@@ -114,7 +119,7 @@ docker exec shopping_admin /var/www/magento2/bin/magento cache:flush
 Now you can visit `http://<your-server-hostname>:7780/admin`.
 
 
-## Social Forum Website (Reddit)
+### Social Forum Website (Reddit)
 
 Download the image tar from the following mirrors:
 - https://drive.google.com/file/d/17Qpp1iu_mPqzgO_73Z9BnFjHrzmX9DGf/view?usp=sharing
@@ -128,7 +133,7 @@ docker run --name forum -p 9999:80 -d postmill-populated-exposed-withimg
 Now you can visit `http://<your-server-hostname>:9999/`.
 
 
-## Gitlab Website
+### Gitlab Website
 
 Download the image tar from the following mirrors:
 - https://drive.google.com/file/d/19W8qM0DPyRvWCLyQe0qtnCWAHGruolMR/view?usp=sharing
@@ -145,7 +150,7 @@ docker exec gitlab gitlab-ctl reconfigure
 ```
 It might take 5 mins to start and then you can visit `http://<your-server-hostname>:8023/explore`.
 
-## Wikipedia Website
+### Wikipedia Website
 
 Download the data from the following mirrors:
 - https://drive.google.com/file/d/1Um4QLxi_bGv5bP6kt83Ke0lNjuV9Tm0P/view?usp=sharing
@@ -157,11 +162,7 @@ docker run -d --name=wikipedia --volume=<your-path-to-downloaded-folder>/:/data
 ```
 Now you can visit `http://<your-server-hostname>:8888/wikipedia_en_all_maxi_2022-05/A/User:The_other_Kiwix_guy/Landing`.
 
-## Map
-
-As the content of the map site is static, we currently host it on our server. You can set the link of the map site to `http://ec2-3-131-244-37.us-east-2.compute.amazonaws.com:3000/`. We are working on making the map site locally hostable.
-
-## Homepage
+### Homepage
 
 The homepage lists all available websites which the agent can use to navigate to different sites.
 ![Homepage](../media/homepage_demo.png)
@@ -183,5 +184,8 @@ flask run --host=0.0.0.0 --port=4399
 ```
 The homepage will be available at `http://<your-server-hostname>:4399`.
 
-## Documentation sites
+### Map
+Please refer to the AMI setup for the map.
+
+### Documentation sites
 We are still working on dockerizing the documentation sites. As they are read-only sites and they usually don't change rapidly. It is safe to use their live sites for test purpose right now.