Skip to content

Commit

Permalink
added docker install description to README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
tholzheim committed Dec 3, 2024
1 parent 6844109 commit dc61a88
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 3 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,14 @@ pip install .[test]
* WikibaseMigrator offers a cli tool and a web UI.
* Migration is defined with a migration profile which needs to be defined. For details on the definition see [Wikibase Migration Profile Configuration](./docs/migration_profile_config.md)

## Docker

```commandline
docker run -p 8009:8080 -v ~/.config/WikibaseMigrator/profiles/WikibaseMigrationTest.yaml:/config.yaml tholzheim/wbmigrator
```

> Exchange `~/.config/WikibaseMigrator/profiles/WikibaseMigrationTest.yaml` with the location of your migration profile configuration if needed
## Web UI
The webserver can be started over the cli with
```shell
Expand Down
3 changes: 1 addition & 2 deletions docker-compose.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
services:
app:
container_name: wbmigrator
build:
context: ./
image: tholzheim/wbmigrator:latest
restart: always
ports:
- 8009:8080
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ authors = [
maintainers = [
{name = "Tim Holzheim", email = "[email protected]"},
]
version = "0.0.10"
version = "0.0.11"
readme = "README.md"
license= "Apache-2.0"
dependencies = [
Expand Down

0 comments on commit dc61a88

Please sign in to comment.