Skip to content

OpenProject is the leading open source project management software for product, project and portfolio management. A powerful Jira alternative with agile planning, issue tracking, roadmaps, Gantt charts, time tracking, collaboration features, and more. Available on premises or in the cloud. ⭐ Star us on GitHub

Add minio to dev setup to ease development of uploads against S3

Judith Roth3925c767d660
diff --git a/docker/dev/minio/.gitignore b/docker/dev/minio/.gitignore
new file mode 100644
index 00000000000..7376571d14b
--- /dev/null
+++ b/docker/dev/minio/.gitignore
@@ -0,0 +1 @@
+docker-compose.override.yml
diff --git a/docker/dev/minio/docker-compose.core-override.example.yml b/docker/dev/minio/docker-compose.core-override.example.yml
new file mode 100644
index 00000000000..d96da6fca65
--- /dev/null
+++ b/docker/dev/minio/docker-compose.core-override.example.yml
@@ -0,0 +1,17 @@
+# The following overrides should be copied to the core docker-compose.overrides.yml in the main directory.
+# Only use them if you DO NOT use the TLS setup.
+# If you use the TLS setup, ignore the following values and instead see
+# tls/docker-compose.core-override.example.yml for the minio TLS setup values.
+
+services:
+ backend:
+ environment:
+ OPENPROJECT_ATTACHMENTS__STORAGE: "fog"
+ OPENPROJECT_FOG_DIRECTORY: "openproject-uploads"
+ OPENPROJECT_FOG_CREDENTIALS_PROVIDER: "AWS" # Minio is S3 compliant, so we can use the AWS provider
+ OPENPROJECT_FOG_CREDENTIALS_ENDPOINT: "http://127.0.0.1:9000" # URI for your MinIO instance
+ OPENPROJECT_FOG_CREDENTIALS_AWS__ACCESS__KEY__ID: "minioadmin"
+ OPENPROJECT_FOG_CREDENTIALS_AWS__SECRET__ACCESS__KEY: "minioadmin"
+ OPENPROJECT_FOG_CREDENTIALS_PATH__STYLE: "true"
+ OPENPROJECT_FOG_CREDENTIALS_REGION: "us-east-1"
+ OPENPROJECT_DEV_EXTRA_HOSTS: "${OPENPROJECT_DEV_HOST},http://127.0.0.1:9000"
diff --git a/docker/dev/minio/docker-compose.yml b/docker/dev/minio/docker-compose.yml
new file mode 100644
index 00000000000..778277abfc6
--- /dev/null
+++ b/docker/dev/minio/docker-compose.yml
@@ -0,0 +1,44 @@
+services:
+ # local S3 storage for development
+ minio:
+ image: minio/minio:latest
+ ports:
+ - "9000:9000" # API port
+ - "9001:9001" # Admin Console (Management UI) port
+ volumes:
+ - minio_data:/data
+ environment:
+ MINIO_ROOT_USER: minioadmin
+ MINIO_ROOT_PASSWORD: minioadmin
+ entrypoint: sh
+ # minio automatically maps folders to buckets, so we create the bucket here before starting the server
+ command: -c 'mkdir -p /data/openproject-uploads && /usr/bin/minio server --console-address ":9001" /data'
+ networks:
+ - external
+ labels:
+ - "traefik.enable=true"
+ # MinIO API
+ - "traefik.http.routers.minio.entrypoints=websecure"
+ - "traefik.http.routers.minio.rule=Host(`minio.local`)"
+ - "traefik.http.routers.minio.service=minio"
+ - "traefik.http.routers.minio.tls.certresolver=step"
+ - "traefik.http.services.minio.loadbalancer.server.port=9000"
+ # MinIO Admin Console (Management UI)
+ - "traefik.http.routers.minioadmin.entrypoints=websecure"
+ - "traefik.http.routers.minioadmin.rule=Host(`minioadmin.local`)"
+ - "traefik.http.routers.minioadmin.service=minioadmin"
+ - "traefik.http.routers.minioadmin.tls.certresolver=step"
+ - "traefik.http.services.minioadmin.loadbalancer.server.port=9001"
+ healthcheck:
+ test: [ "CMD", "mc", "ready", "local" ]
+ interval: 30s
+ timeout: 20s
+ retries: 3
+
+volumes:
+ minio_data:
+
+networks:
+ external:
+ name: gateway
+ external: true
diff --git a/docker/dev/tls/docker-compose.core-override.example.yml b/docker/dev/tls/docker-compose.core-override.example.yml
index ffd80c441c8..80850fe7921 100644
--- a/docker/dev/tls/docker-compose.core-override.example.yml
+++ b/docker/dev/tls/docker-compose.core-override.example.yml
@@ -14,6 +14,16 @@ x-op-env-override: &environment
# OPENPROJECT_OPENID__CONNECT_KEYCLOAK_TOKEN__ENDPOINT: /realms/<REALM>/protocol/openid-connect/token
# OPENPROJECT_OPENID__CONNECT_KEYCLOAK_USERINFO__ENDPOINT: /realms/<REALM>/protocol/openid-connect/userinfo
# OPENPROJECT_OPENID__CONNECT_KEYCLOAK_END__SESSION__ENDPOINT: https://keycloak.local/realms/<REALM>/protocol/openid-connect/logout
+ # uncomment the following for using minio (local S3) as file storage with TLS support:
+ # OPENPROJECT_ATTACHMENTS__STORAGE: "fog"
+ # OPENPROJECT_FOG_DIRECTORY: "openproject-uploads"
+ # OPENPROJECT_FOG_CREDENTIALS_PROVIDER: "AWS" # Minio is S3 compliant, so we can use the AWS provider
+ # OPENPROJECT_FOG_CREDENTIALS_ENDPOINT: "https://minio.local"
+ # OPENPROJECT_FOG_CREDENTIALS_AWS__ACCESS__KEY__ID: "minioadmin"
+ # OPENPROJECT_FOG_CREDENTIALS_AWS__SECRET__ACCESS__KEY: "minioadmin"
+ # OPENPROJECT_FOG_CREDENTIALS_PATH__STYLE: "true"
+ # OPENPROJECT_FOG_CREDENTIALS_REGION: "us-east-1"
+ # OPENPROJECT_DEV_EXTRA_HOSTS: "${OPENPROJECT_DEV_HOST},minio.local"
services:
backend:
diff --git a/docker/dev/tls/docker-compose.override.example.yml b/docker/dev/tls/docker-compose.override.example.yml
index f8f9e1ff57a..37ab60bb7ed 100644
--- a/docker/dev/tls/docker-compose.override.example.yml
+++ b/docker/dev/tls/docker-compose.override.example.yml
@@ -13,3 +13,5 @@ services:
- gitlab.local
- keycloak.local
- hocuspocus.local
+ - minio.local
+ - minioadmin.local