Support Docker and improve README.md (#648)
# PR Checklist - [ ] Did you check if it works normally in all models? *ignore this when it dosen't uses models* - [ ] Did you check if it works normally in all of web, local and node hosted versions? if it dosen't, did you blocked it in those versions? - [ ] Did you added a type def? # Description This PR introduces two main changes: 1. Adds Docker support to the RisuAI project, making it easier for users to deploy and manage the application in a containerized environment. This is particularly useful for those who want to host the web version of RisuAI. 2. Improves the README file: - Enhances the readability of the screenshots table - Corrects spelling and grammar issues in the Features section - Improves overall formatting and consistency ## Docker Usage Run the following command in the root directory: ```shell docker-compose up -d
This commit is contained in:
1
.dockerignore
Normal file
1
.dockerignore
Normal file
@@ -0,0 +1 @@
|
||||
node_modules
|
||||
10
Dockerfile
Normal file
10
Dockerfile
Normal file
@@ -0,0 +1,10 @@
|
||||
FROM node:20
|
||||
WORKDIR /app
|
||||
COPY . .
|
||||
RUN corepack enable && \
|
||||
corepack install --global pnpm@latest
|
||||
RUN pnpm install --frozen-lockfile
|
||||
RUN pnpm build
|
||||
ENV NODE_ENV=production
|
||||
EXPOSE 6001
|
||||
CMD ["pnpm", "runserver"]
|
||||
61
README.md
61
README.md
@@ -1,4 +1,5 @@
|
||||
# RisuAI
|
||||
|
||||
<picture>
|
||||
<source media="(prefers-color-scheme: dark)" srcset="https://github.com/kwaroran/RisuAI/assets/116663078/efbbfe78-65ad-43ef-89f8-36fa94826925">
|
||||
<img alt="text" src="https://github.com/kwaroran/RisuAI/assets/116663078/bc28e5a3-c6da-4a42-bfc1-f3ab3debdf65">
|
||||
@@ -9,33 +10,57 @@
|
||||
RisuAI, or Risu for short, is a cross platform AI chatting software / web application with powerful features such as multiple API support, assets in the chat, regex functions and much more.
|
||||
|
||||
# Screenshots
|
||||
| |  |
|
||||
| --- | --- |
|
||||
| |  |
|
||||
|
||||
| Screenshot 1 | Screenshot 2 |
|
||||
| :--------------------------: | :--------------------------: |
|
||||
| ![Screenshot 1][screenshot1] | ![Screenshot 2][screenshot2] |
|
||||
| ![Screenshot 3][screenshot3] | ![Screenshot 4][screenshot4] |
|
||||
|
||||
[screenshot1]: https://github.com/kwaroran/RisuAI/assets/116663078/cccb9b33-5dbd-47d7-9c85-61464790aafe
|
||||
[screenshot2]: https://github.com/kwaroran/RisuAI/assets/116663078/30d29f85-1380-4c73-9b82-1a40f2c5d2ea
|
||||
[screenshot3]: https://github.com/kwaroran/RisuAI/assets/116663078/faad0de5-56f3-4176-b38e-61c2d3a8698e
|
||||
[screenshot4]: https://github.com/kwaroran/RisuAI/assets/116663078/ef946882-2311-43e7-81e7-5ca2d484fa90
|
||||
|
||||
## Features
|
||||
- **Multiple API Supports**: Supports OAI, Claude, Ooba, OpenRouter... and More!
|
||||
- **Emotion Images**: Display the image of the current character, according to his/her expressions!
|
||||
- **Group Chats**: Multiple characters in one chat.
|
||||
- **Plugins**: Add your features and providers, and simple share.
|
||||
- **Regex Script**: Modify model's output by regex, to make a custom gui and others
|
||||
- **Powerful Translators**: Automaticly translate the input/output, so you can roleplay without knowing model's language.
|
||||
- **Lorebook**: Also known as world infos or memory book, which can made character memorize more.
|
||||
- **Themes**: Choose it from 3 themes, Classic, WaifuLike, WaifuCut.
|
||||
- **Powerful Prompting**: Change the prompting order easily, Impersonaite inside prompts, Use conditions, varables... and more!
|
||||
- **Customizable, Friendly UI**: Great Accessibility and mobile friendly
|
||||
- **TTS**: Use TTS to make the output text into voice.
|
||||
- **Additonal Assets**: Embed your images, audios and videos to bot, and make it display at chat or background!
|
||||
- And More!
|
||||
|
||||
- **Multiple API Supports**: Supports OAI, Claude, Ooba, OpenRouter... and More!
|
||||
- **Emotion Images**: Display the image of the current character, according to his/her expressions!
|
||||
- **Group Chats**: Multiple characters in one chat.
|
||||
- **Plugins**: Add your features and providers, and simply share.
|
||||
- **Regex Script**: Modify model's output by regex, to make a custom GUI and others
|
||||
- **Powerful Translators**: Automatically translate the input/output, so you can roleplay without knowing model's language.
|
||||
- **Lorebook**: Also known as world infos or memory book, which can make character memorize more.
|
||||
- **Themes**: Choose it from 3 themes, Classic, WaifuLike, WaifuCut.
|
||||
- **Powerful Prompting**: Change the prompting order easily, Impersonate inside prompts, Use conditions, variables... and more!
|
||||
- **Customizable, Friendly UI**: Great Accessibility and mobile friendly
|
||||
- **TTS**: Use TTS to make the output text into voice.
|
||||
- **Additonal Assets**: Embed your images, audios and videos to bot, and make it display at chat or background!
|
||||
- And More!
|
||||
|
||||
You can get detailed information on https://github.com/kwaroran/RisuAI/wiki (Work in Progress)
|
||||
|
||||
|
||||
## Discord
|
||||
- https://discord.gg/JzP8tB9ZK8
|
||||
|
||||
- https://discord.gg/JzP8tB9ZK8
|
||||
|
||||
## Installation
|
||||
|
||||
- [RisuAI Website](https://risuai.net) (Recommended)
|
||||
- [Github Releases](https://github.com/kwaroran/RisuAI/releases)
|
||||
|
||||
### Docker Installation
|
||||
|
||||
You can also run RisuAI using Docker. This method is particularly useful for web hosting.
|
||||
|
||||
1. Clone the repository:
|
||||
```
|
||||
git clone https://github.com/kwaroran/RisuAI.git
|
||||
cd RisuAI
|
||||
```
|
||||
|
||||
2. Build and run the Docker container:
|
||||
```
|
||||
docker-compose up -d
|
||||
```
|
||||
|
||||
3. Access RisuAI at `http://localhost:6001` in your web browser.
|
||||
|
||||
12
docker-compose.yml
Normal file
12
docker-compose.yml
Normal file
@@ -0,0 +1,12 @@
|
||||
services:
|
||||
risuai:
|
||||
container_name: risuai
|
||||
build: .
|
||||
restart: always
|
||||
ports:
|
||||
- 6001:6001
|
||||
volumes:
|
||||
- risuai-save:/app/save
|
||||
|
||||
volumes:
|
||||
risuai-save:
|
||||
Reference in New Issue
Block a user