Skip to content

Commit

Permalink
updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
nichlaes committed Dec 11, 2024
1 parent dc8512e commit 231369a
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 15 deletions.
2 changes: 2 additions & 0 deletions servers/lib/DEVELOPER.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,8 @@ The microservices require configuration and the docker version
of the microservices uses the configuration
file available in `config/libms.dev.yaml`.

For more see [configuration documentation](./README.md#gear-configure).

### Use

The commands to start and stop the appliation are:
Expand Down
22 changes: 11 additions & 11 deletions servers/lib/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,19 +43,19 @@ 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
Expand All @@ -80,12 +80,12 @@ 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
Expand Down
12 changes: 8 additions & 4 deletions servers/lib/config/libms.yaml.default
Original file line number Diff line number Diff line change
@@ -1,10 +1,14 @@
port: '4001'
mode: 'local' #git or local
mode: 'local' #git or local
local-path: '..\..\files'
log-level: 'debug'
apollo-path: '/lib'
graphql-playground: 'true'

git-repos: #only used in git mode
- user-1:
repo-url: 'https://gitlab.com/dtaas/user1.git'
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'

0 comments on commit 231369a

Please sign in to comment.