Skip to content

Commit 86d3f62

Browse files
committed
docs: document credentials chain for minio access
1 parent 03bb387 commit 86d3f62

File tree

2 files changed

+20
-8
lines changed

2 files changed

+20
-8
lines changed

custom/conf/app.example.ini

+8-2
Original file line numberDiff line numberDiff line change
@@ -1872,7 +1872,10 @@ LEVEL = Info
18721872
;; Minio endpoint to connect only available when STORAGE_TYPE is `minio`
18731873
;MINIO_ENDPOINT = localhost:9000
18741874
;;
1875-
;; Minio accessKeyID to connect only available when STORAGE_TYPE is `minio`
1875+
;; Minio accessKeyID to connect only available when STORAGE_TYPE is `minio`.
1876+
;; If not provided and STORAGE_TYPE is `minio`, will search for credentials in known
1877+
;; environment variables (MINIO_ACCESS_KEY_ID, AWS_ACCESS_KEY_ID), credentials files
1878+
;; (~/.mc/config.json, ~/.aws/credentials), and EC2 instance metadata.
18761879
;MINIO_ACCESS_KEY_ID =
18771880
;;
18781881
;; Minio secretAccessKey to connect only available when STORAGE_TYPE is `minio`
@@ -2573,7 +2576,10 @@ LEVEL = Info
25732576
;; Minio endpoint to connect only available when STORAGE_TYPE is `minio`
25742577
;MINIO_ENDPOINT = localhost:9000
25752578
;;
2576-
;; Minio accessKeyID to connect only available when STORAGE_TYPE is `minio`
2579+
;; Minio accessKeyID to connect only available when STORAGE_TYPE is `minio`.
2580+
;; If not provided and STORAGE_TYPE is `minio`, will search for credentials in known
2581+
;; environment variables (MINIO_ACCESS_KEY_ID, AWS_ACCESS_KEY_ID), credentials files
2582+
;; (~/.mc/config.json, ~/.aws/credentials), and EC2 instance metadata.
25772583
;MINIO_ACCESS_KEY_ID =
25782584
;;
25792585
;; Minio secretAccessKey to connect only available when STORAGE_TYPE is `minio`

docs/content/administration/config-cheat-sheet.en-us.md

