Skip to content

Commit b398bdc

Browse files
max-moserntarocco
authored andcommitted
s3: update some wording in the text
1 parent 1eb00c1 commit b398bdc

File tree

1 file changed

+5
-5
lines changed
  • docs/operate/customize/file-uploads

1 file changed

+5
-5
lines changed

docs/operate/customize/file-uploads/s3.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,14 @@ InvenioRDM provides seamless integration with S3-compatible object storage syste
1111
This section assumes you chose S3 when bootstrapping the instance.
1212

1313
!!! warning "License compatibility"
14-
The MinIO Object Store is licensed under Affero General Public License Version 3 (AGPLv3), see the [compliance page](https://min.io/compliance). When using MinIO, make sure that your instance's license is compliant.
14+
The MinIO Object Store is licensed under Affero General Public License Version 3 ([AGPLv3](https://spdx.org/licenses/AGPL-3.0.html)), see the [compliance page](https://min.io/compliance). When using MinIO, make sure that your instance's license is compliant.
1515

1616
After having setup your MinIO application, you can review the settings below.
1717

1818
### Bucket and data location
19-
A default bucket (`default`) is created automatically in your MinIO container. This bucket will be used as the default files' location for your InvenioRDM instance.
19+
A default bucket (`default`) is created automatically in your MinIO container. This bucket will be used as the default files' location for your InvenioRDM instance if you choose `s3` as file storage during project initialization.
2020

21-
If you want to change the bucket name, open a shell window and type `pipenv run invenio files location s3-default s3://new-bucket --default`. You will also need to manually create the new bucket in minio or your S3 storage system. The new bucket will only be used for new records or drafts (existing drafts and records will use `default`).
21+
If you want to change the bucket name, open a shell window and type `pipenv run invenio files location s3-default s3://new-bucket --default`. You will also need to manually create the new bucket in MinIO or your S3 storage system. The new bucket will only be used for new records or drafts (existing drafts and records will use `default`).
2222

2323
### Credentials
2424
The last step is to set your credentials so your instance can authenticate against the S3 container.
@@ -29,13 +29,13 @@ By default, the `ROOT_USER` and the `ROOT_USER_PASSWORD` of MinIO are "CHANGE_ME
2929
- In the `docker-services.yaml` file change the `MINIO_ROOT_USER` and `MINIO_ROOT_PASSWORD` values.
3030
- Update the credentials:
3131
- You should be using environment variables to inject secrets. Define `INVENIO_S3_ACCESS_KEY_ID` for the user and `INVENIO_S3_SECRET_ACCESS_KEY` for the password.
32-
- If you are developing locally, you can change your `invenio.cfg` and set the user to `S3_ACCESS_KEY_ID` and the password to `S3_SECRET_ACCESS_KEY`.
32+
- If you are developing locally, you can change your `invenio.cfg` and set the value of `S3_ACCESS_KEY_ID` to the desired username and the value of `S3_SECRET_ACCESS_KEY` to the password.
3333
- Start your services: `invenio-cli services start`.
3434

3535
It's done! Ready to roll!
3636

3737
## Amazon S3
38-
If you're using Amazon S3, you'll want to provide the endpoint url and set the region if you're not using us-east-1 (the default) like
38+
If you're using Amazon S3, you'll want to provide the endpoint URL and set the region (if you're not using the default of `us-east-1`):
3939

4040
```
4141
S3_ENDPOINT_URL='https://s3.us-west-2.amazonaws.com/'

0 commit comments

Comments
 (0)