Skip to content

Commit ae4a9ed

Browse files
feat: added FAQ in README section
1 parent d400db2 commit ae4a9ed

1 file changed

Lines changed: 29 additions & 0 deletions

File tree

README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -316,3 +316,32 @@ to [CONTRIBUTING](CONTRIBUTING.md).
316316
## Support
317317

318318
Join the [Zep Discord server](https://discord.com/invite/W8Kw6bsgXQ) and make your way to the **#Graphiti** channel!
319+
320+
## Frequently Asked Questions (FAQ)
321+
322+
**Q: I get a connection error when trying to use Neo4j. What should I do?**
323+
- Ensure Neo4j is running and accessible at the address you provided (default: `bolt://localhost:7687`).
324+
- Double-check your username and password.
325+
- If using Docker, make sure the container is running and ports are mapped correctly.
326+
327+
**Q: How do I set my OpenAI or other API keys?**
328+
- Set the required API keys as environment variables (e.g., `OPENAI_API_KEY`, `ANTHROPIC_API_KEY`, etc.).
329+
- You can use a `.env` file or set them directly in your shell before running your application.
330+
331+
**Q: Can I use Graphiti without Neo4j?**
332+
- No, Neo4j is required as the graph database backend for Graphiti.
333+
334+
**Q: Where can I find more examples or ask for help?**
335+
- Check the `examples/` directory for sample projects and usage.
336+
- Visit the [documentation](https://help.getzep.com/graphiti) for guides and API references.
337+
- Join the [Zep Discord server](https://discord.com/invite/W8Kw6bsgXQ) and ask in the **#Graphiti** channel.
338+
339+
**Q: I encountered an error or bug. How can I report it?**
340+
- Please open an issue on the [GitHub Issues page](https://github.com/getzep/graphiti/issues) with details and steps to reproduce.
341+
342+
**Q: How can I contribute to the project?**
343+
- See the [CONTRIBUTING.md](CONTRIBUTING.md) file for guidelines on contributing code, documentation, or support.
344+
345+
---
346+
347+
If your question is not answered here, please refer to the documentation or reach out via Discord or GitHub Issues!

0 commit comments

Comments
 (0)