Skip to content

Commit

Permalink
add presentation slides and adjust documentation for github container…
Browse files Browse the repository at this point in the history
… registry
  • Loading branch information
herzhenr committed Dec 2, 2024
1 parent 1a040f4 commit 73ceda7
Show file tree
Hide file tree
Showing 6 changed files with 13 additions and 6 deletions.
3 changes: 3 additions & 0 deletions Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,9 @@ EXPOSE 8080
# Command to run the executable
CMD ["./miracummapper"]

# There could be problems with the scratch image when communicating with https as it does not have certificates
# in this case, either manually copy the certificates over or use a different base image like alpine (see blow):

# # alpine enables to use curl for healthcheck
# FROM alpine:latest

Expand Down
2 changes: 1 addition & 1 deletion README.MD
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ The backend is a RESTful API that provides endpoints for the frontend to interac

## Quick Start

The application can be build and run using Docker. The following command will build the Docker image and run the container next to a postgres database container. An Keycloak instance with the corresponding postgres database is also started. The Keycloak instances need to persist data, thats why two volumes have to be created in advance.
The application can be build and run using Docker. The following command will build the Docker image and run the container next to a postgres database container. An Keycloak instance with the corresponding postgres database is also started. The Keycloak instances need to persist data, thats why two volumes have to be created in advance. The docker compose.yaml file by default pulls the image `ghcr.io/miracum/miracum-mapper-2.0-backend:1.0.0` form the GitHub Container registry (In the docker compose, the image section can be replaced with the build section which is currently commented out to build the image locally).

```bash
docker volume create miracum_postgres_data
Expand Down
9 changes: 5 additions & 4 deletions docker-compose.yaml
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
version: "3.3"
services:
miracum-mapper:
build:
context: .
dockerfile: Dockerfile
container_name: miracum-mapper
# build:
# context: .
# dockerfile: Dockerfile
# container_name: miracum-mapper
image: ghcr.io/miracum/miracum-mapper-2.0-backend:1.0.0
ports:
- "8080:8080"
environment:
Expand Down
2 changes: 2 additions & 0 deletions docs/deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ environment:
- DB_PASSWORD=miracum_password
```
There could be problems with the scratch image when communicating over https with other services as it does not have certificates. In this case, either manually copy the certificates over or use a different base image like Alpine.
## Frontend Configuration
The Frontend can be configured using a `.env` file. The following environment variables can be used:
Expand Down
Binary file added docs/presentation.pdf
Binary file not shown.
3 changes: 2 additions & 1 deletion internal/database/gormTestData.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,9 @@ import (
"fmt"
"miracummapper/internal/database/models"

"math/rand"

"github.com/google/uuid"
"golang.org/x/exp/rand"
"gorm.io/gorm"
)

Expand Down

0 comments on commit 73ceda7

Please sign in to comment.