diff --git a/apps/cheshire-cat-ai/config.json b/apps/cheshire-cat-ai/config.json new file mode 100644 index 00000000..e829f767 --- /dev/null +++ b/apps/cheshire-cat-ai/config.json @@ -0,0 +1,23 @@ +{ + "name": "Cheshire Cat AI", + "available": true, + "port": 1865, + "exposable": true, + "id": "cheshire-cat-ai", + "description": "The Cheshire Cat is an open-source, hackable and production-ready framework that allows developing intelligent personal AI assistant agents on top of Large Language Models (LLM).", + "tipi_version": 1, + "version": "1.5.3", + "categories": [ + "ai" + ], + "short_desc": "A production-ready AI framework to develop AI agents.", + "author": "pieroit", + "source": "https://github.com/cheshire-cat-ai/core", + "website": "https://cheshirecat.ai", + "form_fields": [], + "url_suffix": "/admin", + "supported_architectures": [ + "amd64", + "arm64" + ] + } \ No newline at end of file diff --git a/apps/cheshire-cat-ai/docker-compose.yml b/apps/cheshire-cat-ai/docker-compose.yml new file mode 100644 index 00000000..488b0d82 --- /dev/null +++ b/apps/cheshire-cat-ai/docker-compose.yml @@ -0,0 +1,45 @@ +version: '3.7' + +services: + cheshire-cat-ai: + networks: + - tipi_main_network + image: ghcr.io/cheshire-cat-ai/core:1.5.3 + container_name: cheshire-cat-ai + ports: + - ${APP_PORT}:80 + environment: + - PYTHONUNBUFFERED=1 + - WATCHFILES_FORCE_POLLING=true + volumes: + - ${APP_DATA_DIR}/data/static:/app/cat/static + - ${APP_DATA_DIR}/data/plugins:/app/cat/plugins + - ${APP_DATA_DIR}/data/data:/app/cat/data + labels: + # Main + traefik.enable: true + traefik.http.middlewares.cheshire-web-redirect.redirectscheme.scheme: https + traefik.http.services.cheshire.loadbalancer.server.port: 1865 + # Web + traefik.http.routers.cheshire-insecure.rule: Host(`${APP_DOMAIN}`) + traefik.http.routers.cheshire-insecure.entrypoints: web + traefik.http.routers.cheshire-insecure.service: cheshire-cat-ai + traefik.http.routers.cheshire-insecure.middlewares: cheshire-cat-ai-web-redirect + # Websecure + traefik.http.routers.cheshire.rule: Host(`${APP_DOMAIN}`) + traefik.http.routers.cheshire.entrypoints: websecure + traefik.http.routers.cheshire.service: cheshire-cat-ai + traefik.http.routers.cheshire.tls.certresolver: myresolver + # Local domain + traefik.http.routers.cheshire-local-insecure.rule: Host(`cheshire-cat-ai.${LOCAL_DOMAIN}`) + traefik.http.routers.cheshire-local-insecure.entrypoints: web + traefik.http.routers.cheshire-local-insecure.service: cheshire-cat-ai + traefik.http.routers.cheshire-local-insecure.middlewares: cheshire-cat-ai-web-redirect + # Local domain secure + traefik.http.routers.cheshire-local.rule: Host(`cheshire-cat-ai.${LOCAL_DOMAIN}`) + traefik.http.routers.cheshire-local.entrypoints: websecure + traefik.http.routers.cheshire-local.service: cheshire-cat-ai + traefik.http.routers.cheshire-local.tls: true +networks: + tipi-main-network: + driver: bridge \ No newline at end of file diff --git a/apps/cheshire-cat-ai/metadata/description.md b/apps/cheshire-cat-ai/metadata/description.md new file mode 100644 index 00000000..319f1c24 --- /dev/null +++ b/apps/cheshire-cat-ai/metadata/description.md @@ -0,0 +1,78 @@ + + +
+
+

Cheshire-Cat (Stregatto)

+
+ + GitHub Repo stars + + + chat on Discord + + GitHub issues + + + GitHub tag (with filter) + + GitHub top language + +

+ Wikipedia picture of the Cheshire Cat +

+ +
+ +## Production-ready AI assistant framework + +The Cheshire Cat is a framework to build custom AIs on top of any language model. +If you have ever used systems like WordPress or Django to build web apps, imagine the Cat as a similar tool, but specific for AI. + +## Docs and Resources + +- [Official Documentation](https://cheshire-cat-ai.github.io/docs/) +- [Discord Server](https://discord.gg/bHX5sNFCYU) +- [Website](https://cheshirecat.ai/) +- [YouTube tutorial - How to install](https://youtu.be/Rvx19TZBCrw) +- [Tutorial - Write your first plugin](https://cheshirecat.ai/write-your-first-plugin/) + +## Why using the Cat + +- โšก๏ธ API first, so you get a microservice to easily add a conversational layer to your app +- ๐Ÿ˜ Remembers conversations and documents and uses them in conversation +- ๐Ÿš€ Extensible via plugins (public plugin registry + private plugins allowed) +- ๐ŸŽš Event callbacks, function calling (tools), conversational forms +- ๐Ÿ› Easy to use admin panel (chat, visualize memory and plugins, adjust settings) +- ๐ŸŒ Supports any language model (works with OpenAI, Google, Ollama, HuggingFace, custom services) +- ๐Ÿ‹ Production-ready - 100% [dockerized](https://docs.docker.com/get-docker/) +- ๐Ÿ‘ฉโ€๐Ÿ‘งโ€๐Ÿ‘ฆ Active [Discord community](https://discord.gg/bHX5sNFCYU) and easy to understand [docs](https://cheshire-cat-ai.github.io/docs/) + +We are committed to openness, privacy and creativity, we want to bring AI to the long tail. To learn more about our vision and values, read the [Code of Ethics](https://cheshirecat.ai/code-of-ethics/). + + +## Roadmap & Contributing + +The Detailed roadmap is [here](https://github.com/cheshire-cat-ai/core/blob/main/readme/ROADMAP.md). +Send your pull request to the `develop` branch. Here is a [full guide to contributing](https://github.com/cheshire-cat-ai/core/blob/main/readme/CONTRIBUTING.md). + +Join our [community on Discord](https://discord.gg/bHX5sNFCYU) and give the project a star โญ! +Thanks again!๐Ÿ™ + +## Which way to go? + +

(back to top)

+ +

+ Wikipedia picture of the Cheshire Cat +

+ +``` +"Would you tell me, please, which way I ought to go from here?" +"That depends a good deal on where you want to get to," said the Cat. +"I don't much care where--" said Alice. +"Then it doesn't matter which way you go," said the Cat. + +(Alice's Adventures in Wonderland - Lewis Carroll) + +``` diff --git a/apps/cheshire-cat-ai/metadata/logo.jpg b/apps/cheshire-cat-ai/metadata/logo.jpg new file mode 100644 index 00000000..de860cb8 Binary files /dev/null and b/apps/cheshire-cat-ai/metadata/logo.jpg differ