mirror of
https://github.com/ItzCrazyKns/Perplexica.git
synced 2026-03-13 08:06:47 +00:00
feat(app): rename to 'vane'
This commit is contained in:
Binary file not shown.
|
Before Width: | Height: | Size: 2.1 MiB |
BIN
.assets/vane-screenshot.png
Normal file
BIN
.assets/vane-screenshot.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 1.6 MiB |
80
.github/workflows/docker-build.yaml
vendored
80
.github/workflows/docker-build.yaml
vendored
@@ -44,11 +44,11 @@ jobs:
|
|||||||
DOCKERFILE=${{ matrix.variant.dockerfile }}
|
DOCKERFILE=${{ matrix.variant.dockerfile }}
|
||||||
VARIANT=${{ matrix.variant.name }}
|
VARIANT=${{ matrix.variant.name }}
|
||||||
docker buildx build --platform linux/amd64 \
|
docker buildx build --platform linux/amd64 \
|
||||||
--cache-from=type=registry,ref=itzcrazykns1337/perplexica:${VARIANT}-amd64 \
|
--cache-from=type=registry,ref=itzcrazykns1337/vane:${VARIANT}-amd64 \
|
||||||
--cache-to=type=inline \
|
--cache-to=type=inline \
|
||||||
--provenance false \
|
--provenance false \
|
||||||
-f $DOCKERFILE \
|
-f $DOCKERFILE \
|
||||||
-t itzcrazykns1337/perplexica:${VARIANT}-amd64 \
|
-t itzcrazykns1337/vane:${VARIANT}-amd64 \
|
||||||
--push .
|
--push .
|
||||||
|
|
||||||
- name: Build and push AMD64 Canary Docker image
|
- name: Build and push AMD64 Canary Docker image
|
||||||
@@ -57,11 +57,11 @@ jobs:
|
|||||||
DOCKERFILE=${{ matrix.variant.dockerfile }}
|
DOCKERFILE=${{ matrix.variant.dockerfile }}
|
||||||
VARIANT=${{ matrix.variant.name }}
|
VARIANT=${{ matrix.variant.name }}
|
||||||
docker buildx build --platform linux/amd64 \
|
docker buildx build --platform linux/amd64 \
|
||||||
--cache-from=type=registry,ref=itzcrazykns1337/perplexica:${VARIANT}-canary-amd64 \
|
--cache-from=type=registry,ref=itzcrazykns1337/vane:${VARIANT}-canary-amd64 \
|
||||||
--cache-to=type=inline \
|
--cache-to=type=inline \
|
||||||
--provenance false \
|
--provenance false \
|
||||||
-f $DOCKERFILE \
|
-f $DOCKERFILE \
|
||||||
-t itzcrazykns1337/perplexica:${VARIANT}-canary-amd64 \
|
-t itzcrazykns1337/vane:${VARIANT}-canary-amd64 \
|
||||||
--push .
|
--push .
|
||||||
|
|
||||||
- name: Build and push AMD64 release Docker image
|
- name: Build and push AMD64 release Docker image
|
||||||
@@ -70,11 +70,11 @@ jobs:
|
|||||||
DOCKERFILE=${{ matrix.variant.dockerfile }}
|
DOCKERFILE=${{ matrix.variant.dockerfile }}
|
||||||
VARIANT=${{ matrix.variant.name }}
|
VARIANT=${{ matrix.variant.name }}
|
||||||
docker buildx build --platform linux/amd64 \
|
docker buildx build --platform linux/amd64 \
|
||||||
--cache-from=type=registry,ref=itzcrazykns1337/perplexica:${VARIANT}-${{ env.RELEASE_VERSION }}-amd64 \
|
--cache-from=type=registry,ref=itzcrazykns1337/vane:${VARIANT}-${{ env.RELEASE_VERSION }}-amd64 \
|
||||||
--cache-to=type=inline \
|
--cache-to=type=inline \
|
||||||
--provenance false \
|
--provenance false \
|
||||||
-f $DOCKERFILE \
|
-f $DOCKERFILE \
|
||||||
-t itzcrazykns1337/perplexica:${VARIANT}-${{ env.RELEASE_VERSION }}-amd64 \
|
-t itzcrazykns1337/vane:${VARIANT}-${{ env.RELEASE_VERSION }}-amd64 \
|
||||||
--push .
|
--push .
|
||||||
|
|
||||||
build-arm64:
|
build-arm64:
|
||||||
@@ -112,11 +112,11 @@ jobs:
|
|||||||
DOCKERFILE=${{ matrix.variant.dockerfile }}
|
DOCKERFILE=${{ matrix.variant.dockerfile }}
|
||||||
VARIANT=${{ matrix.variant.name }}
|
VARIANT=${{ matrix.variant.name }}
|
||||||
docker buildx build --platform linux/arm64 \
|
docker buildx build --platform linux/arm64 \
|
||||||
--cache-from=type=registry,ref=itzcrazykns1337/perplexica:${VARIANT}-arm64 \
|
--cache-from=type=registry,ref=itzcrazykns1337/vane:${VARIANT}-arm64 \
|
||||||
--cache-to=type=inline \
|
--cache-to=type=inline \
|
||||||
--provenance false \
|
--provenance false \
|
||||||
-f $DOCKERFILE \
|
-f $DOCKERFILE \
|
||||||
-t itzcrazykns1337/perplexica:${VARIANT}-arm64 \
|
-t itzcrazykns1337/vane:${VARIANT}-arm64 \
|
||||||
--push .
|
--push .
|
||||||
|
|
||||||
- name: Build and push ARM64 Canary Docker image
|
- name: Build and push ARM64 Canary Docker image
|
||||||
@@ -125,11 +125,11 @@ jobs:
|
|||||||
DOCKERFILE=${{ matrix.variant.dockerfile }}
|
DOCKERFILE=${{ matrix.variant.dockerfile }}
|
||||||
VARIANT=${{ matrix.variant.name }}
|
VARIANT=${{ matrix.variant.name }}
|
||||||
docker buildx build --platform linux/arm64 \
|
docker buildx build --platform linux/arm64 \
|
||||||
--cache-from=type=registry,ref=itzcrazykns1337/perplexica:${VARIANT}-canary-arm64 \
|
--cache-from=type=registry,ref=itzcrazykns1337/vane:${VARIANT}-canary-arm64 \
|
||||||
--cache-to=type=inline \
|
--cache-to=type=inline \
|
||||||
--provenance false \
|
--provenance false \
|
||||||
-f $DOCKERFILE \
|
-f $DOCKERFILE \
|
||||||
-t itzcrazykns1337/perplexica:${VARIANT}-canary-arm64 \
|
-t itzcrazykns1337/vane:${VARIANT}-canary-arm64 \
|
||||||
--push .
|
--push .
|
||||||
|
|
||||||
- name: Build and push ARM64 release Docker image
|
- name: Build and push ARM64 release Docker image
|
||||||
@@ -138,11 +138,11 @@ jobs:
|
|||||||
DOCKERFILE=${{ matrix.variant.dockerfile }}
|
DOCKERFILE=${{ matrix.variant.dockerfile }}
|
||||||
VARIANT=${{ matrix.variant.name }}
|
VARIANT=${{ matrix.variant.name }}
|
||||||
docker buildx build --platform linux/arm64 \
|
docker buildx build --platform linux/arm64 \
|
||||||
--cache-from=type=registry,ref=itzcrazykns1337/perplexica:${VARIANT}-${{ env.RELEASE_VERSION }}-arm64 \
|
--cache-from=type=registry,ref=itzcrazykns1337/vane:${VARIANT}-${{ env.RELEASE_VERSION }}-arm64 \
|
||||||
--cache-to=type=inline \
|
--cache-to=type=inline \
|
||||||
--provenance false \
|
--provenance false \
|
||||||
-f $DOCKERFILE \
|
-f $DOCKERFILE \
|
||||||
-t itzcrazykns1337/perplexica:${VARIANT}-${{ env.RELEASE_VERSION }}-arm64 \
|
-t itzcrazykns1337/vane:${VARIANT}-${{ env.RELEASE_VERSION }}-arm64 \
|
||||||
--push .
|
--push .
|
||||||
|
|
||||||
manifest:
|
manifest:
|
||||||
@@ -167,51 +167,51 @@ jobs:
|
|||||||
if: github.ref == 'refs/heads/master' && github.event_name == 'push'
|
if: github.ref == 'refs/heads/master' && github.event_name == 'push'
|
||||||
run: |
|
run: |
|
||||||
VARIANT=${{ matrix.variant }}
|
VARIANT=${{ matrix.variant }}
|
||||||
docker manifest create itzcrazykns1337/perplexica:${VARIANT}-latest \
|
docker manifest create itzcrazykns1337/vane:${VARIANT}-latest \
|
||||||
--amend itzcrazykns1337/perplexica:${VARIANT}-amd64 \
|
--amend itzcrazykns1337/vane:${VARIANT}-amd64 \
|
||||||
--amend itzcrazykns1337/perplexica:${VARIANT}-arm64
|
--amend itzcrazykns1337/vane:${VARIANT}-arm64
|
||||||
docker manifest push itzcrazykns1337/perplexica:${VARIANT}-latest
|
docker manifest push itzcrazykns1337/vane:${VARIANT}-latest
|
||||||
|
|
||||||
if [ "$VARIANT" = "full" ]; then
|
if [ "$VARIANT" = "full" ]; then
|
||||||
docker manifest create itzcrazykns1337/perplexica:latest \
|
docker manifest create itzcrazykns1337/vane:latest \
|
||||||
--amend itzcrazykns1337/perplexica:${VARIANT}-amd64 \
|
--amend itzcrazykns1337/vane:${VARIANT}-amd64 \
|
||||||
--amend itzcrazykns1337/perplexica:${VARIANT}-arm64
|
--amend itzcrazykns1337/vane:${VARIANT}-arm64
|
||||||
docker manifest push itzcrazykns1337/perplexica:latest
|
docker manifest push itzcrazykns1337/vane:latest
|
||||||
|
|
||||||
docker manifest create itzcrazykns1337/perplexica:main \
|
docker manifest create itzcrazykns1337/vane:main \
|
||||||
--amend itzcrazykns1337/perplexica:${VARIANT}-amd64 \
|
--amend itzcrazykns1337/vane:${VARIANT}-amd64 \
|
||||||
--amend itzcrazykns1337/perplexica:${VARIANT}-arm64
|
--amend itzcrazykns1337/vane:${VARIANT}-arm64
|
||||||
docker manifest push itzcrazykns1337/perplexica:main
|
docker manifest push itzcrazykns1337/vane:main
|
||||||
fi
|
fi
|
||||||
|
|
||||||
- name: Create and push manifest for canary
|
- name: Create and push manifest for canary
|
||||||
if: github.ref == 'refs/heads/canary' && github.event_name == 'push'
|
if: github.ref == 'refs/heads/canary' && github.event_name == 'push'
|
||||||
run: |
|
run: |
|
||||||
VARIANT=${{ matrix.variant }}
|
VARIANT=${{ matrix.variant }}
|
||||||
docker manifest create itzcrazykns1337/perplexica:${VARIANT}-canary \
|
docker manifest create itzcrazykns1337/vane:${VARIANT}-canary \
|
||||||
--amend itzcrazykns1337/perplexica:${VARIANT}-canary-amd64 \
|
--amend itzcrazykns1337/vane:${VARIANT}-canary-amd64 \
|
||||||
--amend itzcrazykns1337/perplexica:${VARIANT}-canary-arm64
|
--amend itzcrazykns1337/vane:${VARIANT}-canary-arm64
|
||||||
docker manifest push itzcrazykns1337/perplexica:${VARIANT}-canary
|
docker manifest push itzcrazykns1337/vane:${VARIANT}-canary
|
||||||
|
|
||||||
if [ "$VARIANT" = "full" ]; then
|
if [ "$VARIANT" = "full" ]; then
|
||||||
docker manifest create itzcrazykns1337/perplexica:canary \
|
docker manifest create itzcrazykns1337/vane:canary \
|
||||||
--amend itzcrazykns1337/perplexica:${VARIANT}-canary-amd64 \
|
--amend itzcrazykns1337/vane:${VARIANT}-canary-amd64 \
|
||||||
--amend itzcrazykns1337/perplexica:${VARIANT}-canary-arm64
|
--amend itzcrazykns1337/vane:${VARIANT}-canary-arm64
|
||||||
docker manifest push itzcrazykns1337/perplexica:canary
|
docker manifest push itzcrazykns1337/vane:canary
|
||||||
fi
|
fi
|
||||||
|
|
||||||
- name: Create and push manifest for releases
|
- name: Create and push manifest for releases
|
||||||
if: github.event_name == 'release'
|
if: github.event_name == 'release'
|
||||||
run: |
|
run: |
|
||||||
VARIANT=${{ matrix.variant }}
|
VARIANT=${{ matrix.variant }}
|
||||||
docker manifest create itzcrazykns1337/perplexica:${VARIANT}-${{ env.RELEASE_VERSION }} \
|
docker manifest create itzcrazykns1337/vane:${VARIANT}-${{ env.RELEASE_VERSION }} \
|
||||||
--amend itzcrazykns1337/perplexica:${VARIANT}-${{ env.RELEASE_VERSION }}-amd64 \
|
--amend itzcrazykns1337/vane:${VARIANT}-${{ env.RELEASE_VERSION }}-amd64 \
|
||||||
--amend itzcrazykns1337/perplexica:${VARIANT}-${{ env.RELEASE_VERSION }}-arm64
|
--amend itzcrazykns1337/vane:${VARIANT}-${{ env.RELEASE_VERSION }}-arm64
|
||||||
docker manifest push itzcrazykns1337/perplexica:${VARIANT}-${{ env.RELEASE_VERSION }}
|
docker manifest push itzcrazykns1337/vane:${VARIANT}-${{ env.RELEASE_VERSION }}
|
||||||
|
|
||||||
if [ "$VARIANT" = "full" ]; then
|
if [ "$VARIANT" = "full" ]; then
|
||||||
docker manifest create itzcrazykns1337/perplexica:${{ env.RELEASE_VERSION }} \
|
docker manifest create itzcrazykns1337/vane:${{ env.RELEASE_VERSION }} \
|
||||||
--amend itzcrazykns1337/perplexica:${VARIANT}-${{ env.RELEASE_VERSION }}-amd64 \
|
--amend itzcrazykns1337/vane:${VARIANT}-${{ env.RELEASE_VERSION }}-amd64 \
|
||||||
--amend itzcrazykns1337/perplexica:${VARIANT}-${{ env.RELEASE_VERSION }}-arm64
|
--amend itzcrazykns1337/vane:${VARIANT}-${{ env.RELEASE_VERSION }}-arm64
|
||||||
docker manifest push itzcrazykns1337/perplexica:${{ env.RELEASE_VERSION }}
|
docker manifest push itzcrazykns1337/vane:${{ env.RELEASE_VERSION }}
|
||||||
fi
|
fi
|
||||||
|
|||||||
@@ -1,12 +1,12 @@
|
|||||||
# How to Contribute to Perplexica
|
# How to Contribute to Vane
|
||||||
|
|
||||||
Thanks for your interest in contributing to Perplexica! Your help makes this project better. This guide explains how to contribute effectively.
|
Thanks for your interest in contributing to Vane! Your help makes this project better. This guide explains how to contribute effectively.
|
||||||
|
|
||||||
Perplexica is a modern AI chat application with advanced search capabilities.
|
Vane is a modern AI chat application with advanced search capabilities.
|
||||||
|
|
||||||
## Project Structure
|
## Project Structure
|
||||||
|
|
||||||
Perplexica's codebase is organized as follows:
|
Vane's codebase is organized as follows:
|
||||||
|
|
||||||
- **UI Components and Pages**:
|
- **UI Components and Pages**:
|
||||||
- **Components (`src/components`)**: Reusable UI components.
|
- **Components (`src/components`)**: Reusable UI components.
|
||||||
@@ -53,7 +53,7 @@ If you are not sure where to start, use this section as a map.
|
|||||||
|
|
||||||
## API Documentation
|
## API Documentation
|
||||||
|
|
||||||
Perplexica includes API documentation for programmatic access.
|
Vane includes API documentation for programmatic access.
|
||||||
|
|
||||||
- **Search API**: For detailed documentation, see `docs/API/SEARCH.md`.
|
- **Search API**: For detailed documentation, see `docs/API/SEARCH.md`.
|
||||||
|
|
||||||
@@ -79,4 +79,4 @@ Before committing changes:
|
|||||||
2. Always run `npm run format:write` to format your code according to the project's coding standards. This helps maintain consistency and code quality.
|
2. Always run `npm run format:write` to format your code according to the project's coding standards. This helps maintain consistency and code quality.
|
||||||
3. We currently do not have a code of conduct, but it is in the works. In the meantime, please be mindful of how you engage with the project and its community.
|
3. We currently do not have a code of conduct, but it is in the works. In the meantime, please be mindful of how you engage with the project and its community.
|
||||||
|
|
||||||
Following these steps will help maintain the integrity of Perplexica's codebase and facilitate a smoother integration of your valuable contributions. Thank you for your support and commitment to improving Perplexica.
|
Following these steps will help maintain the integrity of Vane's codebase and facilitate a smoother integration of your valuable contributions. Thank you for your support and commitment to improving Vane.
|
||||||
|
|||||||
20
Dockerfile
20
Dockerfile
@@ -2,7 +2,7 @@ FROM node:24.5.0-slim AS builder
|
|||||||
|
|
||||||
RUN apt-get update && apt-get install -y python3 python3-pip sqlite3 && rm -rf /var/lib/apt/lists/*
|
RUN apt-get update && apt-get install -y python3 python3-pip sqlite3 && rm -rf /var/lib/apt/lists/*
|
||||||
|
|
||||||
WORKDIR /home/perplexica
|
WORKDIR /home/vane
|
||||||
|
|
||||||
COPY package.json yarn.lock ./
|
COPY package.json yarn.lock ./
|
||||||
RUN yarn install --frozen-lockfile --network-timeout 600000
|
RUN yarn install --frozen-lockfile --network-timeout 600000
|
||||||
@@ -12,7 +12,7 @@ COPY src ./src
|
|||||||
COPY public ./public
|
COPY public ./public
|
||||||
COPY drizzle ./drizzle
|
COPY drizzle ./drizzle
|
||||||
|
|
||||||
RUN mkdir -p /home/perplexica/data
|
RUN mkdir -p /home/vane/data
|
||||||
RUN yarn build
|
RUN yarn build
|
||||||
|
|
||||||
FROM node:24.5.0-slim
|
FROM node:24.5.0-slim
|
||||||
@@ -24,15 +24,15 @@ RUN apt-get update && apt-get install -y \
|
|||||||
curl sudo \
|
curl sudo \
|
||||||
&& rm -rf /var/lib/apt/lists/*
|
&& rm -rf /var/lib/apt/lists/*
|
||||||
|
|
||||||
WORKDIR /home/perplexica
|
WORKDIR /home/vane
|
||||||
|
|
||||||
COPY --from=builder /home/perplexica/public ./public
|
COPY --from=builder /home/vane/public ./public
|
||||||
COPY --from=builder /home/perplexica/.next/static ./public/_next/static
|
COPY --from=builder /home/vane/.next/static ./public/_next/static
|
||||||
COPY --from=builder /home/perplexica/.next/standalone ./
|
COPY --from=builder /home/vane/.next/standalone ./
|
||||||
COPY --from=builder /home/perplexica/data ./data
|
COPY --from=builder /home/vane/data ./data
|
||||||
COPY drizzle ./drizzle
|
COPY drizzle ./drizzle
|
||||||
|
|
||||||
RUN mkdir /home/perplexica/uploads
|
RUN mkdir /home/vane/uploads
|
||||||
|
|
||||||
RUN useradd --shell /bin/bash --system \
|
RUN useradd --shell /bin/bash --system \
|
||||||
--home-dir "/usr/local/searxng" \
|
--home-dir "/usr/local/searxng" \
|
||||||
@@ -60,7 +60,7 @@ RUN cd "/usr/local/searxng/searxng-src" && \
|
|||||||
|
|
||||||
USER root
|
USER root
|
||||||
|
|
||||||
WORKDIR /home/perplexica
|
WORKDIR /home/vane
|
||||||
COPY entrypoint.sh ./entrypoint.sh
|
COPY entrypoint.sh ./entrypoint.sh
|
||||||
RUN chmod +x ./entrypoint.sh
|
RUN chmod +x ./entrypoint.sh
|
||||||
RUN sed -i 's/\r$//' ./entrypoint.sh || true
|
RUN sed -i 's/\r$//' ./entrypoint.sh || true
|
||||||
@@ -71,4 +71,4 @@ EXPOSE 3000 8080
|
|||||||
|
|
||||||
ENV SEARXNG_API_URL=http://localhost:8080
|
ENV SEARXNG_API_URL=http://localhost:8080
|
||||||
|
|
||||||
CMD ["/home/perplexica/entrypoint.sh"]
|
CMD ["/home/vane/entrypoint.sh"]
|
||||||
|
|||||||
@@ -2,7 +2,7 @@ FROM node:24.5.0-slim AS builder
|
|||||||
|
|
||||||
RUN apt-get update && apt-get install -y python3 python3-pip sqlite3 && rm -rf /var/lib/apt/lists/*
|
RUN apt-get update && apt-get install -y python3 python3-pip sqlite3 && rm -rf /var/lib/apt/lists/*
|
||||||
|
|
||||||
WORKDIR /home/perplexica
|
WORKDIR /home/vane
|
||||||
|
|
||||||
COPY package.json yarn.lock ./
|
COPY package.json yarn.lock ./
|
||||||
RUN yarn install --frozen-lockfile --network-timeout 600000
|
RUN yarn install --frozen-lockfile --network-timeout 600000
|
||||||
@@ -12,23 +12,23 @@ COPY src ./src
|
|||||||
COPY public ./public
|
COPY public ./public
|
||||||
COPY drizzle ./drizzle
|
COPY drizzle ./drizzle
|
||||||
|
|
||||||
RUN mkdir -p /home/perplexica/data
|
RUN mkdir -p /home/vane/data
|
||||||
RUN yarn build
|
RUN yarn build
|
||||||
|
|
||||||
FROM node:24.5.0-slim
|
FROM node:24.5.0-slim
|
||||||
|
|
||||||
RUN apt-get update && apt-get install -y python3 python3-pip sqlite3 && rm -rf /var/lib/apt/lists/*
|
RUN apt-get update && apt-get install -y python3 python3-pip sqlite3 && rm -rf /var/lib/apt/lists/*
|
||||||
|
|
||||||
WORKDIR /home/perplexica
|
WORKDIR /home/vane
|
||||||
|
|
||||||
COPY --from=builder /home/perplexica/public ./public
|
COPY --from=builder /home/vane/public ./public
|
||||||
COPY --from=builder /home/perplexica/.next/static ./public/_next/static
|
COPY --from=builder /home/vane/.next/static ./public/_next/static
|
||||||
|
|
||||||
COPY --from=builder /home/perplexica/.next/standalone ./
|
COPY --from=builder /home/vane/.next/standalone ./
|
||||||
COPY --from=builder /home/perplexica/data ./data
|
COPY --from=builder /home/vane/data ./data
|
||||||
COPY drizzle ./drizzle
|
COPY drizzle ./drizzle
|
||||||
|
|
||||||
RUN mkdir /home/perplexica/uploads
|
RUN mkdir /home/vane/uploads
|
||||||
|
|
||||||
EXPOSE 3000
|
EXPOSE 3000
|
||||||
|
|
||||||
|
|||||||
88
README.md
88
README.md
@@ -1,18 +1,18 @@
|
|||||||
# Perplexica 🔍
|
# Vane 🔍
|
||||||
|
|
||||||
[](https://github.com/ItzCrazyKns/Perplexica/stargazers)
|
[](https://github.com/ItzCrazyKns/Vane/stargazers)
|
||||||
[](https://github.com/ItzCrazyKns/Perplexica/network/members)
|
[](https://github.com/ItzCrazyKns/Vane/network/members)
|
||||||
[](https://github.com/ItzCrazyKns/Perplexica/watchers)
|
[](https://github.com/ItzCrazyKns/Vane/watchers)
|
||||||
[](https://hub.docker.com/r/itzcrazykns1337/perplexica)
|
[](https://hub.docker.com/r/itzcrazykns1337/vane)
|
||||||
[](https://github.com/ItzCrazyKns/Perplexica/blob/master/LICENSE)
|
[](https://github.com/ItzCrazyKns/Vane/blob/master/LICENSE)
|
||||||
[](https://github.com/ItzCrazyKns/Perplexica/commits/master)
|
[](https://github.com/ItzCrazyKns/Vane/commits/master)
|
||||||
[](https://discord.gg/26aArMy8tT)
|
[](https://discord.gg/26aArMy8tT)
|
||||||
|
|
||||||
Perplexica is a **privacy-focused AI answering engine** that runs entirely on your own hardware. It combines knowledge from the vast internet with support for **local LLMs** (Ollama) and cloud providers (OpenAI, Claude, Groq), delivering accurate answers with **cited sources** while keeping your searches completely private.
|
Vane is a **privacy-focused AI answering engine** that runs entirely on your own hardware. It combines knowledge from the vast internet with support for **local LLMs** (Ollama) and cloud providers (OpenAI, Claude, Groq), delivering accurate answers with **cited sources** while keeping your searches completely private.
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
Want to know more about its architecture and how it works? You can read it [here](https://github.com/ItzCrazyKns/Perplexica/tree/master/docs/architecture/README.md).
|
Want to know more about its architecture and how it works? You can read it [here](https://github.com/ItzCrazyKns/Vane/tree/master/docs/architecture/README.md).
|
||||||
|
|
||||||
## ✨ Features
|
## ✨ Features
|
||||||
|
|
||||||
@@ -28,7 +28,7 @@ Want to know more about its architecture and how it works? You can read it [here
|
|||||||
|
|
||||||
📷 **Image and video search** - Find visual content alongside text results. Search isn't limited to just articles anymore.
|
📷 **Image and video search** - Find visual content alongside text results. Search isn't limited to just articles anymore.
|
||||||
|
|
||||||
📄 **File uploads** - Upload documents and ask questions about them. PDFs, text files, images - Perplexica understands them all.
|
📄 **File uploads** - Upload documents and ask questions about them. PDFs, text files, images - Vane understands them all.
|
||||||
|
|
||||||
🌐 **Search specific domains** - Limit your search to specific websites when you know where to look. Perfect for technical documentation or research papers.
|
🌐 **Search specific domains** - Limit your search to specific websites when you know where to look. Perfect for technical documentation or research papers.
|
||||||
|
|
||||||
@@ -38,11 +38,11 @@ Want to know more about its architecture and how it works? You can read it [here
|
|||||||
|
|
||||||
🕒 **Search history** - Every search is saved locally so you can revisit your discoveries anytime. Your research is never lost.
|
🕒 **Search history** - Every search is saved locally so you can revisit your discoveries anytime. Your research is never lost.
|
||||||
|
|
||||||
✨ **More coming soon** - We're actively developing new features based on community feedback. Join our Discord to help shape Perplexica's future!
|
✨ **More coming soon** - We're actively developing new features based on community feedback. Join our Discord to help shape Vane's future!
|
||||||
|
|
||||||
## Sponsors
|
## Sponsors
|
||||||
|
|
||||||
Perplexica's development is powered by the generous support of our sponsors. Their contributions help keep this project free, open-source, and accessible to everyone.
|
Vane's development is powered by the generous support of our sponsors. Their contributions help keep this project free, open-source, and accessible to everyone.
|
||||||
|
|
||||||
<div align="center">
|
<div align="center">
|
||||||
|
|
||||||
@@ -51,7 +51,7 @@ Perplexica's development is powered by the generous support of our sponsors. The
|
|||||||
<img alt="Warp Terminal" src=".assets/sponsers/warp.png" width="100%">
|
<img alt="Warp Terminal" src=".assets/sponsers/warp.png" width="100%">
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
### **✨ [Try Warp - The AI-Powered Terminal →](https://www.warp.dev/perplexica)**
|
### **✨ [Try Warp - The AI-Powered Terminal →](https://www.warp.dev/vane)**
|
||||||
|
|
||||||
Warp is revolutionizing development workflows with AI-powered features, modern UX, and blazing-fast performance. Used by developers at top companies worldwide.
|
Warp is revolutionizing development workflows with AI-powered features, modern UX, and blazing-fast performance. Used by developers at top companies worldwide.
|
||||||
|
|
||||||
@@ -76,26 +76,26 @@ We'd also like to thank the following partners for their generous support:
|
|||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
There are mainly 2 ways of installing Perplexica - With Docker, Without Docker. Using Docker is highly recommended.
|
There are mainly 2 ways of installing Vane - With Docker, Without Docker. Using Docker is highly recommended.
|
||||||
|
|
||||||
### Getting Started with Docker (Recommended)
|
### Getting Started with Docker (Recommended)
|
||||||
|
|
||||||
Perplexica can be easily run using Docker. Simply run the following command:
|
Vane can be easily run using Docker. Simply run the following command:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
docker run -d -p 3000:3000 -v perplexica-data:/home/perplexica/data --name perplexica itzcrazykns1337/perplexica:latest
|
docker run -d -p 3000:3000 -v vane-data:/home/vane/data --name vane itzcrazykns1337/vane:latest
|
||||||
```
|
```
|
||||||
|
|
||||||
This will pull and start the Perplexica container with the bundled SearxNG search engine. Once running, open your browser and navigate to http://localhost:3000. You can then configure your settings (API keys, models, etc.) directly in the setup screen.
|
This will pull and start the Vane container with the bundled SearxNG search engine. Once running, open your browser and navigate to http://localhost:3000. You can then configure your settings (API keys, models, etc.) directly in the setup screen.
|
||||||
|
|
||||||
**Note**: The image includes both Perplexica and SearxNG, so no additional setup is required. The `-v` flags create persistent volumes for your data and uploaded files.
|
**Note**: The image includes both Vane and SearxNG, so no additional setup is required. The `-v` flags create persistent volumes for your data and uploaded files.
|
||||||
|
|
||||||
#### Using Perplexica with Your Own SearxNG Instance
|
#### Using Vane with Your Own SearxNG Instance
|
||||||
|
|
||||||
If you already have SearxNG running, you can use the slim version of Perplexica:
|
If you already have SearxNG running, you can use the slim version of Vane:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
docker run -d -p 3000:3000 -e SEARXNG_API_URL=http://your-searxng-url:8080 -v perplexica-data:/home/perplexica/data --name perplexica itzcrazykns1337/perplexica:slim-latest
|
docker run -d -p 3000:3000 -e SEARXNG_API_URL=http://your-searxng-url:8080 -v vane-data:/home/vane/data --name vane itzcrazykns1337/vane:slim-latest
|
||||||
```
|
```
|
||||||
|
|
||||||
**Important**: Make sure your SearxNG instance has:
|
**Important**: Make sure your SearxNG instance has:
|
||||||
@@ -110,10 +110,10 @@ Replace `http://your-searxng-url:8080` with your actual SearxNG URL. Then config
|
|||||||
If you prefer to build from source or need more control:
|
If you prefer to build from source or need more control:
|
||||||
|
|
||||||
1. Ensure Docker is installed and running on your system.
|
1. Ensure Docker is installed and running on your system.
|
||||||
2. Clone the Perplexica repository:
|
2. Clone the Vane repository:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
git clone https://github.com/ItzCrazyKns/Perplexica.git
|
git clone https://github.com/ItzCrazyKns/Vane.git
|
||||||
```
|
```
|
||||||
|
|
||||||
3. After cloning, navigate to the directory containing the project files.
|
3. After cloning, navigate to the directory containing the project files.
|
||||||
@@ -121,13 +121,13 @@ If you prefer to build from source or need more control:
|
|||||||
4. Build and run using Docker:
|
4. Build and run using Docker:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
docker build -t perplexica .
|
docker build -t vane .
|
||||||
docker run -d -p 3000:3000 -v perplexica-data:/home/perplexica/data --name perplexica perplexica
|
docker run -d -p 3000:3000 -v vane-data:/home/vane/data --name vane vane
|
||||||
```
|
```
|
||||||
|
|
||||||
5. Access Perplexica at http://localhost:3000 and configure your settings in the setup screen.
|
5. Access Vane at http://localhost:3000 and configure your settings in the setup screen.
|
||||||
|
|
||||||
**Note**: After the containers are built, you can start Perplexica directly from Docker without having to open a terminal.
|
**Note**: After the containers are built, you can start Vane directly from Docker without having to open a terminal.
|
||||||
|
|
||||||
### Non-Docker Installation
|
### Non-Docker Installation
|
||||||
|
|
||||||
@@ -135,8 +135,8 @@ If you prefer to build from source or need more control:
|
|||||||
2. Clone the repository:
|
2. Clone the repository:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
git clone https://github.com/ItzCrazyKns/Perplexica.git
|
git clone https://github.com/ItzCrazyKns/Vane.git
|
||||||
cd Perplexica
|
cd Vane
|
||||||
```
|
```
|
||||||
|
|
||||||
3. Install dependencies:
|
3. Install dependencies:
|
||||||
@@ -161,13 +161,13 @@ If you prefer to build from source or need more control:
|
|||||||
|
|
||||||
**Note**: Using Docker is recommended as it simplifies the setup process, especially for managing environment variables and dependencies.
|
**Note**: Using Docker is recommended as it simplifies the setup process, especially for managing environment variables and dependencies.
|
||||||
|
|
||||||
See the [installation documentation](https://github.com/ItzCrazyKns/Perplexica/tree/master/docs/installation) for more information like updating, etc.
|
See the [installation documentation](https://github.com/ItzCrazyKns/Vane/tree/master/docs/installation) for more information like updating, etc.
|
||||||
|
|
||||||
### Troubleshooting
|
### Troubleshooting
|
||||||
|
|
||||||
#### Local OpenAI-API-Compliant Servers
|
#### Local OpenAI-API-Compliant Servers
|
||||||
|
|
||||||
If Perplexica tells you that you haven't configured any chat model providers, ensure that:
|
If Vane tells you that you haven't configured any chat model providers, ensure that:
|
||||||
|
|
||||||
1. Your server is running on `0.0.0.0` (not `127.0.0.1`) and on the same port you put in the API URL.
|
1. Your server is running on `0.0.0.0` (not `127.0.0.1`) and on the same port you put in the API URL.
|
||||||
2. You have specified the correct model name loaded by your local LLM server.
|
2. You have specified the correct model name loaded by your local LLM server.
|
||||||
@@ -213,29 +213,29 @@ If you're encountering a Lemonade connection error, it is likely due to the back
|
|||||||
|
|
||||||
## Using as a Search Engine
|
## Using as a Search Engine
|
||||||
|
|
||||||
If you wish to use Perplexica as an alternative to traditional search engines like Google or Bing, or if you want to add a shortcut for quick access from your browser's search bar, follow these steps:
|
If you wish to use Vane as an alternative to traditional search engines like Google or Bing, or if you want to add a shortcut for quick access from your browser's search bar, follow these steps:
|
||||||
|
|
||||||
1. Open your browser's settings.
|
1. Open your browser's settings.
|
||||||
2. Navigate to the 'Search Engines' section.
|
2. Navigate to the 'Search Engines' section.
|
||||||
3. Add a new site search with the following URL: `http://localhost:3000/?q=%s`. Replace `localhost` with your IP address or domain name, and `3000` with the port number if Perplexica is not hosted locally.
|
3. Add a new site search with the following URL: `http://localhost:3000/?q=%s`. Replace `localhost` with your IP address or domain name, and `3000` with the port number if Vane is not hosted locally.
|
||||||
4. Click the add button. Now, you can use Perplexica directly from your browser's search bar.
|
4. Click the add button. Now, you can use Vane directly from your browser's search bar.
|
||||||
|
|
||||||
## Using Perplexica's API
|
## Using Vane's API
|
||||||
|
|
||||||
Perplexica also provides an API for developers looking to integrate its powerful search engine into their own applications. You can run searches, use multiple models and get answers to your queries.
|
Vane also provides an API for developers looking to integrate its powerful search engine into their own applications. You can run searches, use multiple models and get answers to your queries.
|
||||||
|
|
||||||
For more details, check out the full documentation [here](https://github.com/ItzCrazyKns/Perplexica/tree/master/docs/API/SEARCH.md).
|
For more details, check out the full documentation [here](https://github.com/ItzCrazyKns/Vane/tree/master/docs/API/SEARCH.md).
|
||||||
|
|
||||||
## Expose Perplexica to network
|
## Expose Vane to network
|
||||||
|
|
||||||
Perplexica runs on Next.js and handles all API requests. It works right away on the same network and stays accessible even with port forwarding.
|
Vane runs on Next.js and handles all API requests. It works right away on the same network and stays accessible even with port forwarding.
|
||||||
|
|
||||||
## One-Click Deployment
|
## One-Click Deployment
|
||||||
|
|
||||||
[](https://usw.sealos.io/?openapp=system-template%3FtemplateName%3Dperplexica)
|
[](https://usw.sealos.io/?openapp=system-template%3FtemplateName%3Dperplexica)
|
||||||
[](https://repocloud.io/details/?app_id=267)
|
[](https://repocloud.io/details/?app_id=267)
|
||||||
[](https://template.run.claw.cloud/?referralCode=U11MRQ8U9RM4&openapp=system-fastdeploy%3FtemplateName%3Dperplexica)
|
[](https://template.run.claw.cloud/?referralCode=U11MRQ8U9RM4&openapp=system-fastdeploy%3FtemplateName%3Dperplexica)
|
||||||
[](https://www.hostinger.com/vps/docker-hosting?compose_url=https://raw.githubusercontent.com/ItzCrazyKns/Perplexica/refs/heads/master/docker-compose.yaml)
|
[](https://www.hostinger.com/vps/docker-hosting?compose_url=https://raw.githubusercontent.com/ItzCrazyKns/Vane/refs/heads/master/docker-compose.yaml)
|
||||||
|
|
||||||
## Upcoming Features
|
## Upcoming Features
|
||||||
|
|
||||||
@@ -245,7 +245,7 @@ Perplexica runs on Next.js and handles all API requests. It works right away on
|
|||||||
|
|
||||||
## Support Us
|
## Support Us
|
||||||
|
|
||||||
If you find Perplexica useful, consider giving us a star on GitHub. This helps more people discover Perplexica and supports the development of new features. Your support is greatly appreciated.
|
If you find Vane useful, consider giving us a star on GitHub. This helps more people discover Vane and supports the development of new features. Your support is greatly appreciated.
|
||||||
|
|
||||||
### Donations
|
### Donations
|
||||||
|
|
||||||
@@ -257,10 +257,10 @@ We also accept donations to help sustain our project. If you would like to contr
|
|||||||
|
|
||||||
## Contribution
|
## Contribution
|
||||||
|
|
||||||
Perplexica is built on the idea that AI and large language models should be easy for everyone to use. If you find bugs or have ideas, please share them in via GitHub Issues. For more information on contributing to Perplexica you can read the [CONTRIBUTING.md](CONTRIBUTING.md) file to learn more about Perplexica and how you can contribute to it.
|
Vane is built on the idea that AI and large language models should be easy for everyone to use. If you find bugs or have ideas, please share them in via GitHub Issues. For more information on contributing to Vane you can read the [CONTRIBUTING.md](CONTRIBUTING.md) file to learn more about Vane and how you can contribute to it.
|
||||||
|
|
||||||
## Help and Support
|
## Help and Support
|
||||||
|
|
||||||
If you have any questions or feedback, please feel free to reach out to us. You can create an issue on GitHub or join our Discord server. There, you can connect with other users, share your experiences and reviews, and receive more personalized help. [Click here](https://discord.gg/EFwsmQDgAu) to join the Discord server. To discuss matters outside of regular support, feel free to contact me on Discord at `itzcrazykns`.
|
If you have any questions or feedback, please feel free to reach out to us. You can create an issue on GitHub or join our Discord server. There, you can connect with other users, share your experiences and reviews, and receive more personalized help. [Click here](https://discord.gg/EFwsmQDgAu) to join the Discord server. To discuss matters outside of regular support, feel free to contact me on Discord at `itzcrazykns`.
|
||||||
|
|
||||||
Thank you for exploring Perplexica, the AI-powered search engine designed to enhance your search experience. We are constantly working to improve Perplexica and expand its capabilities. We value your feedback and contributions which help us make Perplexica even better. Don't forget to check back for updates and new features!
|
Thank you for exploring Vane, the AI-powered search engine designed to enhance your search experience. We are constantly working to improve Vane and expand its capabilities. We value your feedback and contributions which help us make Vane even better. Don't forget to check back for updates and new features!
|
||||||
|
|||||||
@@ -1,14 +1,14 @@
|
|||||||
services:
|
services:
|
||||||
perplexica:
|
vane:
|
||||||
image: itzcrazykns1337/perplexica:latest
|
image: itzcrazykns1337/vane:latest
|
||||||
build:
|
build:
|
||||||
context: .
|
context: .
|
||||||
ports:
|
ports:
|
||||||
- '3000:3000'
|
- '3000:3000'
|
||||||
volumes:
|
volumes:
|
||||||
- data:/home/perplexica/data
|
- data:/home/vane/data
|
||||||
restart: unless-stopped
|
restart: unless-stopped
|
||||||
|
|
||||||
volumes:
|
volumes:
|
||||||
data:
|
data:
|
||||||
name: 'perplexica-data'
|
name: 'vane-data'
|
||||||
|
|||||||
@@ -1,8 +1,8 @@
|
|||||||
# Perplexica Search API Documentation
|
# Vane Search API Documentation
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
|
|
||||||
Perplexica’s Search API makes it easy to use our AI-powered search engine. You can run different types of searches, pick the models you want to use, and get the most recent info. Follow the following headings to learn more about Perplexica's search API.
|
Vane's Search API makes it easy to use our AI-powered search engine. You can run different types of searches, pick the models you want to use, and get the most recent info. Follow the following headings to learn more about Vane's search API.
|
||||||
|
|
||||||
## Endpoints
|
## Endpoints
|
||||||
|
|
||||||
@@ -53,7 +53,7 @@ Use the `id` field as the `providerId` and the `key` field from the models array
|
|||||||
|
|
||||||
**Full URL**: `http://localhost:3000/api/search`
|
**Full URL**: `http://localhost:3000/api/search`
|
||||||
|
|
||||||
**Note**: Replace `localhost:3000` with your Perplexica instance URL if running on a different host or port
|
**Note**: Replace `localhost:3000` with your Vane instance URL if running on a different host or port
|
||||||
|
|
||||||
### Request
|
### Request
|
||||||
|
|
||||||
@@ -73,12 +73,12 @@ The API accepts a JSON object in the request body, where you define the enabled
|
|||||||
},
|
},
|
||||||
"optimizationMode": "speed",
|
"optimizationMode": "speed",
|
||||||
"sources": ["web"],
|
"sources": ["web"],
|
||||||
"query": "What is Perplexica",
|
"query": "What is Vane",
|
||||||
"history": [
|
"history": [
|
||||||
["human", "Hi, how are you?"],
|
["human", "Hi, how are you?"],
|
||||||
["assistant", "I am doing well, how can I help you today?"]
|
["assistant", "I am doing well, how can I help you today?"]
|
||||||
],
|
],
|
||||||
"systemInstructions": "Focus on providing technical details about Perplexica's architecture.",
|
"systemInstructions": "Focus on providing technical details about Vane's architecture.",
|
||||||
"stream": false
|
"stream": false
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
@@ -115,8 +115,8 @@ The API accepts a JSON object in the request body, where you define the enabled
|
|||||||
|
|
||||||
```json
|
```json
|
||||||
[
|
[
|
||||||
["human", "What is Perplexica?"],
|
["human", "What is Vane?"],
|
||||||
["assistant", "Perplexica is an AI-powered search engine..."]
|
["assistant", "Vane is an AI-powered search engine..."]
|
||||||
]
|
]
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -130,20 +130,20 @@ The response from the API includes both the final message and the sources used t
|
|||||||
|
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
"message": "Perplexica is an innovative, open-source AI-powered search engine designed to enhance the way users search for information online. Here are some key features and characteristics of Perplexica:\n\n- **AI-Powered Technology**: It utilizes advanced machine learning algorithms to not only retrieve information but also to understand the context and intent behind user queries, providing more relevant results [1][5].\n\n- **Open-Source**: Being open-source, Perplexica offers flexibility and transparency, allowing users to explore its functionalities without the constraints of proprietary software [3][10].",
|
"message": "Vane is an innovative, open-source AI-powered search engine designed to enhance the way users search for information online. Here are some key features and characteristics of Vane:\n\n- **AI-Powered Technology**: It utilizes advanced machine learning algorithms to not only retrieve information but also to understand the context and intent behind user queries, providing more relevant results [1][5].\n\n- **Open-Source**: Being open-source, Vane offers flexibility and transparency, allowing users to explore its functionalities without the constraints of proprietary software [3][10].",
|
||||||
"sources": [
|
"sources": [
|
||||||
{
|
{
|
||||||
"content": "Perplexica is an innovative, open-source AI-powered search engine designed to enhance the way users search for information online.",
|
"content": "Vane is an innovative, open-source AI-powered search engine designed to enhance the way users search for information online.",
|
||||||
"metadata": {
|
"metadata": {
|
||||||
"title": "What is Perplexica, and how does it function as an AI-powered search ...",
|
"title": "What is Vane, and how does it function as an AI-powered search ...",
|
||||||
"url": "https://askai.glarity.app/search/What-is-Perplexica--and-how-does-it-function-as-an-AI-powered-search-engine"
|
"url": "https://askai.glarity.app/search/What-is-Vane--and-how-does-it-function-as-an-AI-powered-search-engine"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"content": "Perplexica is an open-source AI-powered search tool that dives deep into the internet to find precise answers.",
|
"content": "Vane is an open-source AI-powered search tool that dives deep into the internet to find precise answers.",
|
||||||
"metadata": {
|
"metadata": {
|
||||||
"title": "Sahar Mor's Post",
|
"title": "Sahar Mor's Post",
|
||||||
"url": "https://www.linkedin.com/posts/sahar-mor_a-new-open-source-project-called-perplexica-activity-7204489745668694016-ncja"
|
"url": "https://www.linkedin.com/posts/sahar-mor_a-new-open-source-project-called-vane-activity-7204489745668694016-ncja"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
....
|
....
|
||||||
@@ -160,7 +160,7 @@ Example of streamed response objects:
|
|||||||
```
|
```
|
||||||
{"type":"init","data":"Stream connected"}
|
{"type":"init","data":"Stream connected"}
|
||||||
{"type":"sources","data":[{"content":"...","metadata":{"title":"...","url":"..."}},...]}
|
{"type":"sources","data":[{"content":"...","metadata":{"title":"...","url":"..."}},...]}
|
||||||
{"type":"response","data":"Perplexica is an "}
|
{"type":"response","data":"Vane is an "}
|
||||||
{"type":"response","data":"innovative, open-source "}
|
{"type":"response","data":"innovative, open-source "}
|
||||||
{"type":"response","data":"AI-powered search engine..."}
|
{"type":"response","data":"AI-powered search engine..."}
|
||||||
{"type":"done"}
|
{"type":"done"}
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
# Perplexica Architecture
|
# Vane Architecture
|
||||||
|
|
||||||
Perplexica is a Next.js application that combines an AI chat experience with search.
|
Vane is a Next.js application that combines an AI chat experience with search.
|
||||||
|
|
||||||
For a high level flow, see [WORKING.md](WORKING.md). For deeper implementation details, see [CONTRIBUTING.md](../../CONTRIBUTING.md).
|
For a high level flow, see [WORKING.md](WORKING.md). For deeper implementation details, see [CONTRIBUTING.md](../../CONTRIBUTING.md).
|
||||||
|
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
# How Perplexica Works
|
# How Vane Works
|
||||||
|
|
||||||
This is a high level overview of how Perplexica answers a question.
|
This is a high level overview of how Vane answers a question.
|
||||||
|
|
||||||
If you want a component level overview, see [README.md](README.md).
|
If you want a component level overview, see [README.md](README.md).
|
||||||
|
|
||||||
@@ -58,7 +58,7 @@ We prompt the model to cite the references it used. The UI then renders those ci
|
|||||||
|
|
||||||
## Search API
|
## Search API
|
||||||
|
|
||||||
If you are integrating Perplexica into another product, you can call `POST /api/search`.
|
If you are integrating Vane into another product, you can call `POST /api/search`.
|
||||||
|
|
||||||
It returns:
|
It returns:
|
||||||
|
|
||||||
|
|||||||
@@ -1,60 +1,60 @@
|
|||||||
# Update Perplexica to the latest version
|
# Update Vane to the latest version
|
||||||
|
|
||||||
To update Perplexica to the latest version, follow these steps:
|
To update Vane to the latest version, follow these steps:
|
||||||
|
|
||||||
## For Docker users (Using pre-built images)
|
## For Docker users (Using pre-built images)
|
||||||
|
|
||||||
Simply pull the latest image and restart your container:
|
Simply pull the latest image and restart your container:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
docker pull itzcrazykns1337/perplexica:latest
|
docker pull itzcrazykns1337/vane:latest
|
||||||
docker stop perplexica
|
docker stop vane
|
||||||
docker rm perplexica
|
docker rm vane
|
||||||
docker run -d -p 3000:3000 -v perplexica-data:/home/perplexica/data --name perplexica itzcrazykns1337/perplexica:latest
|
docker run -d -p 3000:3000 -v vane-data:/home/vane/data --name vane itzcrazykns1337/vane:latest
|
||||||
```
|
```
|
||||||
|
|
||||||
For slim version:
|
For slim version:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
docker pull itzcrazykns1337/perplexica:slim-latest
|
docker pull itzcrazykns1337/vane:slim-latest
|
||||||
docker stop perplexica
|
docker stop vane
|
||||||
docker rm perplexica
|
docker rm vane
|
||||||
docker run -d -p 3000:3000 -e SEARXNG_API_URL=http://your-searxng-url:8080 -v perplexica-data:/home/perplexica/data --name perplexica itzcrazykns1337/perplexica:slim-latest
|
docker run -d -p 3000:3000 -e SEARXNG_API_URL=http://your-searxng-url:8080 -v vane-data:/home/vane/data --name vane itzcrazykns1337/vane:slim-latest
|
||||||
```
|
```
|
||||||
|
|
||||||
Once updated, go to http://localhost:3000 and verify the latest changes. Your settings are preserved automatically.
|
Once updated, go to http://localhost:3000 and verify the latest changes. Your settings are preserved automatically.
|
||||||
|
|
||||||
## For Docker users (Building from source)
|
## For Docker users (Building from source)
|
||||||
|
|
||||||
1. Navigate to your Perplexica directory and pull the latest changes:
|
1. Navigate to your Vane directory and pull the latest changes:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
cd Perplexica
|
cd Vane
|
||||||
git pull origin master
|
git pull origin master
|
||||||
```
|
```
|
||||||
|
|
||||||
2. Rebuild the Docker image:
|
2. Rebuild the Docker image:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
docker build -t perplexica .
|
docker build -t vane .
|
||||||
```
|
```
|
||||||
|
|
||||||
3. Stop and remove the old container, then start the new one:
|
3. Stop and remove the old container, then start the new one:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
docker stop perplexica
|
docker stop vane
|
||||||
docker rm perplexica
|
docker rm vane
|
||||||
docker run -p 3000:3000 -p 8080:8080 --name perplexica perplexica
|
docker run -p 3000:3000 -p 8080:8080 --name vane vane
|
||||||
```
|
```
|
||||||
|
|
||||||
4. Once the command completes, go to http://localhost:3000 and verify the latest changes.
|
4. Once the command completes, go to http://localhost:3000 and verify the latest changes.
|
||||||
|
|
||||||
## For non-Docker users
|
## For non-Docker users
|
||||||
|
|
||||||
1. Navigate to your Perplexica directory and pull the latest changes:
|
1. Navigate to your Vane directory and pull the latest changes:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
cd Perplexica
|
cd Vane
|
||||||
git pull origin master
|
git pull origin master
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|||||||
@@ -26,7 +26,7 @@ else
|
|||||||
echo "SearXNG may not be fully ready, but continuing (PID: $SEARXNG_PID)"
|
echo "SearXNG may not be fully ready, but continuing (PID: $SEARXNG_PID)"
|
||||||
fi
|
fi
|
||||||
|
|
||||||
cd /home/perplexica
|
cd /home/vane
|
||||||
echo "Starting Perplexica..."
|
echo "Starting Vane..."
|
||||||
|
|
||||||
exec node server.js
|
exec node server.js
|
||||||
@@ -1,5 +1,5 @@
|
|||||||
{
|
{
|
||||||
"name": "perplexica",
|
"name": "vane",
|
||||||
"version": "1.12.1",
|
"version": "1.12.1",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"author": "ItzCrazyKns",
|
"author": "ItzCrazyKns",
|
||||||
|
|||||||
@@ -19,9 +19,8 @@ const montserrat = Montserrat({
|
|||||||
});
|
});
|
||||||
|
|
||||||
export const metadata: Metadata = {
|
export const metadata: Metadata = {
|
||||||
title: 'Perplexica - Chat with the internet',
|
title: 'Vane - Direct your curiosity',
|
||||||
description:
|
description: 'Vane is an AI powered answering engine.',
|
||||||
'Perplexica is an AI powered chatbot that is connected to the internet.',
|
|
||||||
};
|
};
|
||||||
|
|
||||||
export default function RootLayout({
|
export default function RootLayout({
|
||||||
|
|||||||
@@ -2,7 +2,7 @@ import { Metadata } from 'next';
|
|||||||
import React from 'react';
|
import React from 'react';
|
||||||
|
|
||||||
export const metadata: Metadata = {
|
export const metadata: Metadata = {
|
||||||
title: 'Library - Perplexica',
|
title: 'Library - Vane',
|
||||||
};
|
};
|
||||||
|
|
||||||
const Layout = ({ children }: { children: React.ReactNode }) => {
|
const Layout = ({ children }: { children: React.ReactNode }) => {
|
||||||
|
|||||||
@@ -2,10 +2,9 @@ import type { MetadataRoute } from 'next';
|
|||||||
|
|
||||||
export default function manifest(): MetadataRoute.Manifest {
|
export default function manifest(): MetadataRoute.Manifest {
|
||||||
return {
|
return {
|
||||||
name: 'Perplexica - Chat with the internet',
|
name: 'Vane - Direct Your Curiosity',
|
||||||
short_name: 'Perplexica',
|
short_name: 'Vane',
|
||||||
description:
|
description: 'Vane is an AI powered answering engine.',
|
||||||
'Perplexica is an AI powered chatbot that is connected to the internet.',
|
|
||||||
start_url: '/',
|
start_url: '/',
|
||||||
display: 'standalone',
|
display: 'standalone',
|
||||||
background_color: '#0a0a0a',
|
background_color: '#0a0a0a',
|
||||||
|
|||||||
@@ -2,8 +2,8 @@ import ChatWindow from '@/components/ChatWindow';
|
|||||||
import { Metadata } from 'next';
|
import { Metadata } from 'next';
|
||||||
|
|
||||||
export const metadata: Metadata = {
|
export const metadata: Metadata = {
|
||||||
title: 'Chat - Perplexica',
|
title: 'Chat - Vane',
|
||||||
description: 'Chat with the internet, chat with Perplexica.',
|
description: 'Chat with the internet, chat with Vane.',
|
||||||
};
|
};
|
||||||
|
|
||||||
const Home = () => {
|
const Home = () => {
|
||||||
|
|||||||
@@ -49,7 +49,7 @@ const Chat = () => {
|
|||||||
};
|
};
|
||||||
|
|
||||||
if (messages.length === 1) {
|
if (messages.length === 1) {
|
||||||
document.title = `${messages[0].query.substring(0, 30)} - Perplexica`;
|
document.title = `${messages[0].query.substring(0, 30)} - Vane`;
|
||||||
}
|
}
|
||||||
|
|
||||||
if (sections.length > lastScrolledRef.current) {
|
if (sections.length > lastScrolledRef.current) {
|
||||||
|
|||||||
@@ -154,7 +154,7 @@ const SettingsDialogue = ({
|
|||||||
Version: {process.env.NEXT_PUBLIC_VERSION}
|
Version: {process.env.NEXT_PUBLIC_VERSION}
|
||||||
</p>
|
</p>
|
||||||
<a
|
<a
|
||||||
href="https://github.com/itzcrazykns/perplexica"
|
href="https://github.com/itzcrazykns/vane"
|
||||||
target="_blank"
|
target="_blank"
|
||||||
rel="noopener noreferrer"
|
rel="noopener noreferrer"
|
||||||
className="text-xs text-black/70 dark:text-white/70 flex flex-row space-x-1 items-center transition duration-200 hover:text-black/90 hover:dark:text-white/90"
|
className="text-xs text-black/70 dark:text-white/70 flex flex-row space-x-1 items-center transition duration-200 hover:text-black/90 hover:dark:text-white/90"
|
||||||
|
|||||||
@@ -48,7 +48,7 @@ const SetupWizard = ({
|
|||||||
>
|
>
|
||||||
Welcome to{' '}
|
Welcome to{' '}
|
||||||
<span className="text-[#24A0ED] italic font-['PP_Editorial']">
|
<span className="text-[#24A0ED] italic font-['PP_Editorial']">
|
||||||
Perplexica
|
Vane
|
||||||
</span>
|
</span>
|
||||||
</motion.h2>
|
</motion.h2>
|
||||||
<motion.p
|
<motion.p
|
||||||
@@ -93,7 +93,7 @@ const SetupWizard = ({
|
|||||||
>
|
>
|
||||||
Let us get{' '}
|
Let us get{' '}
|
||||||
<span className="text-[#24A0ED] italic font-['PP_Editorial']">
|
<span className="text-[#24A0ED] italic font-['PP_Editorial']">
|
||||||
Perplexica
|
Vane
|
||||||
</span>{' '}
|
</span>{' '}
|
||||||
set up for you
|
set up for you
|
||||||
</motion.p>
|
</motion.p>
|
||||||
|
|||||||
@@ -90,7 +90,7 @@ const weatherWidget: Widget = {
|
|||||||
|
|
||||||
const locationRes = await fetch(openStreetMapUrl, {
|
const locationRes = await fetch(openStreetMapUrl, {
|
||||||
headers: {
|
headers: {
|
||||||
'User-Agent': 'Perplexica',
|
'User-Agent': 'Vane',
|
||||||
'Content-Type': 'application/json',
|
'Content-Type': 'application/json',
|
||||||
},
|
},
|
||||||
});
|
});
|
||||||
@@ -109,7 +109,7 @@ const weatherWidget: Widget = {
|
|||||||
`https://api.open-meteo.com/v1/forecast?latitude=${location.lat}&longitude=${location.lon}¤t=temperature_2m,relative_humidity_2m,apparent_temperature,is_day,precipitation,rain,showers,snowfall,weather_code,cloud_cover,pressure_msl,surface_pressure,wind_speed_10m,wind_direction_10m,wind_gusts_10m&hourly=temperature_2m,precipitation_probability,precipitation,weather_code&daily=weather_code,temperature_2m_max,temperature_2m_min,precipitation_sum,precipitation_probability_max&timezone=auto&forecast_days=7`,
|
`https://api.open-meteo.com/v1/forecast?latitude=${location.lat}&longitude=${location.lon}¤t=temperature_2m,relative_humidity_2m,apparent_temperature,is_day,precipitation,rain,showers,snowfall,weather_code,cloud_cover,pressure_msl,surface_pressure,wind_speed_10m,wind_direction_10m,wind_gusts_10m&hourly=temperature_2m,precipitation_probability,precipitation,weather_code&daily=weather_code,temperature_2m_max,temperature_2m_min,precipitation_sum,precipitation_probability_max&timezone=auto&forecast_days=7`,
|
||||||
{
|
{
|
||||||
headers: {
|
headers: {
|
||||||
'User-Agent': 'Perplexica',
|
'User-Agent': 'Vane',
|
||||||
'Content-Type': 'application/json',
|
'Content-Type': 'application/json',
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
@@ -143,7 +143,7 @@ const weatherWidget: Widget = {
|
|||||||
`https://api.open-meteo.com/v1/forecast?latitude=${params.lat}&longitude=${params.lon}¤t=temperature_2m,relative_humidity_2m,apparent_temperature,is_day,precipitation,rain,showers,snowfall,weather_code,cloud_cover,pressure_msl,surface_pressure,wind_speed_10m,wind_direction_10m,wind_gusts_10m&hourly=temperature_2m,precipitation_probability,precipitation,weather_code&daily=weather_code,temperature_2m_max,temperature_2m_min,precipitation_sum,precipitation_probability_max&timezone=auto&forecast_days=7`,
|
`https://api.open-meteo.com/v1/forecast?latitude=${params.lat}&longitude=${params.lon}¤t=temperature_2m,relative_humidity_2m,apparent_temperature,is_day,precipitation,rain,showers,snowfall,weather_code,cloud_cover,pressure_msl,surface_pressure,wind_speed_10m,wind_direction_10m,wind_gusts_10m&hourly=temperature_2m,precipitation_probability,precipitation,weather_code&daily=weather_code,temperature_2m_max,temperature_2m_min,precipitation_sum,precipitation_probability_max&timezone=auto&forecast_days=7`,
|
||||||
{
|
{
|
||||||
headers: {
|
headers: {
|
||||||
'User-Agent': 'Perplexica',
|
'User-Agent': 'Vane',
|
||||||
'Content-Type': 'application/json',
|
'Content-Type': 'application/json',
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
@@ -152,7 +152,7 @@ const weatherWidget: Widget = {
|
|||||||
`https://nominatim.openstreetmap.org/reverse?lat=${params.lat}&lon=${params.lon}&format=json`,
|
`https://nominatim.openstreetmap.org/reverse?lat=${params.lat}&lon=${params.lon}&format=json`,
|
||||||
{
|
{
|
||||||
headers: {
|
headers: {
|
||||||
'User-Agent': 'Perplexica',
|
'User-Agent': 'Vane',
|
||||||
'Content-Type': 'application/json',
|
'Content-Type': 'application/json',
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ export const getWriterPrompt = (
|
|||||||
mode: 'speed' | 'balanced' | 'quality',
|
mode: 'speed' | 'balanced' | 'quality',
|
||||||
) => {
|
) => {
|
||||||
return `
|
return `
|
||||||
You are Perplexica, an AI model skilled in web search and crafting detailed, engaging, and well-structured answers. You excel at summarizing web pages and extracting relevant information to create professional, blog-style responses.
|
You are Vane, an AI model skilled in web search and crafting detailed, engaging, and well-structured answers. You excel at summarizing web pages and extracting relevant information to create professional, blog-style responses.
|
||||||
|
|
||||||
Your task is to provide answers that are:
|
Your task is to provide answers that are:
|
||||||
- **Informative and relevant**: Thoroughly address the user's query using the given context.
|
- **Informative and relevant**: Thoroughly address the user's query using the given context.
|
||||||
|
|||||||
Reference in New Issue
Block a user