From ac370a8718c59af88578a22206f03349c2fbb956 Mon Sep 17 00:00:00 2001 From: Naki Date: Sun, 13 Oct 2024 01:29:12 +0900 Subject: [PATCH 1/4] Support Docker --- .dockerignore | 1 + Dockerfile | 10 ++++++++++ docker-compose.yml | 12 ++++++++++++ 3 files changed, 23 insertions(+) create mode 100644 .dockerignore create mode 100644 Dockerfile create mode 100644 docker-compose.yml diff --git a/.dockerignore b/.dockerignore new file mode 100644 index 00000000..3c3629e6 --- /dev/null +++ b/.dockerignore @@ -0,0 +1 @@ +node_modules diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 00000000..1f696b9d --- /dev/null +++ b/Dockerfile @@ -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"] diff --git a/docker-compose.yml b/docker-compose.yml new file mode 100644 index 00000000..ba961c18 --- /dev/null +++ b/docker-compose.yml @@ -0,0 +1,12 @@ +services: + risuai: + container_name: risuai + build: . + restart: always + expose: + - 6001 + volumes: + - risuai-save:/app/save + +volumes: + risuai-save: From 4a61b19a0574adb10dd857339381b463c6ad81c7 Mon Sep 17 00:00:00 2001 From: Naki Date: Sun, 13 Oct 2024 01:39:46 +0900 Subject: [PATCH 2/4] Update README.md --- README.md | 23 ++++++++++++++++++++--- 1 file changed, 20 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index fae4b3ff..32616bde 100644 --- a/README.md +++ b/README.md @@ -9,9 +9,9 @@ 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_6](https://github.com/kwaroran/RisuAI/assets/116663078/cccb9b33-5dbd-47d7-9c85-61464790aafe) | ![image](https://github.com/kwaroran/RisuAI/assets/116663078/30d29f85-1380-4c73-9b82-1a40f2c5d2ea) | -| --- | --- | -|![a04a68f26852d53a1aedd661f3ebbc5fd78400007e1cf85ff28f3a09243fb3ca](https://github.com/kwaroran/RisuAI/assets/116663078/faad0de5-56f3-4176-b38e-61c2d3a8698e) | ![Screenshot_11](https://github.com/kwaroran/RisuAI/assets/116663078/ef946882-2311-43e7-81e7-5ca2d484fa90) | +| ![Screenshot_6](https://github.com/kwaroran/RisuAI/assets/116663078/cccb9b33-5dbd-47d7-9c85-61464790aafe) | ![image](https://github.com/kwaroran/RisuAI/assets/116663078/30d29f85-1380-4c73-9b82-1a40f2c5d2ea) | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | +| ![a04a68f26852d53a1aedd661f3ebbc5fd78400007e1cf85ff28f3a09243fb3ca](https://github.com/kwaroran/RisuAI/assets/116663078/faad0de5-56f3-4176-b38e-61c2d3a8698e) | ![Screenshot_11](https://github.com/kwaroran/RisuAI/assets/116663078/ef946882-2311-43e7-81e7-5ca2d484fa90) | ## Features @@ -39,3 +39,20 @@ You can get detailed information on https://github.com/kwaroran/RisuAI/wiki (Wor - [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. From 3f9d02c5d36c9a03ff1f71529b28592e0f46ac3b Mon Sep 17 00:00:00 2001 From: Naki Date: Sun, 13 Oct 2024 01:46:57 +0900 Subject: [PATCH 3/4] Improve README.md --- README.md | 44 ++++++++++++++++++++++++++------------------ 1 file changed, 26 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 32616bde..3461e916 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,5 @@ # RisuAI + text @@ -9,31 +10,38 @@ 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_6](https://github.com/kwaroran/RisuAI/assets/116663078/cccb9b33-5dbd-47d7-9c85-61464790aafe) | ![image](https://github.com/kwaroran/RisuAI/assets/116663078/30d29f85-1380-4c73-9b82-1a40f2c5d2ea) | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| ![a04a68f26852d53a1aedd661f3ebbc5fd78400007e1cf85ff28f3a09243fb3ca](https://github.com/kwaroran/RisuAI/assets/116663078/faad0de5-56f3-4176-b38e-61c2d3a8698e) | ![Screenshot_11](https://github.com/kwaroran/RisuAI/assets/116663078/ef946882-2311-43e7-81e7-5ca2d484fa90) | +| 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 From 5fe104661fff24c5ad62ceb611d4a5e686ae52ac Mon Sep 17 00:00:00 2001 From: Naki Date: Sun, 13 Oct 2024 01:49:53 +0900 Subject: [PATCH 4/4] Change `expose` to `ports` in docker-compose.yml --- docker-compose.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docker-compose.yml b/docker-compose.yml index ba961c18..90be6345 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -3,8 +3,8 @@ services: container_name: risuai build: . restart: always - expose: - - 6001 + ports: + - 6001:6001 volumes: - risuai-save:/app/save