From eaff7c0772f1fcda102880e403ddf8cf982a3be6 Mon Sep 17 00:00:00 2001 From: Akiru Date: Fri, 26 Jan 2024 13:13:31 +0000 Subject: [PATCH] README.md aktualisiert --- README.md | 27 ++++++++++++++------------- 1 file changed, 14 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 96e5ef4..1d67d8d 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,12 @@ -# Eris the Bot - -[![Website](https://img.shields.io/website?url=https%3A%2F%2Feris.lisq.eu%2F)](https://eris.lisq.eu/) -![Unique users](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Feris.lisq.eu%2Fapi%2Fstats&query=%24.userCount&label=unique%20users) -![Generated images](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Feris.lisq.eu%2Fapi%2Fstats&query=%24.imageCount&label=images%20generated) -![Processed steps](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Feris.lisq.eu%2Fapi%2Fstats&query=%24.stepCount&label=steps%20processed) -![Painted pixels](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Feris.lisq.eu%2Fapi%2Fstats&query=%24.pixelCount&label=pixels%20painted) +# Nyx the Bot +Fork of Eris the Bot https://eris.lisq.eu Telegram bot for generating images from text. ## Requirements -- [Deno](https://deno.land/) -- [Stable Diffusion WebUI](https://github.com/AUTOMATIC1111/stable-diffusion-webui/) +- [Deno](https://deno.land/) (for the bot server) +- [Stable Diffusion WebUI](https://github.com/AUTOMATIC1111/stable-diffusion-webui/) (for the worker that generates images) ## Options @@ -20,17 +15,23 @@ You can put these in `.env` file or pass them as environment variables. - `TG_BOT_TOKEN` - Telegram bot token. Get yours from [@BotFather](https://t.me/BotFather). Required. - `DENO_KV_PATH` - [Deno KV](https://deno.land/api?s=Deno.openKv&unstable) database file path. A - temporary file is used by default. + temporary file is used by default. Example: /opt/data/botdata.kv - `LOG_LEVEL` - [Log level](https://deno.land/std@0.201.0/log/mod.ts?s=LogLevels). Default: `INFO`. ## Running 1. Start Eris: `deno task start` -2. Visit [Eris WebUI](http://localhost:5999/) and login via Telegram. +2. Visit [Eris WebUI](http://localhost:8443/) and login via Telegram. 3. Promote yourself to admin in the Eris WebUI. 4. Start Stable Diffusion WebUI: `./webui.sh --api` (in SD WebUI directory) 5. Add a new worker in the Eris WebUI. +## This fork requires the use of webhooks. + +1. You need a reverse Proxy and HTTPS certificate set up that proxies all requests from a domain on port 443 (e.g. nyx.akiru.de) to the backend of this bot (:8443). +2. Change the Webhook URL to your own one in /mod/bot.ts - There are also console log statements you can uncomment for troubleshooting. +3. Make sure the DNS and firewall are set up for the webhook to be reachable, because otherwise the bot fails to start. + ## Codegen The Stable Diffusion API types are auto-generated. To regenerate them, first start your SD WebUI @@ -38,8 +39,8 @@ with `--nowebui --api`, and then run `deno task generate` ## Project structure -- `/api` - Eris API served at `http://localhost:5999/api/`. +- `/api` - Eris API served at `http://localhost:8443/api/`. - `/app` - Queue handling and other core processes. - `/bot` - Handling bot commands and other updates from Telegram API. -- `/ui` - Eris WebUI frontend files served at `http://localhost:5999/`. +- `/ui` - Eris WebUI frontend files served at `http://localhost:8443/`. - `/util` - Utility functions shared by other parts.