Document Environment Variables

[TheoLechemia]

Small contribution on documentation.
See #1694
No sure if it's the way you want to do it.. tell me

[samuelhwilliams]

Thanks for the suggested improvement to document env var configuration on Flask-Admin; I agree this is something we're missing at the moment.

We've just removed env var configuration for theming (swatch, fluid layout) and move it to a Theme config object passed to the admin instance. It looks like we still have three possible env vars: ADMIN_RAISE_ON_INTEGRITY_ERROR, ADMIN_RAISE_ON_VIEW_EXCEPTION and FLASK_ADMIN_SEARCH_SIZE_MAX. It would be good to add documentation for those. I think it makes sense to flag these at the bottom of 'introduction.rst' rather than hiding them in 'advanced.rst'.

If you wanted to update the PR I'd be very grateful - if not I'll try to get around to it soon.

[hasansezertasan]

Version 2 doesn't have this anymore.

[hasansezertasan]

Version 2 doesn't have this anymore.

[hasansezertasan]

Thanks for the suggested improvement to document env var configuration on Flask-Admin; I agree this is something we're missing at the moment.

We've just removed env var configuration for theming (swatch, fluid layout) and move it to a Theme config object passed to the admin instance. It looks like we still have three possible env vars: ADMIN_RAISE_ON_INTEGRITY_ERROR, ADMIN_RAISE_ON_VIEW_EXCEPTION and FLASK_ADMIN_SEARCH_SIZE_MAX. It would be good to add documentation for those. I think it makes sense to flag these at the bottom of 'introduction.rst' rather than hiding them in 'advanced.rst'.

If you wanted to update the PR I'd be very grateful - if not I'll try to get around to it soon.

Looks like we have a lot more...

flask-admin/flask_admin/templates/bootstrap4/admin/lib.html

Lines 259 to 285 in 68bc6de

	{% macro form_js() %}
	{% if config.MAPBOX_MAP_ID %}
	<script>
	window.MAPBOX_MAP_ID = "{{ config.MAPBOX_MAP_ID }}";
	{% if config.MAPBOX_ACCESS_TOKEN %}
	window.MAPBOX_ACCESS_TOKEN = "{{ config.MAPBOX_ACCESS_TOKEN }}";
	{% endif %}
	{% if config.DEFAULT_CENTER_LAT and config.DEFAULT_CENTER_LONG %}
	window.DEFAULT_CENTER_LAT = "{{ config.DEFAULT_CENTER_LAT }}";
	window.DEFAULT_CENTER_LONG = "{{ config.DEFAULT_CENTER_LONG }}";
	{% endif %}
	</script>
	<script src="{{ admin_static.url(filename='vendor/leaflet/leaflet.js', v='1.0.2') }}"></script>
	<script src="{{ admin_static.url(filename='vendor/leaflet/leaflet.draw.js', v='0.4.6') }}"></script>
	{% if config.MAPBOX_SEARCH %}
	<script>
	window.MAPBOX_SEARCH = "{{ config.MAPBOX_SEARCH }}";
	</script>
	<script src="https://maps.googleapis.com/maps/api/js?v=3&libraries=places&key={{ config.get('GOOGLE_MAPS_API_KEY') }}"></script>
	{% endif %}
	{% endif %}
	<script src="{{ admin_static.url(filename='vendor/bootstrap-daterangepicker/daterangepicker.js', v='1.3.22') }}"></script>
	{% if editable_columns %}
	<script src="{{ admin_static.url(filename='vendor/x-editable/js/bootstrap4-editable.min.js', v='1.5.1.1') }}"></script>
	{% endif %}
	<script src="{{ admin_static.url(filename='admin/js/form.js', v='1.0.1') }}"></script>
	{% endmacro %}

[samuelhwilliams]

🥲 We should have a consistent namespace for all of these, too.

[TheoLechemia]

Maybe I would take a look when the 2.0 will be almost stabilised ?
I see there is still a MAPBOX_MAP_ID which is discuss here : #2034

[samuelhwilliams]

Thanks for flagging #2034 - agree that we should fix that interface. I've assigned myself to it and will think about what we want to do there.

For now I'm going to close this PR as I'll put one up shortly that rationalises all of the config variables under a FLASK_ADMIN_ namespace and adds some documentation.