X Tutup
The Wayback Machine - https://web.archive.org/web/20201204143945/https://github.com/CTFd/CTFd/issues/856
Skip to content

/ CTFd

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

Jump to bottom

Config.py Variable Documentation #856

Open
Helithumper opened this issue Jan 28, 2019 · 1 comment
Open

Config.py Variable Documentation #856

Helithumper opened this issue Jan 28, 2019 · 1 comment
Labels
good first issue

Comments

@Helithumper
Copy link

@Helithumper Helithumper commented Jan 28, 2019 •
edited

Within the CTFd/config.py file, there are a few variables defined under the TestConfig class which have no documentation surrounding them. What do they do?

PRESERVE_CONTEXT_ON_EXCEPTION = False
TESTING = True
DEBUG = True
SERVER_NAME = 'localhost'
SAFE_MODE = True

If someone could explain exactly what each of these do, it would be useful to add documentation surrounding their use.
@ColdHeat
Copy link
Member

@ColdHeat ColdHeat commented Jan 29, 2019

Hi @Helithumper, this seems related to #742 but overall the top 4 are documented by Flask. The only one custom to CTFd is the last one which defines whether plugins are loaded by CTFd.

SAFE_MODE = True means don't load plugins. In terms of the tests, disabling plugin loading helps ensure the consistency of generated output.

I'm not sure if there really needs to be documentation for the Flask specific values but perhaps there should be some for the CTFd specific values. Ultimately we should have that documentation in Sphinx first I think.
abhinavprkash added a commit to abhinavprkash/CTFd that referenced this issue May 14, 2020
@abhinavprkash
detailed documentation issue CTFd#856 in comments
5a5598b
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
good first issue
Projects
None yet
Milestone
No milestone
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
2 participants
@ColdHeat @Helithumper
You can’t perform that action at this time.
X Tutup