OSRD-IMAGES

This repository is used to supply (royalty-free) images to OSRD for default operational study project images.

Check out: OSRD primary repository stack.

Getting Started

Build osrd-images with an example infrastructure:

docker build -t osrd-images .

Run osrd-images on port 8080

docker run -p -d 8080:80 osrd-images

Test the server response and check that the schema of the json file image_path.json matches the structure of the src folder

curl https://localhost:8080/image_path.json

Add a new category of images

To add new image categories, you must :

• Add a new folder named after the category in the /src folder.
• Add an image representing the category (category.png or category.jpeg or category.jpg) with its .license file in the /src folder.
• Add the images in each category with their .license files

Requirements

Added images must have a 3:2 aspect ratio. For the moment, the dimensions and sizes accepted are those shown in the image below.
The recommended format is medium.

Get in touch

Send an email at contact@osrd.fr, open an issue, or join the #public-general:osrd.fr matrix channel.

Sponsors

License

OSRD is licensed under the GNU Lesser General Public License v3.0, see LICENSE.

Copyright © 2022 The OSRD Contributors