Skip to content

Commit 2b4706e

Browse files
TheMeinerLPTheMeinerLP
committed
chore(docs): Update README with new S3 storage configuration format and options
1 parent ba803a8 commit 2b4706e

File tree

1 file changed

+85
-64
lines changed

1 file changed

+85
-64
lines changed

‎README.md‎

Lines changed: 85 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -34,98 +34,119 @@ This addon is particularly useful for:
3434
## Installation
3535

3636
1. Download the latest release of BlueMapS3Storage from the [releases page](https://github.com/TheMeinerLP/BlueMapS3Storage/releases)
37-
2. Place the JAR file in the `plugins/BlueMap/addons` directory of your server
37+
2. Place the JAR file in the `plugins/BlueMap/packs` directory of your server
3838
3. Restart your server or reload BlueMap
3939

4040
## Configuration
4141

42-
To use S3 storage with BlueMap, you need to modify your BlueMap configuration to use the S3 storage type. Add the following to your `bluemap.conf` file:
42+
To use S3 storage with BlueMap, you need to create or modify the S3 storage configuration file. Create a file named `s3.conf` in the `plugins/BlueMap/storages` directory with the following content:
4343

4444
```hocon
45-
storage {
46-
type: "themeinerlp:s3"
47-
48-
# S3 bucket name
49-
bucketName: "bluemap-storage"
50-
51-
# AWS region or "Minio" for MinIO
52-
region: "us-east-1"
53-
54-
# S3 credentials
55-
accessKeyId: "your-access-key"
56-
secretAccessKey: "your-secret-key"
57-
58-
# Optional: Custom endpoint URL for S3-compatible services
59-
# Leave empty for AWS S3
60-
endpointUrl: "http://localhost:9000"
61-
62-
# Optional: Enable path-style access instead of virtual-hosted style
63-
# Set to "true" for MinIO and some other S3-compatible services
64-
pathStyleAccessEnabled: "true"
65-
66-
# Optional: Compression type to use for storing data
67-
# Options include: "gzip" (default), "none", or other compression types supported by BlueMap
68-
compression: "gzip"
69-
}
45+
## ##
46+
## BlueMap ##
47+
## Storage-Config ##
48+
## ##
49+
50+
# The storage-type of this storage.
51+
# Depending on this setting, different config-entries are allowed/expected in this config file.
52+
# Don't change this value! (If you want a different storage-type, check out the other example-configs)
53+
storage-type: "themeinerlp:s3"
54+
55+
# The compression-type that bluemap will use to compress generated map-data.
56+
# Available compression-types are:
57+
# - gzip
58+
# - zstd
59+
# - deflate
60+
# - none
61+
# The default is: gzip
62+
compression: gzip
63+
64+
# The S3 storage
65+
bucket-name: "bluemap-storage"
66+
67+
# AWS region or "Minio" for MinIO
68+
region: "us-east-1"
69+
70+
# S3 credentials
71+
access-key-id: "your-access-key"
72+
secret-access-key: "your-secret-key"
73+
74+
# Optional: Custom endpoint URL for S3-compatible services
75+
# Leave empty for AWS S3
76+
endpoint-url: "http://localhost:9000"
77+
78+
# Optional: Enable path-style access instead of virtual-hosted style
79+
# Set to "true" for MinIO and some other S3-compatible services
80+
path-style-access-enabled: "true"
7081
```
7182

7283
### Configuration Options
7384

7485
| Option | Description | Default |
7586
|--------|-------------|---------|
76-
| `bucketName` | The name of the S3 bucket to use | `bluemap-storage` |
77-
| `region` | The AWS region where the bucket is located | `Minio` |
78-
| `accessKeyId` | The AWS access key ID for authentication | `bluemap` |
79-
| `secretAccessKey` | The AWS secret access key for authentication | `bluemap-secret` |
80-
| `endpointUrl` | Optional: The endpoint URL for S3-compatible services (leave empty for AWS S3) | `http://localhost:9000` |
81-
| `pathStyleAccessEnabled` | Optional: Enable path-style access instead of virtual-hosted style (true/false) | `true` |
82-
| `compression` | Optional: The compression type to use for storing data (options: "gzip", "none", or other types supported by BlueMap) | `gzip` |
87+
| `storage-type` | The storage type identifier (don't change this value) | `themeinerlp:s3` |
88+
| `compression` | The compression type to use for storing data (options: "gzip", "zstd", "deflate", "none") | `gzip` |
89+
| `bucket-name` | The name of the S3 bucket to use | `bluemap-storage` |
90+
| `region` | The AWS region where the bucket is located | `us-east-1` |
91+
| `access-key-id` | The AWS access key ID for authentication | `bluemap` |
92+
| `secret-access-key` | The AWS secret access key for authentication | `bluemap-secret` |
93+
| `endpoint-url` | Optional: The endpoint URL for S3-compatible services (leave empty for AWS S3) | `http://localhost:9000` |
94+
| `path-style-access-enabled` | Optional: Enable path-style access instead of virtual-hosted style (true/false) | `true` |
8395

8496
## Usage Examples
8597

8698
### AWS S3
8799

88100
```hocon
89-
storage {
90-
type: "themeinerlp:s3"
91-
bucketName: "my-bluemap-bucket"
92-
region: "us-east-1"
93-
accessKeyId: "AKIAIOSFODNN7EXAMPLE"
94-
secretAccessKey: "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"
95-
endpointUrl: ""
96-
pathStyleAccessEnabled: "false"
97-
compression: "gzip"
98-
}
101+
## ##
102+
## BlueMap ##
103+
## Storage-Config ##
104+
## ##
105+
106+
storage-type: "themeinerlp:s3"
107+
compression: gzip
108+
bucket-name: "my-bluemap-bucket"
109+
region: "us-east-1"
110+
access-key-id: "AKIAIOSFODNN7EXAMPLE"
111+
secret-access-key: "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"
112+
endpoint-url: ""
113+
path-style-access-enabled: "false"
99114
```
100115

101116
### MinIO
102117

103118
```hocon
104-
storage {
105-
type: "themeinerlp:s3"
106-
bucketName: "bluemap"
107-
region: "Minio"
108-
accessKeyId: "minioadmin"
109-
secretAccessKey: "minioadmin"
110-
endpointUrl: "http://minio-server:9000"
111-
pathStyleAccessEnabled: "true"
112-
compression: "gzip"
113-
}
119+
## ##
120+
## BlueMap ##
121+
## Storage-Config ##
122+
## ##
123+
124+
storage-type: "themeinerlp:s3"
125+
compression: gzip
126+
bucket-name: "bluemap"
127+
region: "us-east-1"
128+
access-key-id: "minioadmin"
129+
secret-access-key: "minioadmin"
130+
endpoint-url: "http://minio-server:9000"
131+
path-style-access-enabled: "true"
114132
```
115133

116134
### DigitalOcean Spaces
117135

118136
```hocon
119-
storage {
120-
type: "themeinerlp:s3"
121-
bucketName: "bluemap-maps"
122-
region: "nyc3"
123-
accessKeyId: "your-spaces-key"
124-
secretAccessKey: "your-spaces-secret"
125-
endpointUrl: "https://nyc3.digitaloceanspaces.com"
126-
pathStyleAccessEnabled: "false"
127-
compression: "gzip"
128-
}
137+
## ##
138+
## BlueMap ##
139+
## Storage-Config ##
140+
## ##
141+
142+
storage-type: "themeinerlp:s3"
143+
compression: gzip
144+
bucket-name: "bluemap-maps"
145+
region: "nyc3"
146+
access-key-id: "your-spaces-key"
147+
secret-access-key: "your-spaces-secret"
148+
endpoint-url: "https://nyc3.digitaloceanspaces.com"
149+
path-style-access-enabled: "false"
129150
```
130151

131152
## Building from Source

0 commit comments

Comments
 (0)