Skip to content

Commit

Permalink
Filled out README
Browse files Browse the repository at this point in the history
  • Loading branch information
aultac authored Apr 5, 2020
1 parent f356acf commit bf129e6
Showing 1 changed file with 22 additions and 1 deletion.
23 changes: 22 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,24 @@
# oada-ensure #

Ensures that things happen in other documents in response to document changes (i.e. re-indexing, copying, linking, etc.)
A microservice to ensure that things happen in other documents in response to document changes (i.e. re-indexing, copying, linking, etc.). It currently uses oada-jobs as the means by which it gets its directions.

The only current task it performs is to create a link in any children linked from a virtual document
at /bookmarks/trellisfw/documents back to the main virtual document parent. It stores the link in the child at `_meta/vdoc`

## Installation
```bash
cd /path/to/your/oada-srvc-docker
cd services-available
git clone [email protected]:OADA/oada-ensure.git
cd ../services-enabled
ln -s ../services-available/oada-ensure .
```

## Overriding defaults for production
`z_tokens` docker-compose.yml entry:
```docker-compose
oada-ensure:
environment:
- token=atokentouseinproduction
- domain=https://your.oada.domain
```

0 comments on commit bf129e6

Please sign in to comment.