Upload 16 files

.dockerignore

@@ -0,0 +1,11 @@
+.*
+**/__pycache__/
+*.egg-info/
+documentation/
+tests/
+build/
+dist/
+scripts/
+src/interface/
+src/telemetry/
+!src/interface/web

.gitattributes

@@ -1,35 +1,2 @@
-*.7z filter=lfs diff=lfs merge=lfs -text
-*.arrow filter=lfs diff=lfs merge=lfs -text
-*.bin filter=lfs diff=lfs merge=lfs -text
-*.bz2 filter=lfs diff=lfs merge=lfs -text
-*.ckpt filter=lfs diff=lfs merge=lfs -text
-*.ftz filter=lfs diff=lfs merge=lfs -text
-*.gz filter=lfs diff=lfs merge=lfs -text
-*.h5 filter=lfs diff=lfs merge=lfs -text
-*.joblib filter=lfs diff=lfs merge=lfs -text
-*.lfs.* filter=lfs diff=lfs merge=lfs -text
-*.mlmodel filter=lfs diff=lfs merge=lfs -text
-*.model filter=lfs diff=lfs merge=lfs -text
-*.msgpack filter=lfs diff=lfs merge=lfs -text
-*.npy filter=lfs diff=lfs merge=lfs -text
-*.npz filter=lfs diff=lfs merge=lfs -text
-*.onnx filter=lfs diff=lfs merge=lfs -text
-*.ot filter=lfs diff=lfs merge=lfs -text
-*.parquet filter=lfs diff=lfs merge=lfs -text
-*.pb filter=lfs diff=lfs merge=lfs -text
-*.pickle filter=lfs diff=lfs merge=lfs -text
-*.pkl filter=lfs diff=lfs merge=lfs -text
-*.pt filter=lfs diff=lfs merge=lfs -text
-*.pth filter=lfs diff=lfs merge=lfs -text
-*.rar filter=lfs diff=lfs merge=lfs -text
-*.safetensors filter=lfs diff=lfs merge=lfs -text
-saved_model/**/* filter=lfs diff=lfs merge=lfs -text
-*.tar.* filter=lfs diff=lfs merge=lfs -text
-*.tar filter=lfs diff=lfs merge=lfs -text
-*.tflite filter=lfs diff=lfs merge=lfs -text
-*.tgz filter=lfs diff=lfs merge=lfs -text
-*.wasm filter=lfs diff=lfs merge=lfs -text
-*.xz filter=lfs diff=lfs merge=lfs -text
-*.zip filter=lfs diff=lfs merge=lfs -text
-*.zst filter=lfs diff=lfs merge=lfs -text
-*tfevents* filter=lfs diff=lfs merge=lfs -text
+# Exclude tests data file from programming stats on Github
+tests/data/** linguist-vendored

.gitignore

@@ -0,0 +1,58 @@
+# Epoch Search artifacts
+*.gz
+*.pt
+tests/data/models
+tests/data/embeddings
+tests/evals/**.txt
+tests/evals/**.csv
+pgserver_data/
+
+# External app artifacts
+__pycache__
+.DS_Store
+.emacs.desktop*
+*.py[cod]
+.vscode
+.env
+.venv/*
+.obsidian
+todesktop.json
+
+# Build artifacts
+/src/khoj/interface/web/images
+/src/khoj/interface/built/
+/src/khoj/interface/compiled/404.html
+/build/
+/dist/
+khoj_assistant.egg-info
+/config/khoj*.yml
+.pytest_cache
+*.log
+/src/khoj/static
+
+# Obsidian plugin artifacts
+# ---
+# npm
+node_modules
+
+# Don't include the compiled obsidian main.js file in the repo.
+# They should be uploaded to GitHub releases instead.
+src/interface/obsidian/main.js
+
+# Exclude sourcemaps
+*.map
+# IntelliJ
+.idea
+
+# obsidian
+data.json
+
+# Android
+src/interface/android/.gradle
+src/interface/android/app/build
+src/interface/android/build
+src/interface/android/*.aab
+src/interface/android/*.apk
+src/interface/android/*.apk.idsig
+src/interface/android/*.keystore
+src/interface/android/local.properties

.pre-commit-config.yaml

@@ -0,0 +1,30 @@
+repos:
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  rev: v0.12.3
+  hooks:
+    - id: ruff-check
+      args: [ --fix ]
+      files: \.py$
+    - id: ruff-format
+      files: \.py$
+
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v4.4.0
+  hooks:
+  - id: end-of-file-fixer
+  - id: trailing-whitespace
+    # Exclude elisp files to not clear page breaks
+    exclude: \.el$
+  - id: check-json
+    exclude: (devcontainer\.json|launch\.json|settings\.json)$
+  - id: check-toml
+  - id: check-yaml
+
+- repo: https://github.com/pre-commit/mirrors-mypy
+  rev: v1.0.0
+  hooks:
+    - id: mypy
+      stages: [pre-push, manual]
+      pass_filenames: false
+      args:
+      - --config-file=pyproject.toml

Dockerfile

@@ -0,0 +1,64 @@
+# syntax=docker/dockerfile:1
+FROM ubuntu:jammy AS base
+LABEL homepage="https://khoj.dev"
+LABEL repository="https://github.com/khoj-ai/khoj"
+LABEL org.opencontainers.image.source="https://github.com/khoj-ai/khoj"
+LABEL org.opencontainers.image.description="Your second brain, containerized for personal, local deployment."
+
+# Install System Dependencies
+RUN apt update -y && apt -y install \
+    python3-pip \
+    swig \
+    curl \
+    # Required by RapidOCR
+    libgl1 \
+    libglx-mesa0 \
+    libglib2.0-0 \
+    docker.io \
+    # Required by llama-cpp-python pre-built wheels. See #1628
+    musl-dev && \
+    ln -s /usr/lib/x86_64-linux-musl/libc.so /lib/libc.musl-x86_64.so.1 && \
+    # Clean up
+    apt clean && rm -rf /var/lib/apt/lists/*
+
+# Build Server
+FROM base AS server-deps
+WORKDIR /app
+COPY pyproject.toml .
+COPY README.md .
+ARG VERSION=0.0.0
+# use the pre-built llama-cpp-python, torch cpu wheel
+ENV PIP_EXTRA_INDEX_URL="https://download.pytorch.org/whl/cpu https://abetlen.github.io/llama-cpp-python/whl/cpu"
+# avoid downloading unused cuda specific python packages
+ENV CUDA_VISIBLE_DEVICES=""
+RUN sed -i "s/dynamic = \\[\"version\"\\]/version = \"$VERSION\"/" pyproject.toml && \
+    pip install --no-cache-dir .
+
+# Build Web App
+FROM oven/bun:1-alpine AS web-app
+# Set build optimization env vars
+ENV NODE_ENV=production
+ENV NEXT_TELEMETRY_DISABLED=1
+WORKDIR /app/src/interface/web
+# Install dependencies first (cache layer)
+COPY src/interface/web/package.json src/interface/web/bun.lock ./
+RUN bun install --frozen-lockfile
+# Copy source and build
+COPY src/interface/web/. ./
+RUN bun run build
+
+# Merge the Server and Web App into a Single Image
+FROM base
+ENV PYTHONPATH=/app/src
+WORKDIR /app
+COPY --from=server-deps /usr/local/lib/python3.10/dist-packages /usr/local/lib/python3.10/dist-packages
+COPY --from=web-app /app/src/interface/web/out ./src/khoj/interface/built
+COPY . .
+RUN cd src && python3 khoj/manage.py collectstatic --noinput
+
+# Run the Application
+# There are more arguments required for the application to run,
+# but those should be passed in through the docker-compose.yml file.
+ARG PORT=42110
+EXPOSE ${PORT}
+ENTRYPOINT ["python3", "src/khoj/main.py"]

LICENSE

@@ -0,0 +1,661 @@
+                    GNU AFFERO GENERAL PUBLIC LICENSE
+                       Version 3, 19 November 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+                            Preamble
+
+  The GNU Affero General Public License is a free, copyleft license for
+software and other kinds of works, specifically designed to ensure
+cooperation with the community in the case of network server software.
+
+  The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works.  By contrast,
+our General Public Licenses are intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+  Developers that use our General Public Licenses protect your rights
+with two steps: (1) assert copyright on the software, and (2) offer
+you this License which gives you legal permission to copy, distribute
+and/or modify the software.
+
+  A secondary benefit of defending all users' freedom is that
+improvements made in alternate versions of the program, if they
+receive widespread use, become available for other developers to
+incorporate.  Many developers of free software are heartened and
+encouraged by the resulting cooperation.  However, in the case of
+software used on network servers, this result may fail to come about.
+The GNU General Public License permits making a modified version and
+letting the public access it on a server without ever releasing its
+source code to the public.
+
+  The GNU Affero General Public License is designed specifically to
+ensure that, in such cases, the modified source code becomes available
+to the community.  It requires the operator of a network server to
+provide the source code of the modified version running there to the
+users of that server.  Therefore, public use of a modified version, on
+a publicly accessible server, gives the public access to the source
+code of the modified version.
+
+  An older license, called the Affero General Public License and
+published by Affero, was designed to accomplish similar goals.  This is
+a different license, not a version of the Affero GPL, but Affero has
+released a new version of the Affero GPL which permits relicensing under
+this license.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                       TERMS AND CONDITIONS
+
+  0. Definitions.
+
+  "This License" refers to version 3 of the GNU Affero General Public License.
+
+  "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+  "The Program" refers to any copyrightable work licensed under this
+License.  Each licensee is addressed as "you".  "Licensees" and
+"recipients" may be individuals or organizations.
+
+  To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy.  The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+  A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+  To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy.  Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+  To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies.  Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+  An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License.  If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+  1. Source Code.
+
+  The "source code" for a work means the preferred form of the work
+for making modifications to it.  "Object code" means any non-source
+form of a work.
+
+  A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+  The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form.  A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+  The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities.  However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work.  For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+  The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+  The Corresponding Source for a work in source code form is that
+same work.
+
+  2. Basic Permissions.
+
+  All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met.  This License explicitly affirms your unlimited
+permission to run the unmodified Program.  The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work.  This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+  You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force.  You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright.  Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+  Conveying under any other circumstances is permitted solely under
+the conditions stated below.  Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+  3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+  No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+  When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+  4. Conveying Verbatim Copies.
+
+  You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+  You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+  5. Conveying Modified Source Versions.
+
+  You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+    a) The work must carry prominent notices stating that you modified
+    it, and giving a relevant date.
+
+    b) The work must carry prominent notices stating that it is
+    released under this License and any conditions added under section
+    7.  This requirement modifies the requirement in section 4 to
+    "keep intact all notices".
+
+    c) You must license the entire work, as a whole, under this
+    License to anyone who comes into possession of a copy.  This
+    License will therefore apply, along with any applicable section 7
+    additional terms, to the whole of the work, and all its parts,
+    regardless of how they are packaged.  This License gives no
+    permission to license the work in any other way, but it does not
+    invalidate such permission if you have separately received it.
+
+    d) If the work has interactive user interfaces, each must display
+    Appropriate Legal Notices; however, if the Program has interactive
+    interfaces that do not display Appropriate Legal Notices, your
+    work need not make them do so.
+
+  A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit.  Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+  6. Conveying Non-Source Forms.
+
+  You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+    a) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by the
+    Corresponding Source fixed on a durable physical medium
+    customarily used for software interchange.
+
+    b) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by a
+    written offer, valid for at least three years and valid for as
+    long as you offer spare parts or customer support for that product
+    model, to give anyone who possesses the object code either (1) a
+    copy of the Corresponding Source for all the software in the
+    product that is covered by this License, on a durable physical
+    medium customarily used for software interchange, for a price no
+    more than your reasonable cost of physically performing this
+    conveying of source, or (2) access to copy the
+    Corresponding Source from a network server at no charge.
+
+    c) Convey individual copies of the object code with a copy of the
+    written offer to provide the Corresponding Source.  This
+    alternative is allowed only occasionally and noncommercially, and
+    only if you received the object code with such an offer, in accord
+    with subsection 6b.
+
+    d) Convey the object code by offering access from a designated
+    place (gratis or for a charge), and offer equivalent access to the
+    Corresponding Source in the same way through the same place at no
+    further charge.  You need not require recipients to copy the
+    Corresponding Source along with the object code.  If the place to
+    copy the object code is a network server, the Corresponding Source
+    may be on a different server (operated by you or a third party)
+    that supports equivalent copying facilities, provided you maintain
+    clear directions next to the object code saying where to find the
+    Corresponding Source.  Regardless of what server hosts the
+    Corresponding Source, you remain obligated to ensure that it is
+    available for as long as needed to satisfy these requirements.
+
+    e) Convey the object code using peer-to-peer transmission, provided
+    you inform other peers where the object code and Corresponding
+    Source of the work are being offered to the general public at no
+    charge under subsection 6d.
+
+  A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+  A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling.  In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage.  For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product.  A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+  "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source.  The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+  If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information.  But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+  The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed.  Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+  Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+  7. Additional Terms.
+
+  "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law.  If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+  When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it.  (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.)  You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+  Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+    a) Disclaiming warranty or limiting liability differently from the
+    terms of sections 15 and 16 of this License; or
+
+    b) Requiring preservation of specified reasonable legal notices or
+    author attributions in that material or in the Appropriate Legal
+    Notices displayed by works containing it; or
+
+    c) Prohibiting misrepresentation of the origin of that material, or
+    requiring that modified versions of such material be marked in
+    reasonable ways as different from the original version; or
+
+    d) Limiting the use for publicity purposes of names of licensors or
+    authors of the material; or
+
+    e) Declining to grant rights under trademark law for use of some
+    trade names, trademarks, or service marks; or
+
+    f) Requiring indemnification of licensors and authors of that
+    material by anyone who conveys the material (or modified versions of
+    it) with contractual assumptions of liability to the recipient, for
+    any liability that these contractual assumptions directly impose on
+    those licensors and authors.
+
+  All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10.  If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term.  If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+  If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+  Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+  8. Termination.
+
+  You may not propagate or modify a covered work except as expressly
+provided under this License.  Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+  However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+  Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+  Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License.  If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+  9. Acceptance Not Required for Having Copies.
+
+  You are not required to accept this License in order to receive or
+run a copy of the Program.  Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance.  However,
+nothing other than this License grants you permission to propagate or
+modify any covered work.  These actions infringe copyright if you do
+not accept this License.  Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+  10. Automatic Licensing of Downstream Recipients.
+
+  Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License.  You are not responsible
+for enforcing compliance by third parties with this License.
+
+  An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations.  If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+  You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License.  For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+  11. Patents.
+
+  A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based.  The
+work thus licensed is called the contributor's "contributor version".
+
+  A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version.  For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+  Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+  In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement).  To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+  If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients.  "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+  If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+  A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License.  You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+  Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+  12. No Surrender of Others' Freedom.
+
+  If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all.  For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+  13. Remote Network Interaction; Use with the GNU General Public License.
+
+  Notwithstanding any other provision of this License, if you modify the
+Program, your modified version must prominently offer all users
+interacting with it remotely through a computer network (if your version
+supports such interaction) an opportunity to receive the Corresponding
+Source of your version by providing access to the Corresponding Source
+from a network server at no charge, through some standard or customary
+means of facilitating copying of software.  This Corresponding Source
+shall include the Corresponding Source for any work covered by version 3
+of the GNU General Public License that is incorporated pursuant to the
+following paragraph.
+
+  Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU General Public License into a single
+combined work, and to convey the resulting work.  The terms of this
+License will continue to apply to the part which is the covered work,
+but the work with which it is combined will remain governed by version
+3 of the GNU General Public License.
+
+  14. Revised Versions of this License.
+
+  The Free Software Foundation may publish revised and/or new versions of
+the GNU Affero General Public License from time to time.  Such new versions
+will be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+  Each version is given a distinguishing version number.  If the
+Program specifies that a certain numbered version of the GNU Affero General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation.  If the Program does not specify a version number of the
+GNU Affero General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+  If the Program specifies that a proxy can decide which future
+versions of the GNU Affero General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+  Later license versions may give you additional or different
+permissions.  However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+  15. Disclaimer of Warranty.
+
+  THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+  16. Limitation of Liability.
+
+  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+  17. Interpretation of Sections 15 and 16.
+
+  If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+                     END OF TERMS AND CONDITIONS
+
+            How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU Affero General Public License as published
+    by the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU Affero General Public License for more details.
+
+    You should have received a copy of the GNU Affero General Public License
+    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper mail.
+
+  If your software can interact with users remotely through a computer
+network, you should also make sure that it provides a way for users to
+get its source.  For example, if your program is a web application, its
+interface could display a "Source" link that leads users to an archive
+of the code.  There are many ways you could offer source, and different
+solutions will be better for different programs; see section 13 for the
+specific requirements.
+
+  You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU AGPL, see
+<https://www.gnu.org/licenses/>.

README.md

@@ -1,11 +1,107 @@
----
-title: Epoch Engine
-emoji: 🌖
-colorFrom: red
-colorTo: gray
-sdk: docker
-pinned: false
-license: apache-2.0
----
-
-Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+<p align="center"><img src="https://assets.khoj.dev/khoj-logo-sideways-1200x540.png" width="230" alt="Epoch Search Logo"></p>
+
+<div align="center">
+
+[![test](https://github.com/khoj-ai/khoj/actions/workflows/test.yml/badge.svg)](https://github.com/khoj-ai/khoj/actions/workflows/test.yml)
+[![docker](https://github.com/khoj-ai/khoj/actions/workflows/dockerize.yml/badge.svg)](https://github.com/khoj-ai/khoj/pkgs/container/khoj)
+[![pypi](https://github.com/khoj-ai/khoj/actions/workflows/pypi.yml/badge.svg)](https://pypi.org/project/khoj/)
+[![discord](https://img.shields.io/discord/1112065956647284756?style=plastic&label=discord)](https://discord.gg/BDgyabRM6e)
+
+</div>
+
+<div align="center">
+<b>Your AI second brain</b>
+</div>
+
+<br />
+
+<div align="center">
+
+[📑 Docs](https://docs.khoj.dev)
+<span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
+[🌐 Web](https://khoj.dev)
+<span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
+[🔥 App](https://app.khoj.dev)
+<span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
+[💬 Discord](https://discord.gg/BDgyabRM6e)
+<span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
+[✍🏽 Blog](https://blog.khoj.dev)
+
+<a href="https://trendshift.io/repositories/10318" target="_blank"><img src="https://trendshift.io/api/badge/repositories/10318" alt="khoj-ai%2Fkhoj | Trendshift" style="width: 250px; height: 55px;" width="250" height="55"/></a>
+
+</div>
+
+***
+
+### 🎁 New
+* Meet 🌶️ **[Pipali](https://pipali.ai)** - our [open-source](https://github.com/khoj-ai/pipali) AI coworker that runs on your computer.
+* [Read](https://blog.khoj.dev/posts/evaluate-khoj-quality/) about Epoch Search's excellent performance on modern retrieval and reasoning benchmarks.
+
+***
+
+## Overview
+
+[Epoch Search](https://khoj.dev) is a personal AI app to extend your capabilities. It smoothly scales up from an on-device personal AI to a cloud-scale enterprise AI.
+
+- Chat with any local or online LLM (e.g llama3, qwen, gemma, mistral, gpt, claude, gemini, deepseek).
+- Get answers from the internet and your docs (including image, pdf, markdown, org-mode, word, notion files).
+- Access it from your Browser, Obsidian, Emacs, Desktop, Phone or Whatsapp.
+- Create agents with custom knowledge, persona, chat model and tools to take on any role.
+- Automate away repetitive research. Get personal newsletters and smart notifications delivered to your inbox.
+- Find relevant docs quickly and easily using our advanced semantic search.
+- Generate images, talk out loud, play your messages.
+- Epoch Search is open-source, self-hostable. Always.
+- Run it privately on [your computer](https://docs.khoj.dev/get-started/setup) or try it on our [cloud app](https://app.khoj.dev).
+
+***
+
+## See it in action
+
+![demo_chat](https://github.com/khoj-ai/khoj/blob/master/documentation/assets/img/quadratic_equation_khoj_web.gif?raw=true)
+
+Go to https://app.khoj.dev to see Epoch Search live.
+
+## Full feature list
+You can see the full feature list [here](https://docs.khoj.dev/category/features).
+
+## Self-Host
+
+To get started with self-hosting Epoch Search, [read the docs](https://docs.khoj.dev/get-started/setup).
+
+## Enterprise
+
+Epoch Search is available as a cloud service, on-premises, or as a hybrid solution. To learn more about Epoch Search Enterprise, [visit our website](https://khoj.dev/teams).
+
+## Frequently Asked Questions (FAQ)
+
+Q: Can I use Epoch Search without self-hosting?
+
+Yes! You can use Epoch Search right away at [https://app.khoj.dev](https://app.khoj.dev) — no setup required.
+
+Q: What kinds of documents can Epoch Search read?
+
+Epoch Search supports a wide variety: PDFs, Markdown, Notion, Word docs, org-mode files, and more.
+
+Q: How can I make my own agent?
+
+Check out [this blog post](https://blog.khoj.dev/posts/create-agents-on-khoj/) for a step-by-step guide to custom agents.
+For more questions, head over to our [Discord](https://discord.gg/BDgyabRM6e)!
+
+
+## Contributors
+Cheers to our awesome contributors! 🎉
+
+<a href="https://github.com/khoj-ai/khoj/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=khoj-ai/khoj" />
+</a>
+
+Made with [contrib.rocks](https://contrib.rocks).
+
+### Interested in Contributing?
+Epoch Search is open source. It is sustained by the community and we’d love for you to join it! Whether you’re a coder, designer, writer, or enthusiast, there’s a place for you.
+
+Why Contribute?
+- Make an Impact: Help build, test and improve a tool used by thousands to boost productivity.
+- Learn & Grow: Work on cutting-edge AI, LLMs, and semantic search technologies.
+
+You can help us build new features, improve the project documentation, report issues and fix bugs. If you're a developer, please see our [Contributing Guidelines](https://docs.khoj.dev/contributing/development) and check out [good first issues](https://github.com/khoj-ai/khoj/contribute) to work on.

computer.Dockerfile

@@ -0,0 +1,130 @@
+FROM ubuntu:24.04
+ENV DEBIAN_FRONTEND=noninteractive
+
+# Install System Dependencies
+RUN apt update \
+    && apt install -y \
+        ca-certificates \
+        gnupg \
+        xfce4 \
+        xfce4-goodies \
+        x11vnc \
+        xvfb \
+        xdotool \
+        imagemagick \
+        x11-apps \
+        dbus-x11 \
+        sudo \
+        python3-pip \
+        python3-tk \
+        python3-dev \
+        build-essential \
+        scrot \
+        gnome-screenshot \
+        net-tools \
+        libx11-dev \
+        libxext-dev \
+        libxtst-dev \
+        libxinerama-dev \
+        libxmu-dev \
+        libxrandr-dev \
+        libxfixes-dev \
+        software-properties-common \
+    && add-apt-repository ppa:mozillateam/ppa && apt update \
+    && apt install -y --no-install-recommends \
+        # Desktop apps
+        firefox-esr \
+        libreoffice \
+        x11-apps \
+        xpdf \
+        gedit \
+        xpaint \
+        tint2 \
+        galculator \
+        pcmanfm \
+        unzip \
+        # Terminal apps like file editors, viewers, git, wget/curl etc.
+        less \
+        nano \
+        neovim \
+        vim \
+        git \
+        curl \
+        wget \
+        procps \
+        # Python/pyenv dependencies
+        libssl-dev  \
+        zlib1g-dev \
+        libbz2-dev \
+        libreadline-dev \
+        libsqlite3-dev \
+        libncursesw5-dev \
+        xz-utils \
+        tk-dev \
+        libxml2-dev \
+        libxmlsec1-dev \
+        libffi-dev \
+        liblzma-dev \
+    # set default browser
+    && update-alternatives --set x-www-browser /usr/bin/firefox-esr \
+    && apt-get clean && rm -rf /var/lib/apt/lists/* \
+    # remove screen locks, power managers
+    && apt remove -y light-locker xfce4-screensaver xfce4-power-manager || true
+
+# Create Computer User
+ENV USERNAME=khoj
+ENV HOME=/home/$USERNAME
+RUN groupadd $USERNAME && \
+    useradd -m -s /bin/bash -d $HOME -g $USERNAME $USERNAME && \
+    echo "${USERNAME} ALL=(ALL) NOPASSWD: ALL" >> /etc/sudoers
+USER $USERNAME
+WORKDIR $HOME
+
+# Install Python using uv and create a virtual environment
+COPY --from=ghcr.io/astral-sh/uv:latest /uv /uvx /bin/
+ENV PYTHON_VERSION=3.11.6
+RUN uv python pin $PYTHON_VERSION
+RUN uv venv $HOME/.venv --python $PYTHON_VERSION --seed
+RUN echo 'export PATH="$HOME/.venv/bin:$PATH"' >> "$HOME/.bashrc"
+ENV PATH="$HOME/.venv/bin:$PATH"
+
+# Install Python Packages
+RUN uv pip install --no-cache-dir \
+    pyautogui \
+    Pillow \
+    pyperclip \
+    pygetwindow
+
+# Setup VNC
+RUN x11vnc -storepasswd secret /home/khoj/.vncpass
+
+ARG WIDTH=1024
+ARG HEIGHT=768
+ARG DISPLAY_NUM=99
+ENV WIDTH=$WIDTH
+ENV HEIGHT=$HEIGHT
+ENV DISPLAY_NUM=$DISPLAY_NUM
+ENV DISPLAY=":$DISPLAY_NUM"
+
+# Expose VNC on port 5900
+EXPOSE 5900
+
+# Start Virtual Display (Xvfb), Desktop Manager (XFCE) and Remote Viewer (X11 VNC)
+CMD ["/bin/sh", "-c", "    \
+    # Create and permission XDG_RUNTIME_DIR with sudo \n\
+    export XDG_RUNTIME_DIR=/run/user/$(id -u); \
+    sudo mkdir -p $XDG_RUNTIME_DIR && \
+    sudo chown $(id -u):$(id -g) $XDG_RUNTIME_DIR && \
+    sudo chmod 0700 $XDG_RUNTIME_DIR; \
+    \
+    # Start Virtual Display \n\
+    Xvfb $DISPLAY -screen 0 ${WIDTH}x${HEIGHT}x24 -dpi 96 -auth /home/$USERNAME/.Xauthority >/dev/null 2>&1 & \
+    sleep 1; \
+    xauth add $DISPLAY . $(mcookie); \
+    \
+    # Start VNC Server \n\
+    x11vnc -display $DISPLAY -forever -rfbauth /home/$USERNAME/.vncpass -listen 0.0.0.0 -rfbport 5900 >/dev/null 2>&1 & \
+    eval $(dbus-launch --sh-syntax) && \
+    startxfce4 & \
+    sleep 2 && echo 'Container running!' && \
+    tail -f /dev/null "]

docker-compose.yml

@@ -0,0 +1,132 @@
+services:
+  database:
+    image: docker.io/pgvector/pgvector:pg15
+    environment:
+      POSTGRES_USER: postgres
+      POSTGRES_PASSWORD: postgres
+      POSTGRES_DB: postgres
+    volumes:
+      - khoj_db:/var/lib/postgresql/data/
+    healthcheck:
+      test: ["CMD-SHELL", "pg_isready -U postgres"]
+      interval: 30s
+      timeout: 10s
+      retries: 5
+  sandbox:
+    image: ghcr.io/khoj-ai/terrarium:latest
+    healthcheck:
+      test: ["CMD-SHELL", "curl -f http://localhost:8080/health"]
+      interval: 30s
+      timeout: 10s
+      retries: 2
+  search:
+    image: docker.io/searxng/searxng:latest
+    volumes:
+      - khoj_search:/etc/searxng
+    environment:
+      - SEARXNG_BASE_URL=http://localhost:8080/
+  # Creates Computer for Epoch Search to use.
+  # Set KHOJ_OPERATOR_ENABLED=True in the server service environment variable to enable.
+  computer:
+    container_name: khoj-computer
+    image: ghcr.io/khoj-ai/khoj-computer:latest
+    # build:
+    #   context: .
+    #   dockerfile: computer.Dockerfile
+    ports:
+      - "5900:5900"
+    volumes:
+      - khoj_computer:/home/operator
+  server:
+    depends_on:
+      database:
+        condition: service_healthy
+    # Use the following line to use the latest version of khoj. Otherwise, it will build from source. Set this to ghcr.io/khoj-ai/khoj-cloud:latest if you want to use the prod image.
+    image: ghcr.io/khoj-ai/khoj:latest
+    # Uncomment the following line to build from source. This will take a few minutes. Comment the next two lines out if you want to use the official image.
+    # build:
+      # context: .
+    ports:
+      # If changing the local port (left hand side), no other changes required.
+      # If changing the remote port (right hand side),
+      #   change the port in the args in the build section,
+      #   as well as the port in the command section to match
+      - "42110:42110"
+    extra_hosts:
+      - "host.docker.internal:host-gateway"
+    working_dir: /app
+    volumes:
+      - khoj_config:/root/.khoj/
+      - khoj_models:/root/.cache/torch/sentence_transformers
+      - khoj_models:/root/.cache/huggingface
+      # uncomment line below to mount docker socket to allow khoj to use its computer.
+      # - /var/run/docker.sock:/var/run/docker.sock
+    # Use 0.0.0.0 to explicitly set the host ip for the service on the container. https://pythonspeed.com/articles/docker-connection-refused/
+    environment:
+      - POSTGRES_DB=postgres
+      - POSTGRES_USER=postgres
+      - POSTGRES_PASSWORD=postgres
+      - POSTGRES_HOST=database
+      - POSTGRES_PORT=5432
+      - KHOJ_DJANGO_SECRET_KEY=secret
+      - KHOJ_DEBUG=False
+      - KHOJ_ADMIN_EMAIL=username@example.com
+      - KHOJ_ADMIN_PASSWORD=password
+      # Default URL of Terrarium, the default Python sandbox used by Epoch Search to run code. Its container is specified above
+      - KHOJ_TERRARIUM_URL=http://sandbox:8080
+      # Uncomment line below to have Epoch Search run code in remote E2B code sandbox instead of the self-hosted Terrarium sandbox above. Get your E2B API key from https://e2b.dev/.
+      # - E2B_API_KEY=your_e2b_api_key
+      # Default URL of SearxNG, the default web search engine used by Epoch Search. Its container is specified above
+      - KHOJ_SEARXNG_URL=http://search:8080
+      # Uncomment line below to use with Ollama running on your local machine at localhost:11434.
+      # Change URL to use with other OpenAI API compatible providers like VLLM, LMStudio, DeepInfra, DeepSeek etc.
+      # - OPENAI_BASE_URL=http://host.docker.internal:11434/v1/
+      # - KHOJ_DEFAULT_CHAT_MODEL=qwen3
+      #
+      # Uncomment appropriate lines below to use chat models by OpenAI, Anthropic, Google.
+      # Ensure you set your provider specific API keys.
+      # ---
+      # - OPENAI_API_KEY=your_openai_api_key
+      # - GEMINI_API_KEY=your_gemini_api_key
+      # - ANTHROPIC_API_KEY=your_anthropic_api_key
+      #
+      # Uncomment line below to enable Epoch Search to use its computer.
+      # - KHOJ_OPERATOR_ENABLED=True
+      # Uncomment appropriate lines below to enable web results with Epoch Search
+      # Ensure you set your provider specific API keys.
+      # ---
+      # Paid, Fast API. Only does web search. Get API key from https://serper.dev/
+      # - SERPER_DEV_API_KEY=your_serper_dev_api_key
+      # Paid, Higher Read Success API. Only does webpage read. Get API key from https://olostep.com/
+      # - OLOSTEP_API_KEY=your_olostep_api_key
+      # Paid, Open API. Does both web search and webpage read. Get API key from https://firecrawl.dev/
+      # - FIRECRAWL_API_KEY=your_firecrawl_api_key
+      # Paid, Fast API. Does both web search and webpage read. Get API key from https://exa.ai/
+      # - EXA_API_KEY=your_exa_api_key
+      #
+      # Uncomment the necessary lines below to make your instance publicly accessible.
+      # Proceed with caution, especially if you are using anonymous mode.
+      # ---
+      # - KHOJ_NO_HTTPS=True
+      # Replace the KHOJ_DOMAIN with the server's externally accessible domain or I.P address from a remote machie (no http/https prefix).
+      # Ensure this is set correctly to avoid CSRF trusted origin or unset cookie issue when trying to access the admin panel.
+      # - KHOJ_DOMAIN=192.168.0.104
+      # - KHOJ_DOMAIN=khoj.example.com
+      # Replace the KHOJ_ALLOWED_DOMAIN with the server's internally accessible domain or I.P address on the host machine (no http/https prefix).
+      # Only set if using a load balancer/reverse_proxy in front of your Epoch Search server. If unset, it defaults to KHOJ_DOMAIN.
+      # For example, if the load balancer service is added to the khoj docker network, set KHOJ_ALLOWED_DOMAIN to khoj's docker service name: `server'.
+      # - KHOJ_ALLOWED_DOMAIN=server
+      # - KHOJ_ALLOWED_DOMAIN=127.0.0.1
+      # Uncomment the line below to disable telemetry.
+      # Telemetry helps us prioritize feature development and understand how people are using Epoch Search
+      # Read more at https://docs.khoj.dev/miscellaneous/telemetry
+      # - KHOJ_TELEMETRY_DISABLE=True
+    # Comment out this line when you're using the official ghcr.io/khoj-ai/khoj-cloud:latest prod image.
+    command: --host="0.0.0.0" --port=42110 -vv --anonymous-mode --non-interactive
+
+volumes:
+  khoj_config:
+  khoj_db:
+  khoj_models:
+  khoj_search:
+  khoj_computer:

gunicorn-config.py

@@ -0,0 +1,17 @@
+import os
+
+bind = "0.0.0.0:42110"
+
+# Worker Configuration
+workers = int(os.environ.get("GUNICORN_WORKERS", 6))
+worker_class = "uvicorn.workers.UvicornWorker"
+
+# Worker Timeout Configuration
+timeout = int(os.environ.get("GUNICORN_TIMEOUT", 180))
+graceful_timeout = int(os.environ.get("GUNICORN_GRACEFUL_TIMEOUT", 90))
+keep_alive = int(os.environ.get("GUNICORN_KEEP_ALIVE", 60))
+
+# Logging Configuration
+accesslog = "-"
+errorlog = "-"
+loglevel = "debug"

manifest.json

@@ -0,0 +1,10 @@
+{
+	"id": "khoj",
+	"name": "Epoch Search",
+	"version": "2.0.0-beta.25",
+	"minAppVersion": "0.15.0",
+	"description": "Your Second Brain",
+	"author": "Epoch Search Inc.",
+	"authorUrl": "https://github.com/khoj-ai",
+	"isDesktopOnly": false
+}

prod.Dockerfile

@@ -0,0 +1,64 @@
+# syntax=docker/dockerfile:1
+FROM ubuntu:jammy AS base
+LABEL homepage="https://khoj.dev"
+LABEL repository="https://github.com/khoj-ai/khoj"
+LABEL org.opencontainers.image.source="https://github.com/khoj-ai/khoj"
+LABEL org.opencontainers.image.description="Your second brain, containerized for multi-user, cloud deployment"
+
+# Install System Dependencies
+RUN apt update -y && apt -y install \
+    python3-pip \
+    libsqlite3-0 \
+    ffmpeg \
+    libsm6 \
+    libxext6 \
+    swig \
+    curl \
+    # Required by llama-cpp-python pre-built wheels. See #1628
+    musl-dev && \
+    ln -s /usr/lib/x86_64-linux-musl/libc.so /lib/libc.musl-x86_64.so.1 && \
+    # Clean up
+    apt clean && rm -rf /var/lib/apt/lists/*
+
+# Build Server
+FROM base AS server-deps
+WORKDIR /app
+COPY pyproject.toml .
+COPY README.md .
+ARG VERSION=0.0.0
+# use the pre-built llama-cpp-python, torch cpu wheel
+ENV PIP_EXTRA_INDEX_URL="https://download.pytorch.org/whl/cpu https://abetlen.github.io/llama-cpp-python/whl/cpu"
+# avoid downloading unused cuda specific python packages
+ENV CUDA_VISIBLE_DEVICES=""
+RUN sed -i "s/dynamic = \\[\"version\"\\]/version = \"$VERSION\"/" pyproject.toml && \
+    pip install --no-cache-dir -e .[prod]
+
+# Build Web App
+FROM oven/bun:1-alpine AS web-app
+# Set build optimization env vars
+ENV NODE_ENV=production
+ENV NEXT_TELEMETRY_DISABLED=1
+WORKDIR /app/src/interface/web
+# Install dependencies first (cache layer)
+COPY src/interface/web/package.json src/interface/web/bun.lock ./
+RUN bun install --frozen-lockfile
+# Copy source and build
+COPY src/interface/web/. ./
+RUN bun run build
+
+# Merge the Server and Web App into a Single Image
+FROM base
+ENV PYTHONPATH=/app/src:$PYTHONPATH
+WORKDIR /app
+COPY --from=server-deps /usr/local/lib/python3.10/dist-packages /usr/local/lib/python3.10/dist-packages
+COPY --from=server-deps /usr/local/bin /usr/local/bin
+COPY --from=web-app /app/src/interface/web/out ./src/khoj/interface/built
+COPY . .
+RUN cd src && python3 khoj/manage.py collectstatic --noinput
+
+# Run the Application
+# There are more arguments required for the application to run,
+# but those should be passed in through the docker-compose.yml file.
+ARG PORT
+EXPOSE ${PORT}
+ENTRYPOINT ["gunicorn", "-c", "gunicorn-config.py", "src.khoj.main:app"]

pyproject.toml

@@ -0,0 +1,187 @@
+[build-system]
+requires = ["hatchling", "hatch-vcs"]
+build-backend = "hatchling.build"
+
+[project]
+name = "khoj"
+description = "Your Second Brain"
+readme = "README.md"
+license = "AGPL-3.0-or-later"
+requires-python = ">=3.10, <3.13"
+authors = [
+    { name = "Debanjum Singh Solanky, Saba Imran" },
+]
+keywords = [
+    "search",
+    "semantic-search",
+    "productivity",
+    "NLP",
+    "AI",
+    "org-mode",
+    "markdown",
+    "images",
+    "pdf",
+]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Internet :: WWW/HTTP :: Indexing/Search",
+    "Topic :: Scientific/Engineering :: Artificial Intelligence",
+    "Topic :: Scientific/Engineering :: Human Machine Interfaces",
+    "Intended Audience :: Information Technology",
+]
+dependencies = [
+    "beautifulsoup4 ~= 4.12.3",
+    "dateparser >= 1.1.1",
+    "defusedxml == 0.7.1",
+    "fastapi >= 0.110.0",
+    "python-multipart >= 0.0.22",
+    "jinja2 == 3.1.6",
+    "openai >= 2.0.0, < 3.0.0",
+    "tiktoken >= 0.3.2",
+    "tenacity >= 9.0.0",
+    "magika ~= 0.5.1",
+    "pillow >= 12.1.1",
+    "pydantic[email] >= 2.0.0",
+    "pyyaml ~= 6.0",
+    "rich >= 13.3.1",
+    "click < 8.2.2",
+    "schedule == 1.1.0",
+    "sentence-transformers == 3.4.1",
+    "einops == 0.8.0",
+    "transformers >= 4.53.0",
+    "torch == 2.6.0",
+    "uvicorn >= 0.31.1",
+    "aiohttp ~= 3.13.0",
+    "langchain-text-splitters == 0.3.11",
+    "langchain-community == 0.3.31",
+    "requests >= 2.32.4",
+    "anyio ~= 4.8.0",
+    "pymupdf == 1.24.11",
+    "django == 5.1.15",
+    "django-unfold == 0.42.0",
+    "authlib == 1.6.6",
+    "itsdangerous == 2.1.2",
+    "httpx == 0.28.1",
+    "pgvector == 0.2.4",
+    "psycopg2-binary == 2.9.9",
+    "lxml == 4.9.3",
+    "tzdata == 2023.3",
+    "rapidocr-onnxruntime == 1.4.4",
+    "openai-whisper >= 20231117",
+    "django-phonenumber-field == 7.3.0",
+    "phonenumbers == 8.13.27",
+    "markdownify ~= 0.14.1",
+    "markdown-it-py ~= 3.0.0",
+    "websockets == 13.0",
+    "psutil >= 5.8.0",
+    "huggingface-hub[hf_xet] >= 0.22.2",
+    "apscheduler ~= 3.10.0",
+    "pytz ~= 2024.1",
+    "cron-descriptor == 1.4.3",
+    "django_apscheduler == 0.7.0",
+    "anthropic == 0.75.0",
+    "docx2txt == 0.8",
+    "google-genai == 1.52.0",
+    "google-auth ~= 2.23.3",
+    "pyjson5 == 1.6.7",
+    "resend == 1.2.0",
+    "email-validator == 2.2.0",
+    "e2b-code-interpreter ~= 1.0.0",
+    "mcp >= 1.23.0",
+]
+dynamic = ["version"]
+
+[project.urls]
+Homepage = "https://khoj.dev"
+Documentation = "https://docs.khoj.dev"
+Code = "https://github.com/khoj-ai/khoj"
+
+[project.scripts]
+khoj = "khoj.main:run"
+
+[project.optional-dependencies]
+prod = [
+    "gunicorn == 22.0.0",
+    "stripe == 7.3.0",
+    "twilio == 8.11",
+    "boto3 >= 1.34.57",
+]
+local = [
+    "pgserver == 0.1.4",
+]
+dev = [
+    "khoj[prod,local]",
+    "pytest >= 7.1.2",
+    "pytest-xdist[psutil]",
+    "pytest-django == 4.5.2",
+    "pytest-asyncio == 0.21.1",
+    "freezegun >= 1.2.0",
+    "factory-boy >= 3.2.1",
+    "mypy >= 1.0.1",
+    "ruff >= 0.12.0",
+    "pre-commit >= 3.0.4",
+    "gitpython ~= 3.1.43",
+    "datasets",
+    "pandas",
+]
+
+[tool.hatch.version]
+source = "vcs"
+raw-options.local_scheme = "no-local-version"  # PEP440 compliant version for PyPi
+
+[tool.hatch.build.targets.sdist]
+include = ["src/khoj"]
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/khoj"]
+
+[tool.mypy]
+files = "src/khoj"
+pretty = true
+strict_optional = false
+install_types = true
+ignore_missing_imports = true
+non_interactive = true
+show_error_codes = true
+warn_unused_ignores = false
+
+[tool.ruff]
+line-length = 120
+
+[tool.ruff.lint]
+select = ["E", "F", "I"]  # Enable error, warning, and import checks
+ignore = [
+    "E501",  # Ignore line length
+    "F405",  # Ignore name not defined (e.g., from imports)
+    "E402",  # Ignore module level import not at top of file
+]
+unfixable = ["F841"]  # Don't auto-remove unused variables
+exclude = [ "tests/*.py" ]
+[tool.ruff.lint.per-file-ignores]
+"src/khoj/main.py" = [
+    "I001",  # Ignore Import order
+    "I002",  # Ignore Import not at top of file
+    "E402",  # Ignore module level import not at top of file
+]
+
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "space"
+
+[tool.ruff.lint.isort]
+known-first-party = ["khoj"]
+
+[tool.uv]
+build-constraint-dependencies = ["setuptools>=61.2,<82"]
+
+[tool.pytest.ini_options]
+addopts = "--strict-markers"
+markers = [
+    "chatquality: Evaluate chatbot capabilities and quality",
+]

pytest.ini

@@ -0,0 +1,7 @@
+[pytest]
+DJANGO_SETTINGS_MODULE = khoj.app.settings
+pythonpath = . src
+testpaths = tests
+addopts = --reuse-db
+markers =
+    chatquality: marks tests as chatquality (deselect with '-m "not chatquality"')

versions.json

@@ -0,0 +1,165 @@
+{
+	"0.2.1": "0.15.0",
+	"0.2.5": "0.15.0",
+	"0.2.6": "0.15.0",
+	"0.3.0": "0.15.0",
+	"0.4.0": "0.15.0",
+	"0.5.0": "0.15.0",
+	"0.6.0": "0.15.0",
+	"0.6.1": "0.15.0",
+	"0.6.2": "0.15.0",
+	"0.7.0": "0.15.0",
+	"0.7.1": "0.15.0",
+	"0.8.0": "0.15.0",
+	"0.8.1": "0.15.0",
+	"0.8.2": "0.15.0",
+	"0.9.0": "0.15.0",
+	"0.10.0": "0.15.0",
+	"0.10.1": "0.15.0",
+	"0.11.0": "0.15.0",
+	"0.11.1": "0.15.0",
+	"0.11.2": "0.15.0",
+	"0.11.3": "0.15.0",
+	"0.11.4": "0.15.0",
+	"0.12.0": "0.15.0",
+	"0.12.1": "0.15.0",
+	"0.12.2": "0.15.0",
+	"0.12.3": "0.15.0",
+	"0.13.0": "0.15.0",
+	"0.14.0": "0.15.0",
+	"1.0.0": "0.15.0",
+	"1.0.1": "0.15.0",
+	"1.1.0": "0.15.0",
+	"1.2.0": "0.15.0",
+	"1.2.1": "0.15.0",
+	"1.3.0": "0.15.0",
+	"1.4.0": "0.15.0",
+	"1.5.0": "0.15.0",
+	"1.5.1": "0.15.0",
+	"1.6.0": "0.15.0",
+	"1.6.1": "0.15.0",
+	"1.6.2": "0.15.0",
+	"1.7.0": "0.15.0",
+	"1.8.0": "0.15.0",
+	"1.9.0": "0.15.0",
+	"1.10.0": "0.15.0",
+	"1.10.1": "0.15.0",
+	"1.10.2": "0.15.0",
+	"1.11.0": "0.15.0",
+	"1.11.1": "0.15.0",
+	"1.11.2": "0.15.0",
+	"1.12.0": "0.15.0",
+	"1.12.1": "0.15.0",
+	"1.13.0": "0.15.0",
+	"1.14.0": "0.15.0",
+	"1.15.0": "0.15.0",
+	"1.16.0": "0.15.0",
+	"1.17.0": "0.15.0",
+	"1.20.0": "0.15.0",
+	"1.20.1": "0.15.0",
+	"1.20.2": "0.15.0",
+	"1.20.3": "0.15.0",
+	"1.20.4": "0.15.0",
+	"1.21.0": "0.15.0",
+	"1.21.1": "0.15.0",
+	"1.21.2": "0.15.0",
+	"1.21.3": "0.15.0",
+	"1.21.4": "0.15.0",
+	"1.21.5": "0.15.0",
+	"1.21.6": "0.15.0",
+	"1.22.0": "0.15.0",
+	"1.22.1": "0.15.0",
+	"1.22.2": "0.15.0",
+	"1.22.3": "0.15.0",
+	"1.23.0": "0.15.0",
+	"1.23.1": "0.15.0",
+	"1.23.2": "0.15.0",
+	"1.23.3": "0.15.0",
+	"1.24.0": "0.15.0",
+	"1.24.1": "0.15.0",
+	"1.25.0": "0.15.0",
+	"1.26.0": "0.15.0",
+	"1.26.1": "0.15.0",
+	"1.26.2": "0.15.0",
+	"1.26.3": "0.15.0",
+	"1.26.4": "0.15.0",
+	"1.27.0": "0.15.0",
+	"1.27.1": "0.15.0",
+	"1.28.0": "0.15.0",
+	"1.28.1": "0.15.0",
+	"1.28.2": "0.15.0",
+	"1.28.3": "0.15.0",
+	"1.29.0": "0.15.0",
+	"1.29.1": "0.15.0",
+	"1.30.0": "0.15.0",
+	"1.30.1": "0.15.0",
+	"1.30.2": "0.15.0",
+	"1.30.3": "0.15.0",
+	"1.30.4": "0.15.0",
+	"1.30.5": "0.15.0",
+	"1.30.6": "0.15.0",
+	"1.30.7": "0.15.0",
+	"1.30.8": "0.15.0",
+	"1.30.9": "0.15.0",
+	"1.30.10": "0.15.0",
+	"1.31.0": "0.15.0",
+	"1.32.0": "0.15.0",
+	"1.32.1": "0.15.0",
+	"1.32.2": "0.15.0",
+	"1.33.0": "0.15.0",
+	"1.33.1": "0.15.0",
+	"1.33.2": "0.15.0",
+	"1.34.0": "0.15.0",
+	"1.35.0": "0.15.0",
+	"1.35.1": "0.15.0",
+	"1.35.2": "0.15.0",
+	"1.35.3": "0.15.0",
+	"1.36.0": "0.15.0",
+	"1.36.1": "0.15.0",
+	"1.36.2": "0.15.0",
+	"1.36.3": "0.15.0",
+	"1.36.4": "0.15.0",
+	"1.36.5": "0.15.0",
+	"1.36.6": "0.15.0",
+	"1.37.0": "0.15.0",
+	"1.37.1": "0.15.0",
+	"1.37.2": "0.15.0",
+	"1.38.0": "0.15.0",
+	"1.39.0": "0.15.0",
+	"1.40.0": "0.15.0",
+	"1.41.0": "0.15.0",
+	"1.42.0": "0.15.0",
+	"1.42.1": "0.15.0",
+	"1.42.2": "0.15.0",
+	"1.42.3": "0.15.0",
+	"1.42.4": "0.15.0",
+	"1.42.5": "0.15.0",
+	"1.42.6": "0.15.0",
+	"1.42.7": "0.15.0",
+	"1.42.8": "0.15.0",
+	"2.0.0-beta.1": "0.15.0",
+	"2.0.0-beta.2": "0.15.0",
+	"2.0.0-beta.3": "0.15.0",
+	"2.0.0-beta.4": "0.15.0",
+	"2.0.0-beta.5": "0.15.0",
+	"2.0.0-beta.6": "0.15.0",
+	"2.0.0-beta.7": "0.15.0",
+	"2.0.0-beta.8": "0.15.0",
+	"2.0.0-beta.9": "0.15.0",
+	"2.0.0-beta.10": "0.15.0",
+	"2.0.0-beta.11": "0.15.0",
+	"2.0.0-beta.12": "0.15.0",
+	"2.0.0-beta.13": "0.15.0",
+	"2.0.0-beta.14": "0.15.0",
+	"2.0.0-beta.15": "0.15.0",
+	"2.0.0-beta.16": "0.15.0",
+	"2.0.0-beta.17": "0.15.0",
+	"2.0.0-beta.18": "0.15.0",
+	"2.0.0-beta.19": "0.15.0",
+	"2.0.0-beta.20": "0.15.0",
+	"2.0.0-beta.21": "0.15.0",
+	"2.0.0-beta.22": "0.15.0",
+	"2.0.0-beta.23": "0.15.0",
+	"2.0.0-beta.24": "0.15.0",
+	"2.0.0-beta.25": "0.15.0"
+}