@into-cps-association/libms 0.5.1 → 0.5.3

package/DEVELOPER.md

@@ -1,5 +1,14 @@
 # Developer Instructions
 
+## Prerequisites
+
+The **pm2** package needs to be available for tests.
+You can install the same by executing
+
+```bash
+npm install -g pm2
+```
+
 ## :gear: Configure
 
 This microservice needs library assets and configuration
@@ -26,34 +35,7 @@ yarn clean      # Deletes "build", "coverage", "dist" and other temp files
 ```
 
 **NOTE:** The integration, end-to-end and http tests require a valid
-`.env` file. Here is a sample file.
-
-```ini
-PORT='4001'
-MODE='local'
-LOCAL_PATH ='/Users/<Username>/DTaaS/files'
-LOG_LEVEL='debug'
-APOLLO_PATH='/lib'
-GRAPHQL_PLAYGROUND='true'
-```
-
-Here is another with `git` mode.
-
-```ini
-PORT='4001'
-MODE='git'
-LOCAL_PATH ='/Users/<Username>/DTaaS/files'
-LOG_LEVEL='debug'
-APOLLO_PATH='/lib'
-GRAPHQL_PLAYGROUND='true'
-
-GIT_USER1_REPO_URL='<git repo url>'
-GIT_USER1_API_TOKEN='<TOKEN>'
-...
-GIT_USERX_REPO_URL='<git repo url>'
-GIT_USERX_API_TOKEN='<TOKEN>'
-```
-
+configuration. This configuration is already set in `libms.test.yaml` file.
 
 ## Service Endpoint
 
@@ -99,7 +81,7 @@ for more information publishing docker images.
 The default registry for npm packages is [npmjs](https://registry.npmjs.org).
 
 ```bash
-sudo npm install -g @into-cps-association/libms
+npm install -g @into-cps-association/libms
 ```
 
 The steps for publishing the package to npmjs are listed in
@@ -134,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
 
@@ -158,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

@@ -1,10 +1,11 @@
 # Overview
 
-The **lib 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
 
 ## :arrow_down: Install
 
@@ -14,15 +15,9 @@ The default registry for npm packages is [npmjs](https://registry.npmjs.org).
 Install the package with the following commands
 
 ```bash
-sudo npm install -g @into-cps-association/libms
-sudo npm install -g pm2
+npm install -g @into-cps-association/libms
 ```
 
-The package on [npmjs](https://registry.npmjs.org) is published
-less frequently than the one on Github NPM Registry. But
-the package on npmjs is more stable version of libms and should
-be used for production purposes.
-
 ### Github NPM Registry
 
 The package is also available in Github
@@ -31,8 +26,8 @@ The package is also available in Github
 Set the registry and install the package with the following commands
 
 ```bash
-sudo npm config set @into-cps-association:registry https://npm.pkg.github.com
-sudo npm install -g @into-cps-association/libms
+npm config set @into-cps-association:registry https://npm.pkg.github.com
+npm install -g @into-cps-association/libms
 ```
 
 The _npm install_ command asks for username and password. The username is
@@ -43,32 +38,64 @@ 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:
 
-```ini
-PORT='4001'
-MODE='local' or 'gitlab'
-LOCAL_PATH ='/Users/<Username>/DTaaS/files'
-LOG_LEVEL='debug'
-APOLLO_PATH='/lib' or ''
-GRAPHQL_PLAYGROUND='false' or 'true'
-
-#Only needed if git mode
-GIT_USER1_REPO_URL='<git repo url>'
-GIT_USER1_API_TOKEN='<TOKEN>'
-...
-GIT_USERX_REPO_URL='<git repo url>'
-GIT_USERX_API_TOKEN='<TOKEN>'
-
+```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 absolute filepath to the
+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 a file.
+Please save this config in a file as a yaml file, for example as `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.
+
+#### 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.
 
 ## :rocket: Use
 
@@ -82,7 +109,7 @@ The lib microservice is a file server. It supports file transfer
 over GraphQL and HTTP protocols.
 
 Options:
-  -c, --config <file>  provide the config file (default .env)
+  -c, --config <file>  provide the config file (default libms.yaml)
   -H, --http <file>    enable the HTTP server with the specified config
   -h, --help           display help for libms
 ```
@@ -91,9 +118,9 @@ Both the options are not mandatory.
 
 ### Configuration file
 
-The config is saved `.env` file by convention. If `-c` is not specified
+The config is saved `libms.yaml` file by convention. If `-c` is not specified
 The **libms** looks for
-`.env` file in the working directory from which it is run.
+`libms.yaml` file in the working directory from which it is run.
 If you want to run **libms** without explicitly specifying the configuration
 file, run
 
@@ -108,11 +135,11 @@ libms -c FILE-PATH
 libms --config FILE-PATH
 ```
 
-If the environment file is named something other than `.env`,
-for example as `config/.env.default`, you can run
+If the environment file is named something other than `libms.yaml`,
+for example as `config/libms.yaml.default`, you can run
 
 ```sh
-libms -c "config/.env.default"
+libms -c "config/libms.yaml.default"
 ```
 
 You can press `Ctl+C` to halt the application.
@@ -151,6 +178,7 @@ libms --http FILE-PATH
   "confirmCopy": true,
   "confirmMove": true,
   "showConfig": false,
+  "showDotFiles": false,
   "showFileName": true,
   "contact": false,
   "configDialog": false,

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

@@ -0,0 +1,14 @@
+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'