Skip to content

Commit 0bf2c38

Browse files
committed
Extend README.md
1 parent aff1b41 commit 0bf2c38

File tree

1 file changed

+25
-2
lines changed

1 file changed

+25
-2
lines changed

README.md

+25-2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,26 @@
1-
# OpenRefine containers
1+
# How to build and run
22

3-
This repository hosts a collection of containerized packages of OpenRefine.
3+
```bash
4+
docker compose up --build
5+
```
6+
7+
Configure by editing `docker-compose.yml`.
8+
9+
# Upgrade
10+
11+
Before building the new image, some operation could be needed.
12+
13+
## Generate a template configuration file
14+
15+
This is if the new version of OpenRefine has a different `refine.ini` configuration file.
16+
17+
```bash
18+
version="3.7.5"
19+
curl -L "https://github.com/OpenRefine/OpenRefine/releases/download/${version}/openrefine-linux-${version}.tar.gz" |
20+
tar xz --wildcards '*/refine.ini' --strip-components 1
21+
mv refine.ini refine.ini.template
22+
```
23+
24+
The new `refine.ini.template` should still use the environmental variables as the previous one.
25+
This requires editing the file manually by comparing it to the old version.
26+
`git diff refine.ini.template` can be helpful.

0 commit comments

Comments
 (0)