Change the logo¶

Having your instance represent your institution starts with using your institution's logo. We are going to change InvenioRDM's default logo to your logo.

Step-by-step¶

Step 1 - Take a svg file and copy it to your local static files.

We'll use the invenio white logo as an example:

cp static/images/logo-invenio-white.svg static/images/my-logo.svg

Step 2 - Modify your invenio.cfg file:

- THEME_LOGO="images/logo-invenio-white.svg"
+ THEME_LOGO="images/my-logo.svg"

Step 3 - Use the invenio-cli assets build command:

invenio-cli assets build

# Summarized output
Collecting statics and assets...
Collect static from blueprints.
Created webpack project.
Copying project statics and assets...
Symlinking assets/...
Building assets...
Built webpack project.

This command makes sure files you have in static/, assets/, templates/ are placed in the right location with other similar files in the application. The files are by default symlinked to ensure future modifications to those files translate directly. No need to run invenio-cli assets build again for them.

Step 4 - Finally, re-run the server:

<Ctrl+C>
invenio-cli run

Re-run when invenio.cfg changes

All changes to invenio.cfg MUST be accompanied by a restart like the above to be picked up. This only restarts the server; it does not destroy any data.

In the browser, go to https://127.0.0.1:5000/ or refresh the page. And voilà! The logo has changed!

That evil cache

If you do not see it changing, check in an incognito window; the browser might have cached the logo.

Custom static files workflow¶

This workflow stands for all static/ files:

If you add a new file, then run invenio-cli assets build.
If you modify invenio.cfg, then re-run invenio-cli run (because invenio.cfg has been symlinked above, you don't need to run assets build).
If you modify a previously symlinked file, you don't need to do anything.