Skip to content

Add Ferret for a Open source (non-mongo) deployment option #229

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
birm merged 9 commits into from
Jun 13, 2025
Merged

Add Ferret for a Open source (non-mongo) deployment option #229

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
218d973
Merge pull request #214 from camicroscope/develop
birm Nov 17, 2023
03fa45b
Merge pull request #216 from camicroscope/develop
birm May 2, 2024
217cce3
docker-compose to docker compose
birm Feb 6, 2025
b0f9d48
initial partially-working ferret version
birm Feb 6, 2025
46c1904
Merge branch 'ferret' of https://github.com/camicroscope/distro into …
birm Feb 6, 2025
db022a5
whatever I had on this branch
birm Mar 20, 2025
77e6085
working barebones ferret camicroscope
birm Jun 13, 2025
314a4d8
revert special dev tag
birm Jun 13, 2025
e1235fe
key: add keycloak second
birm Jun 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/main.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ jobs:
steps:
- uses: actions/checkout@v2
- name: Build the develop stack
run: docker-compose -f develop.yml build
run: docker compose -f develop.yml build
2 changes: 1 addition & 1 deletion config/keycloak_login.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<html>
<title>caMicroscope Keycloak Login</title>
<head>
<meta name="client_secret" content="MS3NXMPABktO2Dom7qoT0BStlYk1Z1jc">
<meta name="client_secret" content="uHbasU3TFAJJrEcQdxApm4ZhrKQL6La7">
<meta name="client_id" content="camicroscope-test">
<link rel="stylesheet" href="./apps/landing/main.css" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
Expand Down
5 changes: 5 additions & 0 deletions config/postgres_db_user_setup.sql
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
CREATE USER keycloak WITH PASSWORD 'password';
CREATE DATABASE keycloak;
GRANT ALL PRIVILEGES ON DATABASE keycloak TO keycloak;
GRANT ALL PRIVILEGES ON SCHEMA public TO keycloak;
ALTER USER keycloak WITH SUPERUSER;
1 change: 1 addition & 0 deletions develop.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ services:
- ./jwt_keys/:/src/keys/
- ./config/routes.json:/src/routes.json
- ./config/contentSecurityPolicy.json:/src/contentSecurityPolicy.json
- ../camicroscope/:/src/camicroscope/
environment:
JWK_URL: "https://www.googleapis.com/oauth2/v3/certs"
IIP_PATH: "http://ca-iip:8080/fcgi-bin/iipsrv.fcgi"
Expand Down
3 changes: 2 additions & 1 deletion kc_caMicroscope.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,4 +114,5 @@ services:
environment:
DICOM_PORT: "11112"
DICOM_UI_PORT: "8042"
CARACAL_BACK_HOST_PORT: "ca-back:4010"
CARACAL_BACK_HOST_PORT: "ca-back:4010"

113 changes: 113 additions & 0 deletions osi_camicroscope.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,113 @@
version: '3'

volumes:
postgres_data:
name: postgres_data
ferret_data:
name: ferret_data

networks:
default:
name: ferretdb

services:
postgres:
image: ghcr.io/ferretdb/postgres-documentdb:17-0.104.0-ferretdb-2.3.1
container_name: ca-key-db
volumes:
- postgres_data:/var/lib/postgresql/data
- ./config/postgres_db_user_setup.sql:/docker-entrypoint-initdb.d/init.sql
environment:
POSTGRES_DB: postgres
POSTGRES_USER: ferret
POSTGRES_PASSWORD: ferretpassword
restart: always
logging:
options:
max-file: "5"
max-size: "10m"
keycloak:
container_name: ca-key
image: quay.io/keycloak/keycloak:latest
command: start-dev
environment:
KC_DB: postgres
KC_DB_URL: jdbc:postgresql://ca-key-db:5432/keycloak
KC_DB_USERNAME: keycloak
KC_DB_PASSWORD: password
KEYCLOAK_ADMIN: admin
KEYCLOAK_ADMIN_PASSWORD: password
ports:
- 8080:8080
restart: always
logging:
options:
max-file: "5"
max-size: "10m"
depends_on:
- postgres
ferretdb:
image: ghcr.io/ferretdb/ferretdb:2.3.1
container_name: ca-ferretdb
restart: always
logging:
options:
max-file: "5"
max-size: "10m"
environment:
- FERRETDB_POSTGRESQL_URL=postgresql://ferret:ferretpassword@ca-key-db:5432/postgres
- FERRETDB_AUTH=0
volumes:
- ferret_data:/data/db
depends_on:
- postgres
back:
build:
context: "https://github.com/camicroscope/caracal.git#v3.12.0"
args:
viewer: "v3.12.1"
depends_on:
- "ferretdb"
ports:
- "4010:4010"
container_name: ca-back
restart: always
logging:
options:
max-file: "5"
max-size: "10m"
volumes:
- ./images/:/images/
- ./config/login.html:/src/static/login.html
- ./jwt_keys/:/src/keys/
- ./config/routes.json:/src/routes.json
- ./config/contentSecurityPolicy.json:/src/contentSecurityPolicy.json
environment:
DISABLE_SEC: "true"
JWK_URL: "http://ca-back:4010/keycloak/realms/camic/protocol/openid-connect/certs"
IIP_PATH: "http://ca-iip:8080/fcgi-bin/iipsrv.fcgi"
MONGO_URI: "mongodb://ca-ferretdb"
GENERATE_KEY_IF_MISSING: "true"
iip:
image: camicroscope/iipimage:version-3.11.0
container_name: ca-iip
logging:
options:
max-file: "5"
max-size: "10m"
restart: always
volumes:
- ./images/:/images/
loader:
build: "https://github.com/camicroscope/SlideLoader.git#v3.12.0"
container_name: ca-load
restart: always
logging:
options:
max-file: "5"
max-size: "10m"
volumes:
- ./images/:/images/
environment:
DICOM_PORT: "11112"
DICOM_UI_PORT: "8042"