Skip to content

The Open Source DocuSign Alternative.

fix: remove minio from development compose (#3441)

Lucas Smithd4e6eeaf880d
diff --git a/.env.example b/.env.example
index 4d409e798..61816e565 100644
--- a/.env.example
+++ b/.env.example
@@ -91,18 +91,18 @@ NEXT_PRIVATE_USE_LEGACY_SIGNING_SUBFILTER=
# OPTIONAL: Defines the storage transport to use. Available options: database (default) | s3
NEXT_PUBLIC_UPLOAD_TRANSPORT="database"
# OPTIONAL: Defines the endpoint to use for the S3 storage transport. Relevant when using third-party S3-compatible providers.
-NEXT_PRIVATE_UPLOAD_ENDPOINT="http://127.0.0.1:9002"
+NEXT_PRIVATE_UPLOAD_ENDPOINT=
# OPTIONAL: Defines the force path style to use for the S3 storage transport. Relevant when using third-party S3-compatible providers.
# This will change it from using virtual hosts <bucket>.domain.com/<path> to fully qualified paths domain.com/<bucket>/<path>
NEXT_PRIVATE_UPLOAD_FORCE_PATH_STYLE="false"
# OPTIONAL: Defines the region to use for the S3 storage transport. Defaults to us-east-1.
-NEXT_PRIVATE_UPLOAD_REGION="unknown"
-# REQUIRED: Defines the bucket to use for the S3 storage transport.
-NEXT_PRIVATE_UPLOAD_BUCKET="documenso"
+NEXT_PRIVATE_UPLOAD_REGION="us-east-1"
+# REQUIRED when using S3: Defines the bucket to use for the S3 storage transport.
+NEXT_PRIVATE_UPLOAD_BUCKET=
# OPTIONAL: Defines the access key ID to use for the S3 storage transport.
-NEXT_PRIVATE_UPLOAD_ACCESS_KEY_ID="documenso"
+NEXT_PRIVATE_UPLOAD_ACCESS_KEY_ID=
# OPTIONAL: Defines the secret access key to use for the S3 storage transport.
-NEXT_PRIVATE_UPLOAD_SECRET_ACCESS_KEY="password"
+NEXT_PRIVATE_UPLOAD_SECRET_ACCESS_KEY=
# [[SMTP]]
# OPTIONAL: Defines the transport to use for sending emails. Available options: smtp-auth (default) | smtp-api | resend | mailchannels
diff --git a/ARCHITECTURE.md b/ARCHITECTURE.md
index d3cee2f37..feeae8349 100644
--- a/ARCHITECTURE.md
+++ b/ARCHITECTURE.md
@@ -344,7 +344,6 @@ npm run test:e2e
| --------------- | ---------- |
| PostgreSQL | 54320 |
| Inbucket (Mail) | 9000 |
-| MinIO (S3) | 9001, 9002 |
## Environment Variables Summary
diff --git a/README.md b/README.md
index ad4d7c5b9..397a76f4c 100644
--- a/README.md
+++ b/README.md
@@ -148,8 +148,6 @@ npm run d
- **Port**: 54320
- **Connection**: Use your favorite database client to connect using the provided port.
-4. **S3 Storage Dashboard** - http://localhost:9001
-
## Developer Setup
### Manual Setup
diff --git a/apps/docs/content/docs/developers/local-development/quickstart.mdx b/apps/docs/content/docs/developers/local-development/quickstart.mdx
index 705a452ca..6215d7fc0 100644
--- a/apps/docs/content/docs/developers/local-development/quickstart.mdx
+++ b/apps/docs/content/docs/developers/local-development/quickstart.mdx
@@ -83,7 +83,6 @@ You can access the following services:
- Database Connection Details:
- Port: 54320
- Connection: Use your favorite database client to connect to the database.
-- S3 Storage Dashboard - http://localhost:9001
## See Also
diff --git a/apps/docs/content/docs/self-hosting/configuration/storage.mdx b/apps/docs/content/docs/self-hosting/configuration/storage.mdx
index 590ff9629..da9eab4c2 100644
--- a/apps/docs/content/docs/self-hosting/configuration/storage.mdx
+++ b/apps/docs/content/docs/self-hosting/configuration/storage.mdx
@@ -61,7 +61,7 @@ No configuration required. Database storage is enabled when `NEXT_PUBLIC_UPLOAD_
## S3 Configuration
-S3 storage is recommended for production deployments. Documenso supports AWS S3 and any S3-compatible storage service.
+S3 storage is recommended for production deployments. Documenso supports AWS S3 and custom endpoints for S3-compatible storage services.
### Required Variables
@@ -157,90 +157,29 @@ NEXT_PRIVATE_UPLOAD_SECRET_ACCESS_KEY=wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
---
-## MinIO Setup
-
-MinIO is a self-hosted S3-compatible object storage server.
-
-{/* prettier-ignore */}
-<Steps>
-<Step>
-### Deploy MinIO
-
-Using Docker:
-
-```bash
-docker run -d \
- --name minio \
- -p 9000:9000 \
- -p 9001:9001 \
- -e MINIO_ROOT_USER=minioadmin \
- -e MINIO_ROOT_PASSWORD=minioadmin \
- -v minio_data:/data \
- minio/minio server /data --console-address ":9001"
-```
-
-Using Docker Compose with Documenso:
-
-```yaml
-services:
- minio:
- image: minio/minio
- command: server /data --console-address ":9001"
- ports:
- - '9000:9000'
- - '9001:9001'
- environment:
- MINIO_ROOT_USER: minioadmin
- MINIO_ROOT_PASSWORD: minioadmin
- volumes:
- - minio_data:/data
-
-volumes:
- minio_data:
-```
-
-</Step>
-<Step>
-### Create a Bucket
+## Other S3-Compatible Services
-Access the MinIO Console at `http://localhost:9001` and create a bucket, or use the CLI:
+To connect to an S3-compatible storage service, configure the endpoint and enable path-style URLs if required.
-```bash
-# Install MinIO client
-mc alias set myminio http://localhost:9000 minioadmin minioadmin
+<Callout type="info">
+ Set `NEXT_PRIVATE_UPLOAD_FORCE_PATH_STYLE=true` for S3-compatible services that don't support
+ virtual-hosted bucket URLs.
+</Callout>
-# Create bucket
-mc mb myminio/documenso
-```
+### Self-Hosted Providers
-</Step>
-<Step>
-### Configure Environment Variables
+If you prefer to run your own object storage, consider these S3-compatible options:
-```bash
-NEXT_PUBLIC_UPLOAD_TRANSPORT=s3
-NEXT_PRIVATE_UPLOAD_BUCKET=documenso
-NEXT_PRIVATE_UPLOAD_ENDPOINT=http://minio:9000
-NEXT_PRIVATE_UPLOAD_FORCE_PATH_STYLE=true
-NEXT_PRIVATE_UPLOAD_ACCESS_KEY_ID=minioadmin
-NEXT_PRIVATE_UPLOAD_SECRET_ACCESS_KEY=minioadmin
-NEXT_PRIVATE_UPLOAD_REGION=us-east-1
-```
+- [SeaweedFS](https://github.com/seaweedfs/seaweedfs) — A distributed storage system with an S3 API, filesystem features, and a single-node Docker setup.
+- [RustFS](https://docs.rustfs.com/en/installation/container) — An S3-compatible object storage system written in Rust, with Docker support and a web console.
-</Step>
-</Steps>
+These providers are optional and are not included in the default Docker Compose setup, which uses PostgreSQL for document storage. To connect one, set `NEXT_PUBLIC_UPLOAD_TRANSPORT=s3` and configure `NEXT_PRIVATE_UPLOAD_ENDPOINT`, the bucket, region, and access credentials for your deployment.
-<Callout type="info">
- Set `NEXT_PRIVATE_UPLOAD_FORCE_PATH_STYLE=true` for MinIO and other S3-compatible services that
- don't support virtual-hosted bucket URLs.
+<Callout type="warn">
+ These are alternatives to evaluate, not verified Documenso integrations. Test uploads, downloads,
+ presigned URLs, and CORS before using either provider in production.
</Callout>
----
-
-## Other S3-Compatible Services
-
-Documenso works with any S3-compatible storage service. Configure the endpoint and enable path-style URLs if required.
-
### Cloudflare R2
```bash
@@ -675,4 +614,4 @@ Default limit is 50MB per request.
- [Database Configuration](/docs/self-hosting/configuration/database) - Configure PostgreSQL
- [Environment Variables](/docs/self-hosting/configuration/environment) - Complete configuration reference
- [Backups](/docs/self-hosting/maintenance/backups) - Backup strategies for both storage backends
-- [Docker Compose](/docs/self-hosting/deployment/docker-compose) - Deploy with MinIO for local storage
+- [Docker Compose](/docs/self-hosting/deployment/docker-compose) - Deploy with PostgreSQL and configure external S3 storage
diff --git a/apps/docs/content/docs/self-hosting/getting-started/quick-start.mdx b/apps/docs/content/docs/self-hosting/getting-started/quick-start.mdx
index 9f913c766..43c5fc26e 100644
--- a/apps/docs/content/docs/self-hosting/getting-started/quick-start.mdx
+++ b/apps/docs/content/docs/self-hosting/getting-started/quick-start.mdx
@@ -130,9 +130,10 @@ The quick start setup runs the following containers:
| `database` | PostgreSQL database | 54320 |
| `inbucket` | Local email testing server | 9000 (web UI), 2500 (SMTP) |
| `redis` | Cache and background job queue | 63790 |
-| `minio` | S3-compatible storage | 9002 (API), 9001 (console) |
| `gotenberg` | Document conversion (optional) | 3005 |
+Documents are stored in PostgreSQL by default. To use external S3-compatible storage, see [Storage Configuration](/docs/self-hosting/configuration/storage).
+
The local email server is [Inbucket](https://www.inbucket.org/). Open its web UI at [http://localhost:9000](http://localhost:9000) to view emails Documenso sends during development. For your own deployment you can use any SMTP-compatible mailserver, such as Inbucket, [Mailpit](https://github.com/axllent/mailpit), or [Mailhog](https://github.com/mailhog/MailHog).
## Useful Commands
diff --git a/apps/docs/content/docs/self-hosting/getting-started/requirements.mdx b/apps/docs/content/docs/self-hosting/getting-started/requirements.mdx
index b75069906..c9eb688ed 100644
--- a/apps/docs/content/docs/self-hosting/getting-started/requirements.mdx
+++ b/apps/docs/content/docs/self-hosting/getting-started/requirements.mdx
@@ -91,11 +91,12 @@ These services are not required but improve functionality or scalability:
By default, Documenso stores documents in the PostgreSQL database. For production deployments with significant document volume, use S3-compatible storage:
- Amazon S3
-- MinIO
- Cloudflare R2
- DigitalOcean Spaces
- Any S3-compatible provider
+For self-hosted object storage, [SeaweedFS](https://github.com/seaweedfs/seaweedfs) and [RustFS](https://docs.rustfs.com/en/installation/container) are optional S3-compatible alternatives to evaluate. They are not bundled with Documenso; see [Self-Hosted Providers](/docs/self-hosting/configuration/storage#self-hosted-providers) for compatibility considerations.
+
See [Storage Configuration](/docs/self-hosting/configuration/storage) for setup details.
### Background Jobs
diff --git a/apps/docs/content/docs/self-hosting/getting-started/tips.mdx b/apps/docs/content/docs/self-hosting/getting-started/tips.mdx
index f4ff0e0a5..7b77abdf6 100644
--- a/apps/docs/content/docs/self-hosting/getting-started/tips.mdx
+++ b/apps/docs/content/docs/self-hosting/getting-started/tips.mdx
@@ -138,7 +138,7 @@ NEXT_PRIVATE_UPLOAD_ACCESS_KEY_ID=your-key
NEXT_PRIVATE_UPLOAD_SECRET_ACCESS_KEY=your-secret
```
-Any S3-compatible provider works: AWS S3, MinIO, Cloudflare R2, DigitalOcean Spaces.
+S3-compatible options include AWS S3, Cloudflare R2, and DigitalOcean Spaces. For self-hosted storage, consider [SeaweedFS](https://github.com/seaweedfs/seaweedfs) or [RustFS](https://docs.rustfs.com/en/installation/container); these are alternatives to evaluate, not verified Documenso integrations.
See [Storage Configuration](/docs/self-hosting/configuration/storage) for full setup details.
diff --git a/apps/docs/content/docs/self-hosting/maintenance/backups.mdx b/apps/docs/content/docs/self-hosting/maintenance/backups.mdx
index 619901469..71463298d 100644
--- a/apps/docs/content/docs/self-hosting/maintenance/backups.mdx
+++ b/apps/docs/content/docs/self-hosting/maintenance/backups.mdx
@@ -159,7 +159,7 @@ Document the certificate passphrase (`NEXT_PRIVATE_SIGNING_PASSPHRASE`) in a sec
If using S3 storage (`NEXT_PUBLIC_UPLOAD_TRANSPORT=s3`), back up your S3 bucket.
-<Tabs items={['AWS S3', 'S3-Compatible (MinIO, etc.)']}>
+<Tabs items={['AWS S3', 'S3-Compatible']}>
<Tab value="AWS S3">
Enable versioning on your bucket:
@@ -179,7 +179,7 @@ aws s3 sync s3://your-documenso-bucket /backup/documenso/documents/
```
</Tab>
-<Tab value="S3-Compatible (MinIO, etc.)">
+<Tab value="S3-Compatible">
Use the same commands with the `--endpoint-url` flag:
diff --git a/docker/development/compose.yml b/docker/development/compose.yml
index 149a577ce..f6f097c4d 100644
--- a/docker/development/compose.yml
+++ b/docker/development/compose.yml
@@ -34,20 +34,6 @@ services:
volumes:
- redis:/data
- minio:
- image: minio/minio
- container_name: minio
- ports:
- - 9002:9002
- - 9001:9001
- volumes:
- - minio:/data
- environment:
- MINIO_ROOT_USER: documenso
- MINIO_ROOT_PASSWORD: password
- entrypoint: sh
- command: -c 'mkdir -p /data/documenso && minio server /data --console-address ":9001" --address ":9002"'
-
gotenberg:
build:
context: .
@@ -95,6 +81,5 @@ services:
start_period: 20s
volumes:
- minio:
redis:
documenso_database: