search

whiskyechobravo / kerkoapp

A web application that provides a faceted search interface for bibliographies managed with Zotero.
https://whiskyechobravo.github.io/kerko/
BSD 3-Clause "New" or "Revised" License
68 stars 24 forks source link

Document the MODULE_NAME variable #18

Closed amv closed 3 years ago

amv commented 3 years ago

This makes the container simply output the hello world message when running the current whiskyechobravo/kerkoapp docker image.

I was able to get docker to load the proper app by adding either one of these two lines in the .env file:

APP_MODULE=kerkoapp:app MODULE_NAME=kerkoapp

But for some reason I also had to provide the following .env variables to get the server actually running:

FLASK_APP=kerkoapp.py FLASK_ENV=development

Would be nice to have these either documented or fixed by default :)

amv commented 3 years ago

Ah it looks like the MODULE_NAME variable is actually present in the sample env file. I failed to miss it as I just built my env file from scratch and the variable was not documented as being mandatory.

davidlesieur commented 3 years ago

Right, MODULE_NAME is not mentioned in KerkoApp's documentation because it is used by Gunicorn, not by KerkoApp. Nevertheless, it probably ought to be mentioned in KerkoApp's Docker-related instructions since the container uses Gunicorn. I'll gladly take pull requests that improve the documentation and reduce hurdles for new users!