Skip to content

Commit 34ee730

Browse files
committed
Additional updates to Readme about Configuration Values and installing/running Storage Emulator locally.
1 parent ac3ce45 commit 34ee730

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -161,6 +161,23 @@ Apache FOP Supports accessibility compliance in PDFs however, the `<accessibilit
161161

162162
Therefore ApacheFOP.Serverless provides an Azure Function configuration value to set this directly which can be enabled by setting the Azure Functions environment config value: `'AccessibilityEnabled' = 'true'`.
163163

164+
## Basic Azure Functions Configuration Values:
165+
Ensure that the configuration values are set correctly for your Azure Function...
166+
- When deployed, you will set these as variables in the Portal `Settings -> Configuration` of the Azure Function.
167+
- When running locally in IntelliJ these will be set in the AppSettings of the Run/Debug Configuration for IntelliJ. And, in VS Code these are stored in the `local.settings.json` configuration file (included).
168+
169+
Configuration Values:
170+
- `FUNCTIONS_WORKER_RUNTIME` = `java`
171+
- `FUNCTIONS_EXTENSION_VERSION` = `~3`
172+
- `FUNCTIONS_CORE_TOOLS_DISPLAY_LOGO` = `true` (pretty sure this is optional, but I like having it)
173+
- `JAVA_HOME` = `C:\Program Files\Zulu\zulu-11\` _(may be optional, but at one point this was the only way I got it to find the right version before uninstalling everything else)_
174+
- `AzureWebJobsStorage` = `UseDevelopmentStorage=true` OR `Initialize a new Azure Function in the Portal to get a valid Web Jobs storage key`
175+
- _Note: this one is required for the **KeepWarmFunction** that helps keep the Azure function performance up after sitting for a while... you can always just comment out that Function class to eliminate this dependency, but it's very helpful in production environments.)_
176+
- [Here are the instructions for installing/running the Storage Emulator (Windows) or Azurite Emulator (Linux)](https://docs.microsoft.com/en-us/azure/storage/common/storage-use-emulator#get-the-storage-emulator) to run completely locally.
177+
- OR you may create your Azure function and configure your real connection string here.
178+
- `KeepWarmCronSchedule` = `0 */5 * * * *` _(also required configuration for the KeepWarmFunction)_
179+
- `DebuggingEnabled` = `true` (Optional but very helpful once you start using it to return debug details in the responses).
180+
164181
## Calling the Service from .Net
165182

166183
### Snippet:

0 commit comments

Comments
 (0)