Files
docker-inventaire/README.md

95 lines
2.8 KiB
Markdown
Raw Normal View History

2018-06-07 14:16:50 +02:00
Run your own inventaire in a docker environment
2018-06-07 14:16:50 +02:00
## Requirements
- [docker-compose](https://docs.docker.com/compose/gettingstarted/) up and ready
- git
2018-06-07 14:16:50 +02:00
## Install
```
git clone https://github.com/inventaire/inventaire-docker.git
```
got to `cd inventaire-docker`
clone the two repos inventaire needs to run :
2018-07-21 13:22:41 +02:00
- `inventaire` core application server -> [setup](https://github.com/inventaire/inventaire#installation)
- `entities-search-engine` for querying entities -> [go to repo](https://github.com/inventaire/entities-search-engine)
```
git clone https://github.com/inventaire/inventaire.git
git clone https://github.com/inventaire/entities-search-engine.git
```
Create empty folders for docker volume to dump backup. In accordance with docker-compose volumes, example: `mkdir data couch-test couch es`
2018-06-07 14:16:50 +02:00
Start the magic, build everything at once !
```
docker-compose up --build
```
2018-06-07 14:16:50 +02:00
## Useful commands
`docker-compose up` : start containers if already built
`docker-compose down` : kill active containers
`docker rm $(docker ps -a -q)` : delete stopped containers
`docker rmi $(docker images -q -f dangling=true)` : delete untagged images
Check out [official doc](https://docs.docker.com/compose/)
## Load wikidata into elasticsearch
Make sure ES import limit is above entities-search-engige import rate, by raising the limit
```
2018-09-09 12:55:28 +02:00
docker-compose exec entities-search-engine curl -XPUT http://elasticsearch:9200/wikidata/_settings -d '{"index.mapping.total_fields.limit": 20000}'
```
start the containers `docker-compose up`
```
claim=P31:Q5
type=humans
docker-compose exec entities-search-engine ./bin/dump_wikidata_subset $claim $type
```
[more info on importing some wikidata items](https://github.com/inventaire/inventaire-deploy/install_entities_search_engine)
more docs [wikidata filtered dump import](https://github.com/inventaire/entities-search-engine/blob/master/docs/wikidata_filtered_dump_import.mdFv)
## Fixtures
In case you would like to play with out-of-the-box data.
Run api tests to populate tests dbs (see Tests section)
```
`docker-compose -f docker-compose-test.yml exec inventaire npm run test-api`
```
- Replicate `*-tests` dbs documents into `*` dbs
```
`docker-compose exec inventaire npm run replicate-tests-db`
```
## Test environement
Start docker-compose-test `docker-compose -f docker-compose-test.yml up`
Execute tests script
`docker-compose exec inventaire npm run test-api`
or execute directly the test command
`docker-compose exec inventaire ./node_modules/.bin/mocha --compilers coffee:coffee-script/register --timeout 20000`
Tip : create a symbolic link on your machine between the inventaire folder and docker working directory on your machine at `/opt/`, in order to autocomplete path to test file to execute
`sudo ln ~/path/to/inventaire-docker/inventaire /opt -s`