Trying to catchup with main

docs/devs/websockets.md

@@ -9,53 +9,10 @@ nav_order: 2
 Websockets
 =================
 
-`websockets` are a great way to add a two way instant data channel between server and client. This example was taken from the `copilot` extension, we create a websocket endpoint which can be restricted by `id`, then can feed it data to broadcast to any client on the socket using the `updater(extension_id, data)` function (`extension` has been used in place of an extension name, wreplace to your own extension):
+`websockets` are a great way to add a two way instant data channel between server and client. 
 
+LNbits has a useful in built websocket tool. With a websocket client connect to (obv change `somespecificid`) `wss://legend.lnbits.com/api/v1/ws/somespecificid` (you can use an online websocket tester). Now make a get to `https://legend.lnbits.com/api/v1/ws/somespecificid/somedata`. You can send data to that websocket by using `from lnbits.core.services import websocketUpdater` and the function `websocketUpdater("somespecificid", "somdata")`.
 
-```sh
-from fastapi import Request, WebSocket, WebSocketDisconnect
-
-class ConnectionManager:
-    def __init__(self):
-        self.active_connections: List[WebSocket] = []
-
-    async def connect(self, websocket: WebSocket, extension_id: str):
-        await websocket.accept()
-        websocket.id = extension_id
-        self.active_connections.append(websocket)
-
-    def disconnect(self, websocket: WebSocket):
-        self.active_connections.remove(websocket)
-
-    async def send_personal_message(self, message: str, extension_id: str):
-        for connection in self.active_connections:
-            if connection.id == extension_id:
-                await connection.send_text(message)
-
-    async def broadcast(self, message: str):
-        for connection in self.active_connections:
-            await connection.send_text(message)
-
-
-manager = ConnectionManager()
-
-
-@extension_ext.websocket("/ws/{extension_id}", name="extension.websocket_by_id")
-async def websocket_endpoint(websocket: WebSocket, extension_id: str):
-    await manager.connect(websocket, extension_id)
-    try:
-        while True:
-            data = await websocket.receive_text()
-    except WebSocketDisconnect:
-        manager.disconnect(websocket)
-
-
-async def updater(extension_id, data):
-    extension = await get_extension(extension_id)
-    if not extension:
-        return
-    await manager.send_personal_message(f"{data}", extension_id)
-```
 
 Example vue-js function for listening to the websocket:
 
@@ -67,16 +24,16 @@ initWs: async function () {
           document.domain +
           ':' +
           location.port +
-          '/extension/ws/' +
-          self.extension.id
+          '/api/v1/ws/' +
+          self.item.id
       } else {
         localUrl =
           'ws://' +
           document.domain +
           ':' +
           location.port +
-          '/extension/ws/' +
-          self.extension.id
+          '/api/v1/ws/' +
+          self.item.id
       }
     this.ws = new WebSocket(localUrl)
     this.ws.addEventListener('message', async ({data}) => {

docs/guide/installation.md

@@ -75,8 +75,8 @@ LNBITS_DATA_FOLDER=data LNBITS_BACKEND_WALLET_CLASS=LNbitsWallet LNBITS_ENDPOINT
 ```sh
 git clone https://github.com/lnbits/lnbits-legend.git
 cd lnbits-legend/
-# ensure you have virtualenv installed, on debian/ubuntu 'apt install python3-venv'
-python3 -m venv venv
+# ensure you have virtualenv installed, on debian/ubuntu 'apt install python3.9-venv'
+python3.9 -m venv venv
 # If you have problems here, try `sudo apt install -y pkg-config libpq-dev`
 ./venv/bin/pip install -r requirements.txt
 # create the data folder and the .env file
@@ -106,7 +106,7 @@ docker run --detach --publish 5000:5000 --name lnbits-legend --volume ${PWD}/.en
 
 ## Option 5: Fly.io
 
-Fly.io is a docker container hosting platform that has a generous free tier. You can host LNBits for free on Fly.io for personal use.
+Fly.io is a docker container hosting platform that has a generous free tier. You can host LNbits for free on Fly.io for personal use.
 
 First, sign up for an account at [Fly.io](https://fly.io) (no credit card required). 
 
@@ -169,7 +169,7 @@ kill_timeout = 30
 ...
 ```
 
-Next, create a volume to store the sqlite database for LNBits. Be sure to choose the same region for the volume that you chose earlier.
+Next, create a volume to store the sqlite database for LNbits. Be sure to choose the same region for the volume that you chose earlier.
 
 ```
 fly volumes create lnbits_data --size 1