@into-cps-association/libms 0.5.2 → 0.5.4

package/DEVELOPER.md

@@ -116,17 +116,13 @@ running the following commands.
 
 The microservices require configuration and the docker version
 of the microservices uses the configuration
-file available in `config/.env.default`.
+file available in `config/libms.dev.yaml`.
 
-Please add a `.env` file with the environment variables for
-the docker compose file to use.
-e.g.
+For more see [configuration documentation](./README.md#gear-configure).
+The `config/libms.dev.yaml` file is used for configuration of the container.
 
-```sh
-PORT='4001'
-MODE='local'
-LOCAL_PATH='..\..\files'
-```
+A new directory named `files` is created in `servers/lib` directory and
+files are saved and served from the `files` directory.
 
 ### Use
 
@@ -140,7 +136,7 @@ docker compose -f compose.lib.dev.yml up -d
 
 This command brings up the lib docker container and makes
 the website available at <http://localhost:4001>.
-The `config/.env.default` file is used as the microservice configuration.
+The `config/libms.dev.yaml` file is used as the microservice configuration.
 If the configuration values are changed, please restart the container.
 
 ```bash

package/DOCKER.md

@@ -1,10 +1,11 @@
 # Overview
 
-The **libms microservice** is a simplified file manager providing graphQL API.
-It has two features:
+The **lib microservice** is a simplified file manager which serves files
+from local file system or public git repositories. It is possible to
 
-* provide a listing of directory contents.
-* transfer a file to user.
+* Upload and download files from web browser
+* Query available files and download them using GraphQL API
+* Clone public git repositories and serve them as local files
 
 ## Use in Docker Environment
 
@@ -19,12 +20,13 @@ services:
     image: intocps/libms:latest
     restart: unless-stopped
     volumes:
+      - ./libms.yaml:/dtaas/libms/libms.yaml
       - ./files:/dtaas/libms/files
     ports:
       - "4001:4001"
 ```
 
-### Create Files Directory
+### Create Files Directory (optional)
 
 The **libms microservice** serves files available from
 `files` directory.
@@ -47,6 +49,71 @@ files/
 Please create this `files` directory
 in the same file system location as that of the `compose.lib.yml` file.
 
+:label: The directory structure is optional if you are using
+libms as a standalone service.
+
+## :gear: Configure
+
+The microservices requires config specified in `libms.yaml` file.
+The template configuration file is:
+
+```yaml
+port: '4001'
+mode: 'local'    #git or local
+local-path: 'files'
+log-level: 'debug'
+apollo-path: '/lib'
+graphql-playground: 'true'
+
+git-repos:   #only used in git mode
+  - user1: 
+      repo-url: 'https://gitlab.com/dtaas/user1.git'
+  - user2: 
+      repo-url: 'https://gitlab.com/dtaas/user2.git'
+  - common: 
+      repo-url: 'https://gitlab.com/dtaas/common.git'
+```
+
+The `local-path` variable is the relative filepath to the
+location of the local directory which will be served to users
+by the Library microservice.
+
+Replace the default values the appropriate values for your setup.
+Please save this config in `libms.yaml`.
+
+### Operation Modes
+
+The mode indicates the backend storage for the files.
+There are two possible modes - `local` and `git`.
+The files available in the `local-path` are served to users in `local` mode.
+In the `git` mode, the remote git repos are cloned and they are
+served to users as local files. Only public git repositories
+are supported at present.
+
+#### git mode
+
+A fragment of the config for `git` mode is:
+
+```yaml
+...
+git-repos:
+  - user1: 
+      repo-url: 'https://gitlab.com/dtaas/user1.git'
+  - user2: 
+      repo-url: 'https://gitlab.com/dtaas/user2.git'
+  - common: 
+      repo-url: 'https://gitlab.com/dtaas/common.git'
+```
+
+Here, `user1`, `user2` and `common` are the local directories into which
+the remote git repositories get cloned. The name of the repository need not
+match with the local directory name. For example, the above configuration
+enables library microservice to clone
+`https://gitlab.com/dtaas/user1.git` repository into
+`user1` directory. Any git server accessible over
+HTTP(S) protocol is supported.
+The `.git` suffix is optional.
+
 ### Run
 
 Use the following commands to start and stop the container respectively:

package/README.md

@@ -38,24 +38,24 @@ needs to have _read:packages_ scope.
 
 ## :gear: Configure
 
-The microservices requires config specified in INI format.
+The microservices requires config specified in yaml format.
 The template configuration file is:
 
 ```yaml
 port: '4001'
-mode: 'git' # either git or local
-local-path: 'files'
+mode: 'local'    #git or local
+local-path: '..\..\files'
 log-level: 'debug'
 apollo-path: '/lib'
 graphql-playground: 'true'
 
-git-repos:
-  - user-1: 
-      repo-url: 'https://github.com/isomorphic-git/lightning-fs'
-  - user-2: 
+git-repos:   #only used in git mode
+  - user1: 
+      repo-url: 'https://gitlab.com/dtaas/user1.git'
+  - user2: 
       repo-url: 'https://gitlab.com/dtaas/user2.git'
   - common: 
-      repo-url: 'https://gitlab.com/dtaas/common'
+      repo-url: 'https://gitlab.com/dtaas/common.git'
 ```
 
 The `local-path` variable is the relative filepath to the
@@ -80,20 +80,20 @@ A fragment of the config for `git` mode is:
 ```yaml
 ...
 git-repos:
-  - user-1: 
-      repo-url: 'https://github.com/isomorphic-git/lightning-fs'
-  - user-2: 
+  - user1: 
+      repo-url: 'https://gitlab.com/dtaas/user1.git'
+  - user2: 
       repo-url: 'https://gitlab.com/dtaas/user2.git'
   - common: 
-      repo-url: 'https://gitlab.com/dtaas/common'
+      repo-url: 'https://gitlab.com/dtaas/common.git'
 ```
 
-Here, `user-1`, `user-2` and `common` are the local directories into which
+Here, `user1`, `user2` and `common` are the local directories into which
 the remote git repositories get cloned. The name of the repository need not
 match with the local directory name. For example, the above configuration
 enables library microservice to clone
-`https://github.com/isomorphic-git/lightning-fs` repository into
-`user-1` directory. Any git server accessible over
+`https://gitlab.com/dtaas/user1.git` repository into
+`user1` directory. Any git server accessible over
 HTTP(S) protocol is supported.
 The `.git` suffix is optional.
 

package/compose.lib.dev.yml

@@ -4,6 +4,7 @@ services:
       context: ../../
       dockerfile: ./docker/libms.dockerfile
     volumes:
-      - ${LOCAL_PATH}:/dtaas/libms/files
+      - ./files:/dtaas/libms/files
+      - ./config/libms.dev.yaml:/dtaas/libms/libms.yaml
     ports:
-      - ${PORT}:4001
+      - 4001:4001

package/compose.lib.yml

@@ -3,6 +3,7 @@ services:
     image: intocps/libms:latest
     restart: unless-stopped
     volumes:
+      - ./config/libms.dev.yaml:/dtaas/libms/libms.yaml
       - ./files:/dtaas/libms/files
     ports:
       - "4001:4001"

package/config/libms.dev.yaml

@@ -0,0 +1,14 @@
+port: '4001'
+mode: 'local'    #git or local
+local-path: '/dtaas/libms/files'
+log-level: 'debug'
+apollo-path: '/lib'
+graphql-playground: 'true'
+
+git-repos:   #only used in git mode
+  - user1: 
+      repo-url: 'https://gitlab.com/dtaas/user1.git'
+  - user2: 
+      repo-url: 'https://gitlab.com/dtaas/user2.git'
+  - common: 
+      repo-url: 'https://gitlab.com/dtaas/common.git'

package/config/libms.yaml.default

@@ -1,12 +1,14 @@
 port: '4001'
-mode: 'git'
+mode: 'local'    #git or local
 local-path: '..\..\files'
 log-level: 'debug'
 apollo-path: '/lib'
 graphql-playground: 'true'
 
-git-repos:
-  - user-1: 
-      repo-url: 'https://github.com/isomorphic-git/lightning-fs'
-  - user-2: 
-      repo-url: 'https://github.com/isomorphic-git/lightning-fs'
+git-repos:   #only used in git mode
+  - user1: 
+      repo-url: 'https://gitlab.com/dtaas/user1.git'
+  - user2: 
+      repo-url: 'https://gitlab.com/dtaas/user2.git'
+  - common: 
+      repo-url: 'https://gitlab.com/dtaas/common.git'