Update README.md

README.md

@@ -5,6 +5,8 @@ The IOI Translation System provides a web interface for translating the tasks (p
 into various languages during the International Olympiads in Informatics.
 The system has been developed and first used in the IOI 2017 in Tehran, Iran.
 
+This fork, used in IOI 2018, contains AWS S3 support for the file storage and CMS integration.
+
 Features
 --------
 
@@ -20,8 +22,16 @@ Features
 * Dockerized and easy to develop and deploy
 
 
-Installation
-------------
+Deployment
+----------
+
+ioi-translation is designed to be deployed on a Docker-compatible container platform. PostgreSQL and Redis are required for persistent storage and session store, respectively. Deployment behind reverse proxy such as nginx is recommended.
+
+See `docker-compose.yml` for example deployment configurations (Note that `docker-compose.yml` in this repository is for development and not intended for use in production deployment). For the actual deployment in IOI 2018, refer to <https://github.com/jcioi/ioi-htc> (especially [ECS and nginx configuration](https://github.com/jcioi/ioi-htc/blob/master/hako/translation-prd.jsonnet) and [CMS integration](https://github.com/jcioi/ioi-htc/blob/master/itamae/cookbooks/ioi-cms-import-statement-worker/files/usr/bin/ioi-cms-import-statement-worker.rb))
+
+
+Development Installation
+--------------------
 
 You can install the translation system in just three steps:
 1. Install [docker](https://docs.docker.com/engine/installation/) and
@@ -33,7 +43,6 @@ At this point, you will have a copy of the translation system up
 and running at `http://your_server_address:8000/`.
 You may optionally perform the following tasks:
 
-
 * To create essential data for the system such as admin users and groups,
   run `docker-compose exec web bash` after the system has been started,
   and then in the shell, execute `python3 manage.py loaddata initial_data.json`
@@ -45,9 +54,6 @@ You may optionally perform the following tasks:
   To follow the logs from now on, run `docker-compose logs -f --tail=0`.
 * To stop the system, run `dokcer-compose stop`.
 
-Development Settings
---------------------
-
 For using docker in development settings, add `--reload` option
 to the execution line of gunicorn in `docker-entrypoint.sh` file.
 Then run docker by `docker-compose up --build`.