Akiru
/
nyx
forked from pinks/eris
1
0
Fork 0
Code Pull Requests Activity
nyx/README.md

46 lines
2.0 KiB
Markdown
Raw Normal View History

initial commit
2023-09-03 19:06:20 +00:00
# Eris the Bot
add badges to readme
2023-11-06 17:38:41 +00:00
[![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)
initial commit
2023-09-03 19:06:20 +00:00
Telegram bot for generating images from text.
## Requirements
- [Deno](https://deno.land/)
chore: split into modules
2023-09-04 16:55:48 +00:00
- [Stable Diffusion WebUI](https://github.com/AUTOMATIC1111/stable-diffusion-webui/)
initial commit
2023-09-03 19:06:20 +00:00
## Options
You can put these in `.env` file or pass them as environment variables.
big rewrite
2023-09-10 18:56:17 +00:00
- `TG_BOT_TOKEN` - Telegram bot token. Get yours from [@BotFather](https://t.me/BotFather).
Required.
add env var for db path
2023-10-18 21:11:25 +00:00
- `DENO_KV_PATH` - [Deno KV](https://deno.land/api?s=Deno.openKv&unstable) database file path. A
temporary file is used by default.
allow configuring log level
2023-10-15 19:13:38 +00:00
- `LOG_LEVEL` - [Log level](https://deno.land/std@0.201.0/log/mod.ts?s=LogLevels). Default: `INFO`.
initial commit
2023-09-03 19:06:20 +00:00
add env var for db path
2023-10-18 21:11:25 +00:00
## Running
big rewrite
2023-09-22 02:59:22 +00:00
feat: managing admins in webui
2023-10-23 00:39:01 +00:00
1. Start Eris: `deno task start`
2. Visit [Eris WebUI](http://localhost:5999/) 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.
allow configuring log level
2023-10-15 19:13:38 +00:00
big rewrite
2023-09-22 02:59:22 +00:00
## Codegen
sort config
2023-10-18 21:08:18 +00:00
The Stable Diffusion API types are auto-generated. To regenerate them, first start your SD WebUI
with `--nowebui --api`, and then run `deno task generate`
update README
2023-10-18 21:11:39 +00:00
## Project structure
- `/api` - Eris API served at `http://localhost:5999/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/`.
- `/util` - Utility functions shared by other parts.