GlobalForms reads its server settings from two files in the config folder of the install directory (C:\GlobalForms\config by default). This page explains which file to edit and how to apply changes.
The two configuration files
|
File |
Purpose |
Edit it? |
|---|---|---|
|
|
The built-in defaults for every setting. Replaced with a new copy each time GlobalForms is updated. |
No. Any change is lost at the next update. |
|
|
Your settings for this server. Created by setup and kept as-is during updates. |
Yes. Make all changes here. |
Always make changes in local.json. Never edit default.json.
How the files combine
When GlobalForms starts, it reads default.json first and then applies local.json on top of it:
-
A setting in
local.jsonreplaces the same setting indefault.json. -
A setting you leave out of
local.jsonkeeps its default value. -
Within a section (an object in
{ }), you only need to include the settings you want to change. The rest of that section keeps its defaults. -
A list (an array in
[ ]) is replaced as a whole. Include every entry you want, not just the new ones.
For example, this local.json changes only the HTTP port and turns on request logging. Every other setting keeps its default:
{
"port": 3005,
"settings": {
"logging": {
"request": {
"enabled": true
}
}
}
}
On servers upgraded from earlier versions, local.json may already contain a full copy of every setting. That is expected and works the same way.
What setup writes to local.json
|
Setting |
Description |
|---|---|
|
|
The external URL users use to reach GlobalForms |
|
|
The MongoDB connection string |
|
|
Security keys generated for this server. Keep them private and do not change them. |
|
|
Automatic update settings. See Automatic Updates. |
|
|
HTTPS certificate file locations. See Configuring HTTPS. |
Change a setting
-
Make a backup copy of
config\local.json. -
Open
config\local.jsonin a text editor, such as Notepad, running as administrator. -
Add or change the setting. Keep the file valid JSON:
-
Put names and text values in double quotes:
"domain": "https://forms.example.com". -
Separate settings with commas, with no comma after the last setting in a section.
-
Write each backslash in a Windows path twice:
"C:\\certs\\server.crt".
-
-
Save the file.
-
Restart the GlobalForms service. In PowerShell as administrator:
PowerShellRestart-Service GlobalFormsOr open Services, right-click GlobalForms Forms Server and select Restart.
Changes take effect only after the service restarts.
Common settings
|
Setting |
Default |
Description |
|---|---|---|
|
|
|
External URL of the server |
|
|
|
HTTP port |
|
|
|
HTTPS port |
|
|
(all network interfaces) |
Optional. Limit GlobalForms to one IP address on the server. |
|
|
|
MongoDB connection string. See Database Configuration. |
|
|
|
HTTPS certificate and key. See Configuring HTTPS. |
|
|
(updates on, Stable channel) |
See Automatic Updates. |
|
|
|
Minutes before a signed-in session expires |
|
|
|
See Deleting Submissions. |
|
|
(security headers) |
See Security Headers. |
|
|
(not configured) |
Single sign-on. See Single Sign-On with OpenID Connect. |
|
|
(disabled) |
|
|
|
(uploads allowed) |
|
|
|
(off) |
See Request Logging. |
Troubleshooting
|
Symptom |
Cause and fix |
|---|---|
|
The service stops right after you restart it |
|
|
A change has no effect |
Confirm you edited |
|
A change disappeared after an update |
It was made in |