Skip to content

Commit 43ff04e

Browse files
committed
fix(docs): Readme about docker and typo
1 parent 3e387e9 commit 43ff04e

File tree

2 files changed

+11
-8
lines changed

2 files changed

+11
-8
lines changed

README.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -129,17 +129,20 @@ Currently, you can either run it via docker or via the compiled JAR file.
129129

130130
## Running via docker
131131

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

134134
We provide docker images hosted on GitHub.
135135

136136
- Pull the latest version: `docker pull ghcr.io/kit-data-manager/pit-service:latest`
137-
138-
TODO
139-
- configuration (config mount)
140-
- backing up (database mount)
141-
- document available ports, etc
142-
- ...?
137+
- Configuration / Mount points:
138+
- 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!
139+
- The configuration file is located within the container at `/app/conf/application-default.properties`
140+
- For configuration, either use environment variables (e.g. with `docker compose`) or mount a custom `application.properties` into `/app/conf/`.
141+
- 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.
142+
- For persisting a database file, consider mounting `/data/`. This also means to adjust the configuration accordingly!
143+
- Exposed ports (inner ports of the container)
144+
- These are the exposed ports. To not attempt to change it in the configuration, as the container does not export other ports.
145+
- `8090`: Provides the API, as well as the Swagger documentation.
143146

144147
## Running the compiled JAR file
145148

config/application-default.properties

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -234,7 +234,7 @@ pit.pidgeneration.casing = lower
234234
# When to store PIDs in the local database ("known PIDs")
235235
pit.storage.strategy: keep-resolved-and-modified
236236
#pit.storage.strategy: keep-resolved
237-
# The driver detemins the database system to start. Other drivers are untested, but may work.
237+
# The driver determines the database system to start. Other drivers are untested, but may work.
238238
spring.datasource.driver-class-name: org.h2.Driver
239239
# Next, please choose a location for the database file on your file system.
240240
# WARNING: If no url is being defined, an in-memory database is being used,

0 commit comments

Comments
 (0)