Updated LNbits Documentation (markdown)

arbadacarba 2023-03-03 18:37:27 +01:00
parent 2a471c41c0
commit dfe5de6821

@ -1308,18 +1308,22 @@ Going over the example extension's structure:
* `views.py`: The `/` path will show up as your plugin's home page in lnbits' UI. Other pages you can define yourself. The `templates` folder should explain itself in relation to this.
* `migrations.py`: Create database tables for your plugin. They'll be created automatically when you start lnbits.
If you do not plan to push your extension to LNbits official repo you can just add a manifest.json inside your extensions and add this info to the extension manifests inside your lnbits.
If you do not plan to push your extension to LNbits official repo you can just add a manifest.json inside your extensions and add this info to the extension manifests inside your lnbits.
{
"repos": [
{
"id": "nameofyourextension",
"organisation": "yourcompany",
"repository": "reponame"
"repository": "nameofyourextensionrepo"
}
]
}
If you want to get your extension vetted later on, clone it to lnbits/extensions and work on it there.
If the naming turns out to be not possible to save (name conflicts) clone the extension repo and create a link like this:
- ln -s /Users/my-user/git-repos/my-extension-repo/ /Users/my-user/git-repos/lnbits/lnbits/extensions/myextension
Each extension has a unique ID. It should be the same as the name of the extension dir and the name that you see in the URL when you are using the extension e.g. http://127.0.0.1:5000/lnurlp/?usr=a2f52f9b396249c7a561f8917a5b2dbd where the ID is a lnurlp.
It is recommended for the ID to be alphaumeric only (no -, _, . etc).