You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/develop/customize.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,6 +22,6 @@ Passing the `--no-install-js` option, skips re-installation of JS dependencies.
22
22
Go to the browser [*https://localhost:5000/*](https://localhost:5000) or refresh the page. And voilà! The logo has been changed!
23
23
24
24
!!! warning "That evil cache"
25
-
If you do not see it changing, check in an incognito window, the browser might have cached the logo.
25
+
If you do not see it changing, check in an incognito window; the browser might have cached the logo.
26
26
27
27
Need further customizations? Have you thought of creating your own extensions? How to add them to your InvenioRDM instance is explained in the next section - [here](../extensions/custom.md).
Copy file name to clipboardExpand all lines: docs/extensions/custom.md
+6-5Lines changed: 6 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,9 +1,9 @@
1
1
# Extensions
2
2
3
-
If you need to add custom functionalaty to your RDM instance you need to develop your own module. You can start it by using the [cookiecutter-invenio-module](https://github.com/inveniosoftware/cookiecutter-invenio-module) template. It will get you started in no time.
3
+
If you want to add custom functionality to your RDM instance, you need to develop your own module. You can start in no time by using the [cookiecutter-invenio-module](https://github.com/inveniosoftware/cookiecutter-invenio-module) template.
As you can see, `--pre` is optional, it is only needed when the package is in a pre-release state. In addition, note that you do not need to specify a local path, if the package is available e.g. via PyPi you can just install it by its name.
42
+
As you can see, `--pre` is optional. It is only needed when the package is in a pre-release state. In addition, note that you do not need to specify a local path. If the package is available e.g. via PyPi, you can just install it by its name.
Copy file name to clipboardExpand all lines: docs/extensions/index.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,4 +6,4 @@ InvenioRDM supports a great variety of extensions that can help you adapt it to
6
6
7
7
### Storage
8
8
9
-
-[S3](s3.md)
9
+
-[S3](s3.md) can be configured to serve as your storage backend via the [invenio-s3](https://github.com/inveniosoftware/invenio-s3) extension. If you chose S3 as storage when initializing your instance, [navigate here](#i-chose-s3-when-initializing-the-repository). Otherwise, [navigate to this section](#i-didnt-choose-s3-when-initializing).
Copy file name to clipboardExpand all lines: docs/extensions/s3.md
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,13 +2,13 @@
2
2
3
3
## I chose S3 when initializing the repository!
4
4
5
-
If you are reading the section you are lucky! you will only have to perform a few configuration changes. If on the contrary you didn't choose S3 as storage when initializing the repository file system, [navigate below](#i-didnt-choose-s3-when-initializing) to follow more in depth changes!
5
+
If you are reading this section, you are lucky! You will only have to perform a few configuration changes. If on the contrary you didn't choose S3 as storage when initializing the repository file system, [navigate below](#i-didnt-choose-s3-when-initializing) to follow more in depth instructions!
6
6
7
7
### Create a bucket
8
8
9
-
InvenioRDM uses a [minio](https://min.io/download) container for S3 alike storage. To create a bucket in minio you can:
9
+
InvenioRDM uses a [MinIO](https://min.io/download) container for S3-like storage. To create a bucket in MinIO you can:
10
10
11
-
a. Install the [mc tool](https://docs.min.io/docs/minio-client-quickstart-guide.html) and run the following command, where `defaul-bucket` is the name of your bucket.
11
+
a. Install the [mc tool](https://docs.min.io/docs/minio-client-quickstart-guide.html) and run the following command, where `default-bucket` is the name of your bucket.
12
12
13
13
```console
14
14
$ mc mb default-bucket
@@ -18,7 +18,7 @@ b. Use the web UI (https://localhost[:9000]/minio). In the bottom right you will
18
18
19
19
### Create a new location
20
20
21
-
Now you need to tell InvenioRDM where is that bucket, for that create a new location. If you are running a local (development) instance, run:
21
+
Now you need to tell InvenioRDM where that bucket is. For that, create a new location. If you are running a local (development) instance, run:
The last step is to set your credentials so your instance can authenticate against the S3 container.
38
38
39
-
By default the `ACCESS_KEY` and the `ACCESS_ID` of minio are "CHANGE_ME", and so they are set in the `invenio.cfg` file. If you changed them (you should) modify them accordingly in the config file.
39
+
By default, the `ACCESS_KEY` and the `ACCESS_ID` of MinIO are "CHANGE_ME", and so they are set in the `invenio.cfg` file. If you changed them (you should) modify them accordingly in the config file.
40
40
41
41
It's done! Ready to roll!
42
42
43
43
## I didn't choose S3 when initializing
44
44
45
45
You are here, but do not panic, is not difficult just longer.
46
46
47
-
This docs will come soon, for now we apologize for the hussle, but could you create a new instance to test S3?
Copy file name to clipboardExpand all lines: docs/index.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -39,7 +39,7 @@ the workflow to be effective with them.
39
39
40
40
## Extensions
41
41
42
-
InvenioRDM supports a great variety of extensions that can help you adapt it to your infrastructure, it also supports the addition of custom made ones.
42
+
InvenioRDM supports a great variety of extensions that can adapt it to your infrastructure. It also supports the addition of custom made ones.
We usually deploy the RDM in machines that have around 8GB of RAM and at least 4 cores. InvenioRDM can certainly run (for demo purposes) with less, just take into account that you are going to be runing between 4 and 8 containers (among them ES, which is quite demanging).
26
+
We usually deploy the RDM in machines that have around 8GB of RAM and at least 4 cores. InvenioRDM can certainly run (for demo purposes) with less, just take into account that you are going to be running between 4 and 8 containers (among them an Elasticsearch container, which is quite demanding).
27
27
28
28
Once you have installed these requirements, you can install the CLI.
29
29
@@ -59,4 +59,4 @@ invenio-cli, version 0.10.0
59
59
```
60
60
61
61
!!! note "CLI version"
62
-
The CLI is in pre 1.0 release. The last release's version is **0.10.0**. Your version may be different than the above.*
62
+
The CLI is in pre 1.0 release. The last release's version is **0.10.0**. Your version may be different than the above.
0 commit comments