search

camicroscope / Distro

Docker distribution of camicroscope and all its components
http://camicroscope.org
BSD 3-Clause "New" or "Revised" License
28 stars 145 forks source link

Additional links json file #161

Closed Vedant1202 closed 3 years ago

Vedant1202 commented 3 years ago

JSON file for additional links

Summary

JSON file for configuring additional links as described in caMicroscope#468.

The links are customizable with the following parameters:

  1. The URL
  2. The name to be displayed
  3. The icon to be displayed (material icons)
  4. A boolean to choose if the link is to be opened in new tab, or in current tab.

This feature requires caMicroscope PR-511 to work.

Motivation

Fixes caMicroscope#468.

Testing

This has been tested on local system running Ubuntu 18.04 and docker-compose version 1.28.6

Questions

Yes, I am unsure if I should add the relevant documentation describing the structure of the JSON data in the README. Or should I create a new README file for that.

Vedant1202 commented 3 years ago

@birm This needs to be merged as well. Also do you want me to add some description for the same in the README?

birm commented 3 years ago

Moreso, the back service needs a mounted volume for the config, such as: 

    volumes:
      - ./config/login.html:/src/static/login.html
      - ./jwt_keys/:/src/keys/
      - ./config/routes.json:/src/routes.json
      - ./config/contentSecurityPolicy.json:/src/contentSecurityPolicy.json
      - ./config/additional_links.json:/src/static/additional_links.json
Vedant1202 commented 3 years ago

Ahh right right, I forgot to add those to the commit

Vedant1202 commented 3 years ago

@birm I updated it. Should I update the README ?

Vedant1202 commented 3 years ago

@birm Done