Skip to content

docs: explain notification firebase mode for local push #275

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
sleidig merged 1 commit into from
Nov 5, 2026
Merged

docs: explain notification firebase mode for local push #275

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 3 additions & 0 deletions docs/developer/.env.example
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,9 @@ AAMSECURITY_ALLOWEDISSUERS=https://keycloak.localhost/realms/dummy-realm

FEATURES_NOTIFICATIONAPI_ENABLED=true
DATABASECHANGEDETECTION_ENABLED=true
# Push notifications need this mode and a real credential below (see README "Configure modules").
# Enable it only together with the credential: with the placeholder the service fails to start.
#FEATURES_NOTIFICATIONAPI_MODE=firebase
NOTIFICATIONFIREBASECONFIGURATION_CREDENTIALFILEBASE64=<base-64-encoded-firebase-credential-file>
APPLICATION_BASEURL=https://aam.localhost
NOTIFICATIONFIREBASECONFIGURATION_LINKBASEURL=https://aam.localhost
Expand Down
9 changes: 6 additions & 3 deletions docs/developer/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -395,9 +395,12 @@ Only the proxied hostname can reach the backend services and Keycloak.

Refer to the Module READMEs at [docs/modules](/docs/modules) to set up specific modules like Notification:

Note that `FEATURES_NOTIFICATIONAPI_ENABLED=true` in `.env.example` only enables the module — it
stays non-functional until you supply real Firebase credentials for
`NOTIFICATIONFIREBASECONFIGURATION_CREDENTIALFILEBASE64`, which ships as a placeholder. The
Note that `FEATURES_NOTIFICATIONAPI_ENABLED=true` in `.env.example` only enables the module — push
notifications stay off until you supply real Firebase credentials for
`NOTIFICATIONFIREBASECONFIGURATION_CREDENTIALFILEBASE64` (which ships as a placeholder) **and** set
`FEATURES_NOTIFICATIONAPI_MODE=firebase` (commented out in `.env.example`). Set both together: without
the mode, devices still register but no push is sent and `POST /v1/notification/message/device-test`
returns 404; with the mode but the placeholder credential, the service fails to start. The
service reports on startup whether notification email is on and, if not, why (email needs an SMTP
host, a sender address and the Keycloak access, see [notification.md](/docs/modules/notification.md)):

Expand Down
Loading