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

Merge branch 'main' of https://github.com/boltcard/boltcard into main

Browse source
This commit is contained in:
Peter Rounce 2022-08-24 09:04:00 +00:00
commit 16a4cf444b
3 changed files with 17 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

4
README.md
View file

@ -16,9 +16,9 @@ The 'bolt card creation' instructions describe how to set up bolt cards for use
| --- | --- | | --- | --- |
| [Specification](docs/SPEC.md) | Bolt card specifications | | [Specification](docs/SPEC.md) | Bolt card specifications |
| [System](docs/SYSTEM.md) | Bolt card system overview | | [System](docs/SYSTEM.md) | Bolt card system overview |
| [Install](docs/INSTALL.md) | Bolt card service installation | | [Service Install](docs/INSTALL.md) | Bolt card service installation |
| [Automatic Card Creation](docs/CARD_ANDROID.md) | Bolt card creation using the Bolt Card app| | [Automatic Card Creation](docs/CARD_ANDROID.md) | Bolt card creation using the Bolt Card app|
| [Manual Card Creation](docs/CARD_MANUAL.md) | Bolt card creation using NXP TagXplorer| | [Manual Card Creation](docs/CARD_MANUAL.md) | Bolt card creation using NXP TagXplorer software|
| [FAQ](docs/FAQ.md) | Frequently asked questions | | [FAQ](docs/FAQ.md) | Frequently asked questions |
## Telegram group ## Telegram group

5
docs/CARD_ANDROID.md
View file

@ -8,7 +8,7 @@ Here we describe how to create your own bolt cards with the Bolt Card Android ap
- some `NXP DNA 424 NTAG` cards - some `NXP DNA 424 NTAG` cards
- an Android device with NFC - an Android device with NFC
- a Bolt Card serice - a Bolt Card service
- [the Bolt Card app](https://github.com/boltcard/bolt-nfc-android-app) - [the Bolt Card app](https://github.com/boltcard/bolt-nfc-android-app)
- [the Bolt Card app usage document](https://github.com/boltcard/bolt-nfc-android-app#usage) - [the Bolt Card app usage document](https://github.com/boltcard/bolt-nfc-android-app#usage)
@ -35,6 +35,7 @@ lnurlw://card.yourdomain.com/ln?c=...&p=...
### Write the key values to the card ### Write the key values to the card
on the bolt card server on the bolt card server
- ensure the environment variables for the database connection are set up (see `boltcard.service`)
- enter the `createboltcard` directory - enter the `createboltcard` directory
- `$ go build` - `$ go build`
- `./createboltcard` to create a card - `./createboltcard` to create a card
@ -54,7 +55,7 @@ on the bolt card server
- `card_db=# select card_id, one_time_code from cards order by card_id desc limit 1;` - `card_db=# select card_id, one_time_code from cards order by card_id desc limit 1;`
- check that this is the correct record (one_time_code matches from before) - check that this is the correct record (one_time_code matches from before)
- `card_db=# update cards set uid = 'UID value from before without the 0x prefix' where card_id=card_id from before;` - `card_db=# update cards set uid = 'UID value from before without the 0x prefix' where card_id=card_id from before;`
- `card_db=# update cards set enabled = 'Y' where card_id=card_id from before;` - `card_db=# update cards set enable_flag = 'Y' where card_id=card_id from before;`
### Make a payment ### Make a payment
- monitor the bolt card service logs - monitor the bolt card service logs

14
docs/INSTALL.md
View file

@ -5,6 +5,10 @@
1 GHz processor, 2 GB RAM, 10GB storage minimum 1 GHz processor, 2 GB RAM, 10GB storage minimum
Ubuntu 20.04 LTS server Ubuntu 20.04 LTS server
### login
create and use a user named `ubuntu`
### install Go ### install Go
[Go download & install](https://go.dev/doc/install) [Go download & install](https://go.dev/doc/install)
@ -51,7 +55,8 @@ edit `create_db.sql` to set the cardapp password
### boltcard service install ### boltcard service install
`$ sudo cp boltcard.service /etc/systemd/system/boltcard.service` `$ sudo cp boltcard.service /etc/systemd/system/boltcard.service`
`$ ./s_build` `$ ./s_build`
`$ systemctl status boltcard` `$ sudo systemctl enable boltcard`
`$ sudo systemctl status boltcard`
### https setup ### https setup
set up the domain A record to point to the server set up the domain A record to point to the server
@ -75,9 +80,14 @@ 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
[create a bolt card](CARD.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
#### production use
ensure that LOG_LEVEL is set to PRODUCTION
ensure that all secrets are minimally available
ensure that you have good operational security practices
monitor the system for unusual activity
# Further information and support # Further information and support