GiancarloJSantos / enhancedocs

EnhanceDocs

Welcome to EnhanceDocs! EnhanceDocs is the open-source AI-powered search engine for your project or business documentation.

Getting Started

Download EnhanceDocs

• Cloning this repository git clone [e-mail]:enhancedocs/enhancedocs.git

or

• Using docker image docker pull enhancedocs/enhancedocs

Set up env variables

Use the .example.env as a template and fill with the required fields.

• OPENAI_API_KEY is required; EnhanceDocs relies on OpenAI API
• ENHANCEDOCS_API_KEY is optional; By default you can ingest data into EnhanceDocs without an API Key, so you can work conformable in your local environment, but we highlight recommend to set this on production if you are exposing the API to the internet.
• ENHANCEDOCS_ACCESS_TOKEN is optional; This is a client side token, and we recommend its usage together with cors so only your site can make requests to the API.

cp .example.env .env

Update prompt_template.txt

Update prompt_template.txt so matches your project description

🚀 Launch EnhanceDocs

docker compose up

Managed EnhanceDocs

EnhanceDocs is free and open source, and it requires that you self-host it. Alternatively you can use EnhanceDocs managed version, with built-in integrations with your preferred tools out of box, such as Notion, Slack, Teams, Confluence, Discord and much more...

https://enhancedocs.com

LICENSE

EnhanceDocs is free and the source is available. EnhanceDocs is published under the Server Side Public License (SSPL) v1