Skip to content

Configure Library Microservice

The microservice reads its configuration from a YAML file. The template configuration file is:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
port: '4001'
mode: 'local' or 'git'
local-path: '/home/Desktop/files'
log-level: 'debug'
apollo-path: '/lib' or ''
graphql-playground: 'true' or 'false'

#Only needed if git mode
git-repos:
  - <username>:
      repo-url: '<git repo url>'
  ...
  - <username>:
      repo-url: '<git repo url>'

The local-path variable is the path to the local directory that the library microservice serves to users.

With graphql-playground: 'true', a browser that opens apollo-path gets GraphiQL, a web page for writing and running GraphQL queries. This is also the behaviour when the option is left out. With 'false', the microservice serves no such page and accepts only the GraphQL queries themselves.

Replace the default values with values suited to the deployment and save the configuration as a YAML file, for example libms.yaml.

Operation Modes

The mode sets the backend storage for the files. There are two modes, local and git. In local mode, users get the files in local-path. In git mode, the remote git repositories are cloned and served to users as local files.

git mode

A fragment of the config for git mode is:

1
2
3
4
5
6
7
8
...
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 are cloned. The repository name need not match the local directory name. For example, the above configuration makes the library microservice clone the https://gitlab.com/dtaas/user1.git repository into the user1 directory. Any git server reachable over HTTP(S) is supported. The .git suffix is optional.

Replace the default values with values suited to the deployment.

By default, libms looks for a libms.yaml file in the working directory from which it is run. To use a configuration file at another location, pass -c <path-to-file>.

The npm package page has more on using the library microservice.