Update README

This commit is contained in:
nemunaire 2023-04-11 08:10:40 +02:00
parent fb64472f2f
commit 3b84537430

View File

@ -15,6 +15,9 @@ micro-services :
checking and team's files generation. checking and team's files generation.
- `dashboard` is a public interface to explain and follow the - `dashboard` is a public interface to explain and follow the
conquest, aims to animate the challenge for visitors. conquest, aims to animate the challenge for visitors.
- `evdist` is an inotify reacting service that handles settings
changes during the challenge (eg. a 30 minutes event where hints are
free, ...).
- `frontend` is only responsible for receiving submissions. It is the - `frontend` is only responsible for receiving submissions. It is the
only dynamic part accessibe to players, so it's codebase is reduce only dynamic part accessibe to players, so it's codebase is reduce
to the minimum. It does not parse or try to understand players to the minimum. It does not parse or try to understand players
@ -22,6 +25,9 @@ micro-services :
system. Parsing and treatment is made by the `backend`. system. Parsing and treatment is made by the `backend`.
- `qa` is an interface dedicated to challenge development, it stores - `qa` is an interface dedicated to challenge development, it stores
reports to be treated by challenges creators. reports to be treated by challenges creators.
- `remote/challenge-sync-airbus` is an inotify reacting service that
allows us to synchronize scores and exercice validations with the
Airbus scoring platform.
- `remote/scores-sync-zqds` is an inotify reacting service that allows - `remote/scores-sync-zqds` is an inotify reacting service that allows
us to synchronize scores with the ZQDS scoring platform. us to synchronize scores with the ZQDS scoring platform.
- `repochecker` is a side project to check offline for synchronization - `repochecker` is a side project to check offline for synchronization
@ -31,13 +37,13 @@ In the production setup, each micro-service runs in a dedicated
container, isolated from each other. Moreover, two physical machines container, isolated from each other. Moreover, two physical machines
should be used: should be used:
- `deimos` communicates with players: displaying the web interface, - `phobos` communicates with players: displaying the web interface,
authenticate teams and players, storing contest files and handling authenticate teams and players, storing contest files and handling
submissions retrieval without understanding them. It can't access submissions retrieval without understanding them. It can't access
`phobos` so its job stop after writing requests on the filesystem. `deimos` so its job stops after writing requests on the filesystem.
- `phobos` is hidden from players, isolated from the network. It can - `deimos` is hidden from players, isolated from the network. It can
only access `deimos` via a restricted ssh connection, to retrieve only access `phobos` via a restricted ssh connection, to retrieve
requests from `deimos` filesystem and pushing to it newly generated requests from `phobos` filesystem and pushing to it newly generated
static files. static files.
So, the general filesystem is organized this way: So, the general filesystem is organized this way:
@ -92,6 +98,12 @@ Make the following changes inside this file `docker-compose.yml`:
24 - - ~/fic:/mnt/fic:ro 24 - - ~/fic:/mnt/fic:ro
24 + - <custom-path-to-import-folder>/fic:/mnt/fic:ro 24 + - <custom-path-to-import-folder>/fic:/mnt/fic:ro
##### Git import
A git repository can be used:
29 - command: --baseurl /admin/ -localimport /mnt/fic -localimportsymlink
29 + command: --baseurl /admin/ -localimport /mnt/fic -localimportsymlink -git-import-remote git@gitlab.cri.epita.fr:ing/majeures/srs/fic/2042/challenges.git
##### Owncloud import folder ##### Owncloud import folder
If your are trying to use the folder available with the Owncloud service, make the following changes inside this file `docker-compose.yml`: If your are trying to use the folder available with the Owncloud service, make the following changes inside this file `docker-compose.yml`: