Skip to content

docs: add detailed single-region onboarding and separate technical reference #30

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.

Sign up for GitHub

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

Merged
Hou (SciencePotato) merged 4 commits into from
Oct 5, 2026
Merged

docs: add detailed single-region onboarding and separate technical reference #30

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
470ad61
docs: separate detailed single-region onboarding from technical refer…
Oct 5, 2026
ad26031
docs: use Security Store provider-neutral onboarding and diagram
Oct 5, 2026
ddc3a1b
docs: use updated single-region architecture diagram
Oct 5, 2026
fa063d8
Merge branch 'main' into docs/single-region-onboarding
SciencePotato Oct 5, 2026
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
443 changes: 186 additions & 257 deletions README.md
View file
Open in desktop

Large diffs are not rendered by default.

293 changes: 293 additions & 0 deletions TECHNICAL.md
View file
Open in desktop

Large diffs are not rendered by default.

10 changes: 6 additions & 4 deletions docs/ONBOARDING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# EPP Onboarding
# EPP Detailed Configuration and Validation

Follow these five steps for the External Phone Provider (EPP) Function. Choose one language:
For first-time single-region deployment, start with the [main onboarding guide](../README.md).
This guide covers detailed configuration, local development, and validation of the External Phone
Provider (EPP) Function. Choose one language:
[JavaScript](../javascript/README.md), [Python](../python/README.md), or [.NET](../dotnet/README.md).
Use [CONTRACT.md](CONTRACT.md) for the full request contract and production limitations.

Expand Down Expand Up @@ -123,8 +125,8 @@ Use [CONTRACT.md](CONTRACT.md) for the full request contract and production limi
change signing keys; request a fresh token afterward. This does **not** disable the required
JWE encryption of `encryptedDeliveryContext` or remove `EPP_DECRYPTION_KEY_PEM`.

Download the selected language's [Function ZIP](../README.md#download-a-function-zip) from GitHub
Releases, or use the [root-level packaging scripts](../README.md#build-zips-locally) for custom builds.
Download the selected language's [Function ZIP](../TECHNICAL.md#download-a-function-zip) from GitHub
Releases, or use the [root-level packaging scripts](../TECHNICAL.md#build-zips-locally) for custom builds.
The .NET source ZIP must be extracted and built/published with the .NET 8 SDK or a build-enabled
deployment pipeline. The Python source ZIP requires Azure remote build on Linux. Neither source
ZIP is ready for direct run-from-package. Downloading or building a ZIP does not deploy it.
Expand Down
Binary file added docs/images/single-region-architecture.png
View file
Open in desktop

@siyixian siyixian Oct 6, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Provider adapter is part of SendOtp api, let's put them into same box

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion dotnet/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ matching provider authentication settings to `Values`.
Add `EPP_PROVIDER_ACCOUNT_NAME` and adapter-specific options only when required. Optional
`EPP_PROVIDER_TIMEOUT_MS` is a string such as `"1500"`. Replace placeholders; store provider credentials
under the adapter's Key Vault secret names, not in local settings. See the
[complete variable table](../README.md#configure-environment-variables).
[complete variable table](../TECHNICAL.md#configure-environment-variables).

Core Tools loads `Values` into environment variables. [AppConfig.Read](Src/AppConfig.cs) reads them
through `IEnv`; direct worker execution and unit tests do not automatically load local settings.
Expand Down
2 changes: 1 addition & 1 deletion javascript/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ For live delivery, add `EPP_PROVIDER_NAME`, the complete selected `EPP_PROVIDER_
matching provider authentication settings to `Values`.
Add `EPP_PROVIDER_ACCOUNT_NAME` and any provider-specific options only when required. Optional
`EPP_PROVIDER_TIMEOUT_MS` is a string such as `"1500"`. Replace placeholders; do not put API keys in
this file. See the [complete variable table](../README.md#configure-environment-variables).
this file. See the [complete variable table](../TECHNICAL.md#configure-environment-variables).

Core Tools copies `Values` into the process environment; direct Node processes and the offline tests
do **not** automatically load this file. [AppConfig](src/functions/config.js) reads `process.env`
Expand Down
2 changes: 1 addition & 1 deletion python/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ matching provider authentication settings to `Values`.
Add `EPP_PROVIDER_ACCOUNT_NAME` and any adapter-specific options only when required. Keep values as
strings, including optional `EPP_PROVIDER_TIMEOUT_MS: "1500"`. Replace placeholders; provider API
keys belong in the manifest-named Key Vault secrets, not this file. See the
[complete variable table](../README.md#configure-environment-variables).
[complete variable table](../TECHNICAL.md#configure-environment-variables).

Core Tools loads `Values` into `os.environ`. Direct Python execution and pytest do not automatically
read local settings. [read_config](src/config.py) returns an `AppConfig` object; the handler/engine
Expand Down
Loading