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

Add info about server var modes #392

Merged
merged 5 commits into from
Feb 21, 2024
Merged
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,11 @@ corresponding to the release is used to generate markdown documentation of the
variables. The generated markdown files are added to this directoy. Use the
left sidebar to see the available configuration variables for the CiviForm
version you are deploying.

Variables can have four different modes which determine where they are set and displayed:
rockycodes marked this conversation as resolved.
Show resolved Hide resolved
1. Admin writeable variables should be set in the admin settings panel which is accessible in CiviForm when logged in as an admin. These variables should NOT be set in your deployment config and setting them there will have no affect on the app.
rockycodes marked this conversation as resolved.
Show resolved Hide resolved
2. Admin readable variables should be set in your deployment config file. The values for these variables can be seen in the admin settings panel, but not changed there.
3. Server setting variables should be set in your deployment config file and are not visible in the admin settings panel.
4. Managed secret variables should be set in your cloud provider's secrets manager. These are not visible in the admin settings panel.

A variable's mode is listed in between the variable name and its description in the generated documentation in this directory.
rockycodes marked this conversation as resolved.
Show resolved Hide resolved