https://github.com/php-lightning/lnaddress
PHP package that let you get a lightning address on your own domain.
https://github.com/php-lightning/lnaddress
bitcoin lightning-address lightning-network ln php
Last synced: 5 months ago
JSON representation
PHP package that let you get a lightning address on your own domain.
- Host: GitHub
- URL: https://github.com/php-lightning/lnaddress
- Owner: php-lightning
- License: mit
- Created: 2022-09-23T20:05:35.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-05-25T13:04:57.000Z (about 1 year ago)
- Last Synced: 2025-06-02T00:56:43.128Z (about 1 year ago)
- Topics: bitcoin, lightning-address, lightning-network, ln, php
- Language: PHP
- Homepage: https://packagist.org/packages/php-lightning/lnaddress
- Size: 1.22 MB
- Stars: 26
- Watchers: 3
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# PHP Lightning Address
PHP Lightning Address is an easy way to get a [lightning address](https://lightningaddress.com/) in PHP.
## Usage / Development
Set up your custom config:
```bash
cp lightning-config.dist.php lightning-config.php
# or just simply the nostr.json to define the backends/user-settings
cp nostr.dist.json nostr.json
```
You can customize the invoice description and the success message by editing
`lightning-config.php`:
```php
use PhpLightning\Config\LightningConfig;
return (new LightningConfig())
->setDescriptionTemplate('Pay to %s on mynode')
->setSuccessMessage('Thanks for the payment!');
```
Run a local PHP server listening `public/index.php`
```bash
composer serve
```
### Demo template
We prepared a demo template, so you can use this project as a dependency. The benefits from this approach is that you can update your project with `composer update` whenever there are new features or improvements on this `lnaddress` repository.
> [https://github.com/php-lightning/demo-lnaddress](https://github.com/php-lightning/demo-lnaddress)
## Wiki
Check the wiki for more details: [https://github.com/php-lightning/lnaddress/wiki](https://github.com/php-lightning/lnaddress/wiki)
## Contributions
Feel free to open issues & PR if you want to contribute to this project.