diff --git a/README.md b/README.md index 819e30b8..7b137f35 100644 --- a/README.md +++ b/README.md @@ -34,6 +34,10 @@ micro-services : - `repochecker` is a side project to check offline for synchronization issues. +Here is how thoses services speak to each others: + +![Overview of the micro-services](doc/micro-services.png) + In the production setup, each micro-service runs in a dedicated container, isolated from each other. Moreover, two physical machines should be used: @@ -47,6 +51,10 @@ should be used: requests from `phobos` filesystem and pushing to it newly generated static files. +Concretely, the L2 looks like this: + +![Layer 2 connections](doc/l2.png) + So, the general filesystem is organized this way: - `DASHBOARD` contains files structuring the content of the dashboard @@ -80,6 +88,10 @@ So, the general filesystem is organized this way: resolve the association regarding `TEAMS` directory. There is also a special directory to handle team registration. +Here is a diagram showing how each micro-service uses directories it has access to (blue for read access, red for write access): + +![Usage of directories by each micro-service](doc/directories.png) + Local developer setup --------------------- @@ -120,7 +132,7 @@ If your are trying to use the folder available with the Owncloud service, make t Running this project requires a web server (configuration is given for nginx), a database (currently supporting only MySQL/MariaDB), a Go compiler for the -revision 1.16 at least and a `inotify`-aware system. You'll also need NodeJS to +revision 1.18 at least and a `inotify`-aware system. You'll also need NodeJS to compile some user interfaces. 1. Above all, you need to build Node projects: diff --git a/doc/directories.png b/doc/directories.png new file mode 100644 index 00000000..affe98f8 Binary files /dev/null and b/doc/directories.png differ diff --git a/doc/l2.png b/doc/l2.png new file mode 100644 index 00000000..7b963a8b Binary files /dev/null and b/doc/l2.png differ diff --git a/doc/micro-services.png b/doc/micro-services.png new file mode 100644 index 00000000..da00e380 Binary files /dev/null and b/doc/micro-services.png differ