Skip to content

Commit

Permalink
fix(docs): Readme about docker and typo
Browse files Browse the repository at this point in the history
  • Loading branch information
Pfeil committed Oct 22, 2024
1 parent 3e387e9 commit 43ff04e
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 8 deletions.
17 changes: 10 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,17 +129,20 @@ Currently, you can either run it via docker or via the compiled JAR file.

## Running via docker

**Required**: Up-to-date docker installation
**Required**: Up-to-date Docker (or Docker Desktop) installation

We provide docker images hosted on GitHub.

- Pull the latest version: `docker pull ghcr.io/kit-data-manager/pit-service:latest`

TODO
- configuration (config mount)
- backing up (database mount)
- document available ports, etc
- ...?
- Configuration / Mount points:
- Containers are being considered "throwaway objects". To update the application, you simply stop the container and create a new one from the updated image. Therefore, you need to persist configuration and database information!
- The configuration file is located within the container at `/app/conf/application-default.properties`
- For configuration, either use environment variables (e.g. with `docker compose`) or mount a custom `application.properties` into `/app/conf/`.
- For production, you'll want to configure your own Handle prefix. The required private key is recommended to also be mounted into `/app/conf/`, so you'll likely use mount point anyway.
- For persisting a database file, consider mounting `/data/`. This also means to adjust the configuration accordingly!
- Exposed ports (inner ports of the container)
- These are the exposed ports. To not attempt to change it in the configuration, as the container does not export other ports.
- `8090`: Provides the API, as well as the Swagger documentation.

## Running the compiled JAR file

Expand Down
2 changes: 1 addition & 1 deletion config/application-default.properties
Original file line number Diff line number Diff line change
Expand Up @@ -234,7 +234,7 @@ pit.pidgeneration.casing = lower
# When to store PIDs in the local database ("known PIDs")
pit.storage.strategy: keep-resolved-and-modified
#pit.storage.strategy: keep-resolved
# The driver detemins the database system to start. Other drivers are untested, but may work.
# The driver determines the database system to start. Other drivers are untested, but may work.
spring.datasource.driver-class-name: org.h2.Driver
# Next, please choose a location for the database file on your file system.
# WARNING: If no url is being defined, an in-memory database is being used,
Expand Down

0 comments on commit 43ff04e

Please sign in to comment.