Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow for the override of SPECIFY_THICK_CLIENT from environment #5455

Open
wants to merge 4 commits into
base: production
Choose a base branch
from

Conversation

acwhite211
Copy link
Member

Allow for spcloud and test-panel to configure the Specify Django settings parameter SPECIFY_THICK_CLIENT inorder to allow for a simpler spcloud docker-compose file. This will still allow self hosted instance to remain unchanged, so no change for self-hosted instances is required.

See here specify/specify7-test-panel@main...sp7-only for use of this parameter.

@@ -0,0 +1,16 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- This file is to test that the sp7_only config files are beind used in the static files api -->
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can remove this before merging, right?

Copy link
Member

@grantfitzsimmons grantfitzsimmons left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

specify/specify7-test-panel@9d8924a looks like it will solve the issue we're having. Need to find the time to test this on the panel.


# Specify 7 requires the files from a Specify 6 install.
# This setting should point to a directory containing an installation
# of Specify 6 of the same version as the Specify database.
THICK_CLIENT_LOCATION = '/opt/Specify'
THICK_CLIENT_LOCATION = os.environ.get('THICK_CLIENT_LOCATION', '/opt/Specify')
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This allows local installations to set a THICK_CLIENT_LOCATION environment variable and use that instead of modifying this variable directly.

Do we want to add note of this to the installation instructions?

specify7/README.md

Lines 491 to 493 in 18f5c15

3. Make sure to update the `THICK_CLIENT_LOCATION` setting in
`local_specify_settings.py`, if you are updating the Specify 6
version.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And for Dockerized instances, do we want to provide documentation for how this environment variable can be used?
Or maybe just how it's used with correlation to the docker-compose.yml (and Dockerfile)?

For the users who wish to go in depth for customizing the setup of their instance, there's a LOT of moving parts. They might not even know what's possible/not-possible, and I could see how easy it might be to get stuck.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. I don't think we should encourage anyone to configure new local installations
  2. Documentation on supported environment variables are always desirable 😄

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: 📋Back Log
Development

Successfully merging this pull request may close these issues.

5 participants