+12-6
Original file line numberDiff line numberDiff line change
@@ -843,7 +843,7 @@ Default templates for project boards:
843843
- `SERVE_DIRECT`: **false**: Allows the storage driver to redirect to authenticated URLs to serve files directly. Currently, only Minio/S3 is supported via signed URLs, local does nothing.
844844
- `PATH`: **attachments**: Path to store attachments only available when STORAGE_TYPE is `local`, relative paths will be resolved to `${AppDataPath}/${attachment.PATH}`.
845845
- `MINIO_ENDPOINT`: **localhost:9000**: Minio endpoint to connect only available when STORAGE_TYPE is `minio`
846-
- `MINIO_ACCESS_KEY_ID`: Minio accessKeyID to connect only available when STORAGE_TYPE is `minio`
846+
- `MINIO_ACCESS_KEY_ID`: Minio accessKeyID to connect only available when STORAGE_TYPE is `minio`. If not provided and STORAGE_TYPE is `minio`, will search for credentials in known environment variables (MINIO_ACCESS_KEY_ID, AWS_ACCESS_KEY_ID), credentials files (~/.mc/config.json, ~/.aws/credentials), and EC2 instance metadata.
847847
- `MINIO_SECRET_ACCESS_KEY`: Minio secretAccessKey to connect only available when STORAGE_TYPE is `minio`
848848
- `MINIO_BUCKET`: **gitea**: Minio bucket to store the attachments only available when STORAGE_TYPE is `minio`
849849
- `MINIO_LOCATION`: **us-east-1**: Minio location to create bucket only available when STORAGE_TYPE is `minio`
@@ -1274,7 +1274,7 @@ is `data/lfs` and the default of `MINIO_BASE_PATH` is `lfs/`.
12741274
- `SERVE_DIRECT`: **false**: Allows the storage driver to redirect to authenticated URLs to serve files directly. Currently, only Minio/S3 is supported via signed URLs, local does nothing.
12751275
- `PATH`: **./data/lfs**: Where to store LFS files, only available when `STORAGE_TYPE` is `local`. If not set it fall back to deprecated LFS_CONTENT_PATH value in [server] section.
12761276
- `MINIO_ENDPOINT`: **localhost:9000**: Minio endpoint to connect only available when `STORAGE_TYPE` is `minio`
1277-
- `MINIO_ACCESS_KEY_ID`: Minio accessKeyID to connect only available when `STORAGE_TYPE` is `minio`
1277+
- `MINIO_ACCESS_KEY_ID`: Minio accessKeyID to connect only available when STORAGE_TYPE is `minio`. If not provided and STORAGE_TYPE is `minio`, will search for credentials in known environment variables (MINIO_ACCESS_KEY_ID, AWS_ACCESS_KEY_ID), credentials files (~/.mc/config.json, ~/.aws/credentials), and EC2 instance metadata.
12781278
- `MINIO_SECRET_ACCESS_KEY`: Minio secretAccessKey to connect only available when `STORAGE_TYPE is` `minio`
12791279
- `MINIO_BUCKET`: **gitea**: Minio bucket to store the lfs only available when `STORAGE_TYPE` is `minio`
12801280
- `MINIO_LOCATION`: **us-east-1**: Minio location to create bucket only available when `STORAGE_TYPE` is `minio`
@@ -1290,7 +1290,7 @@ Default storage configuration for attachments, lfs, avatars, repo-avatars, repo-
12901290
- `STORAGE_TYPE`: **local**: Storage type, `local` for local disk or `minio` for s3 compatible object storage service.
12911291
- `SERVE_DIRECT`: **false**: Allows the storage driver to redirect to authenticated URLs to serve files directly. Currently, only Minio/S3 is supported via signed URLs, local does nothing.
12921292
- `MINIO_ENDPOINT`: **localhost:9000**: Minio endpoint to connect only available when `STORAGE_TYPE` is `minio`
1293-
- `MINIO_ACCESS_KEY_ID`: Minio accessKeyID to connect only available when `STORAGE_TYPE` is `minio`
1293+
- `MINIO_ACCESS_KEY_ID`: Minio accessKeyID to connect only available when STORAGE_TYPE is `minio`. If not provided and STORAGE_TYPE is `minio`, will search for credentials in known environment variables (MINIO_ACCESS_KEY_ID, AWS_ACCESS_KEY_ID), credentials files (~/.mc/config.json, ~/.aws/credentials), and EC2 instance metadata.
12941294
- `MINIO_SECRET_ACCESS_KEY`: Minio secretAccessKey to connect only available when `STORAGE_TYPE is` `minio`
12951295
- `MINIO_BUCKET`: **gitea**: Minio bucket to store the data only available when `STORAGE_TYPE` is `minio`
12961296
- `MINIO_LOCATION`: **us-east-1**: Minio location to create bucket only available when `STORAGE_TYPE` is `minio`
@@ -1305,7 +1305,10 @@ The recommended storage configuration for minio like below:
13051305
STORAGE_TYPE = minio
13061306
; Minio endpoint to connect only available when STORAGE_TYPE is `minio`
13071307
MINIO_ENDPOINT = localhost:9000
1308-
; Minio accessKeyID to connect only available when STORAGE_TYPE is `minio`
1308+
; Minio accessKeyID to connect only available when STORAGE_TYPE is `minio`.
1309+
; If not provided and STORAGE_TYPE is `minio`, will search for credentials in known
1310+
; environment variables (MINIO_ACCESS_KEY_ID, AWS_ACCESS_KEY_ID), credentials files
1311+
; (~/.mc/config.json, ~/.aws/credentials), and EC2 instance metadata.
13091312
MINIO_ACCESS_KEY_ID =
13101313
; Minio secretAccessKey to connect only available when STORAGE_TYPE is `minio`
13111314
MINIO_SECRET_ACCESS_KEY =
@@ -1354,7 +1357,10 @@ STORAGE_TYPE = my_minio
13541357
STORAGE_TYPE = minio
13551358
; Minio endpoint to connect only available when STORAGE_TYPE is `minio`
13561359
MINIO_ENDPOINT = localhost:9000
1357-
; Minio accessKeyID to connect only available when STORAGE_TYPE is `minio`
1360+
; Minio accessKeyID to connect only available when STORAGE_TYPE is `minio`.
1361+
; If not provided and STORAGE_TYPE is `minio`, will search for credentials in known
1362+
; environment variables (MINIO_ACCESS_KEY_ID, AWS_ACCESS_KEY_ID), credentials files
1363+
; (~/.mc/config.json, ~/.aws/credentials), and EC2 instance metadata.
13581364
MINIO_ACCESS_KEY_ID =
13591365
; Minio secretAccessKey to connect only available when STORAGE_TYPE is `minio`
13601366
MINIO_SECRET_ACCESS_KEY =
@@ -1380,7 +1386,7 @@ is `data/repo-archive` and the default of `MINIO_BASE_PATH` is `repo-archive/`.
13801386
- `SERVE_DIRECT`: **false**: Allows the storage driver to redirect to authenticated URLs to serve files directly. Currently, only Minio/S3 is supported via signed URLs, local does nothing.
13811387
- `PATH`: **./data/repo-archive**: Where to store archive files, only available when `STORAGE_TYPE` is `local`.
13821388
- `MINIO_ENDPOINT`: **localhost:9000**: Minio endpoint to connect only available when `STORAGE_TYPE` is `minio`
1383-
- `MINIO_ACCESS_KEY_ID`: Minio accessKeyID to connect only available when `STORAGE_TYPE` is `minio`
1389+
- `MINIO_ACCESS_KEY_ID`: Minio accessKeyID to connect only available when STORAGE_TYPE is `minio`. If not provided and STORAGE_TYPE is `minio`, will search for credentials in known environment variables (MINIO_ACCESS_KEY_ID, AWS_ACCESS_KEY_ID), credentials files (~/.mc/config.json, ~/.aws/credentials), and EC2 instance metadata.
13841390
- `MINIO_SECRET_ACCESS_KEY`: Minio secretAccessKey to connect only available when `STORAGE_TYPE is` `minio`
13851391
- `MINIO_BUCKET`: **gitea**: Minio bucket to store the lfs only available when `STORAGE_TYPE` is `minio`
13861392
- `MINIO_LOCATION`: **us-east-1**: Minio location to create bucket only available when `STORAGE_TYPE` is `minio`

0 commit comments

Comments
 (0)