-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #127 from agri-gaia/docs/formatReadme
formatting README
- Loading branch information
Showing
1 changed file
with
14 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -18,11 +18,13 @@ | |
|
||
## Maintainer | ||
|
||
Mark Höllmann\ | ||
German Research Center for Artificial Intelligence, | ||
DFKI Niedersachsen\ | ||
[Mark Höllmann](https://github.com/mhoellmann)\ | ||
[[email protected]](mailto:[email protected]) | ||
|
||
[German Research Center for Artificial Intelligence\ | ||
DFKI Niedersachsen\ | ||
Plan-Based Robot Control](https://www.dfki.de/en/web/research/research-departments/plan-based-robot-control) | ||
|
||
## General | ||
|
||
The large amount of temporally and spatially high resolution sensor data of autonomous mobile robots that have to be | ||
|
@@ -42,7 +44,13 @@ high-level planning and reasoning systems using the SEEREP query server. | |
To deploy the server locally the following `docker run` command or the following `docker-compose.yml` can be used. | ||
|
||
``` | ||
docker run --volume=seerep-data:/mnt/seerep-data --publish=9090 --name=seerep_server --tty ghcr.io/agri-gaia/seerep_server:latest --data-folder=/mnt/seerep-data | ||
docker run \ | ||
--volume=seerep-data:/mnt/seerep-data \ | ||
--publish=9090 \ | ||
--name=seerep_server \ | ||
--tty \ | ||
ghcr.io/agri-gaia/seerep_server:latest \ | ||
--data-folder=/mnt/seerep-data | ||
``` | ||
|
||
Example docker-compose.yml: | ||
|
@@ -55,17 +63,16 @@ services: | |
tty: true | ||
container_name: seerep_server | ||
command: | ||
- "--data-folder=/mnt/seerep-data" # define data-dir for seerep-server | ||
# define data-dir for seerep-server | ||
- "--data-folder=/mnt/seerep-data" | ||
ports: | ||
# the gRPC port | ||
- 9090 | ||
volumes: | ||
# persist the data folder | ||
- seerep-data:/mnt/seerep-data | ||
volumes: | ||
seerep-data: | ||
``` | ||
|
||
## Documentation | ||
|