web/boltcard
1
0
Fork 0
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity Actions

clarify environment variables & database settings

Browse source
This commit is contained in:
Peter Rounce 2022-11-16 08:39:42 +00:00 • committed by GitHub
parent cef58329bb
commit 8188ddde51
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

8
docs/INSTALL.md
View file

@ -78,22 +78,22 @@ this should respond with 'bad request' and show up in the service log
navigate to the service URL from a browser, for example `https://card.yourdomain.com/ln?2` navigate to the service URL from a browser, for example `https://card.yourdomain.com/ln?2`
this should respond with 'bad request' and show up in the service log this should respond with 'bad request' and show up in the service log
#### bolt card #### bolt card
`Environment="FUNCTION_LNURLW=ENABLE"` `Environment="FUNCTION_LNURLW=ENABLE"` in `boltcard.service`
[create a bolt card](CARD_ANDROID.md) with the URI pointing to this server [create a bolt card](CARD_ANDROID.md) with the URI pointing to this server
use a PoS setup to read the bolt card, e.g. [Breez wallet](https://breez.technology/) use a PoS setup to read the bolt card, e.g. [Breez wallet](https://breez.technology/)
monitor the service log to ensure decryption, authentication, payment rules and lightning payment work as expected monitor the service log to ensure decryption, authentication, payment rules and lightning payment work as expected
#### lightning address (optional) #### lightning address (optional)
add lightning address support to receive funds to cards add lightning address support to receive funds to cards
`Environment="FUNCTION_LNURLP=ENABLE` `Environment="FUNCTION_LNURLP=ENABLE`
`cards.lnurlp_enable='Y'` `cards.lnurlp_enable='Y'` in the database record
#### email notifications (optional) #### email notifications (optional)
add email notifications for payments and fund receipt add email notifications for payments and fund receipt
`Environment="AWS_SES_ID=..."` `Environment="AWS_SES_ID=..."`
`Environment="AWS_SES_SECRET=..."` `Environment="AWS_SES_SECRET=..."`
`Environment="AWS_SES_EMAIL_FROM=..."` `Environment="AWS_SES_EMAIL_FROM=..."`
`Environment="FUNCTION_EMAIL=ENABLE"` `Environment="FUNCTION_EMAIL=ENABLE"`
`card.email_address='Y'` `cards.email_address='Y'`
`cards.email_enable='Y'` `cards.email_enable='Y'`
#### production use #### production use
ensure that LOG_LEVEL is set to PRODUCTION ensure that LOG_LEVEL is set to PRODUCTION
ensure that all secrets are minimally available ensure that all secrets are minimally available