Configuration & Environment¶
ConfluenceSynkMD reads connection settings from environment variables and/or CLI flags.
Configuration Priority¶
Settings are resolved in the following order (highest priority first):
- CLI flags —
--conf-base-url,--conf-auth-mode,--conf-user-email,--conf-api-token,--conf-bearer-token,--api-version,--headers - Environment variables —
CONFLUENCE__* - Default values — Built-in defaults
Environment Variables¶
| Variable | Description | Default |
|---|---|---|
CONFLUENCE__BASEURL |
Confluence Cloud URL (e.g. https://yoursite.atlassian.net) |
— (required) |
CONFLUENCE__AUTHMODE |
Authentication mode: Basic or Bearer |
Basic |
CONFLUENCE__USEREMAIL |
Atlassian account email (Basic Auth) | — |
CONFLUENCE__APITOKEN |
Atlassian API Token (Basic Auth) | — |
CONFLUENCE__BEARERTOKEN |
OAuth 2.0 access token (Bearer Auth) | — |
CONFLUENCE__OPTIMIZEIMAGES |
Downscale images before upload | true |
CONFLUENCE__MAXIMAGEWIDTH |
Maximum width for optimized images (px) | 1280 |
CONFLUENCE__APIPATH |
API path prefix (/wiki for Cloud, "" for Data Center) |
/wiki |
CONFLUENCE__APIVERSION |
REST API version (v1 or v2) |
v2 |
CLI Credential Flags¶
All credential fields can be overridden via CLI flags:
| Flag | Overrides | Description |
|---|---|---|
--conf-base-url |
CONFLUENCE__BASEURL |
Confluence Cloud base URL |
--conf-auth-mode |
CONFLUENCE__AUTHMODE |
Authentication mode: Basic or Bearer |
--conf-user-email |
CONFLUENCE__USEREMAIL |
User email (Basic Auth) |
--conf-api-token |
CONFLUENCE__APITOKEN |
API token (Basic Auth) |
--conf-bearer-token |
CONFLUENCE__BEARERTOKEN |
Bearer token (OAuth 2.0) |
Naming Convention¶
Environment variables use the __ (double underscore) separator, which .NET maps to configuration sections:
This follows the standard .NET configuration pattern for IConfiguration.
Image Optimization¶
Control image processing with:
| Variable | Default | Description |
|---|---|---|
CONFLUENCE__OPTIMIZEIMAGES |
true |
Enable/disable image optimization |
CONFLUENCE__MAXIMAGEWIDTH |
1280 |
Max width in pixels (height scales proportionally) |
Images are optimized before upload to reduce Confluence storage and improve page load times.
API Path and Version¶
| Setting | Cloud | Data Center |
|---|---|---|
CONFLUENCE__APIPATH |
/wiki |
"" (empty) |
CONFLUENCE__APIVERSION |
v2 |
v1 |
Note
ConfluenceSynkMD is primarily tested against Confluence Cloud with API v2. Data Center support is not officially guaranteed.