Get DeepWiki-Open running in under 5 minutes with Docker or manual setup
Clone the Repository
Configure Environment Variables
.env
file with your API keys:GOOGLE_API_KEY
or OPENAI_API_KEY
to get started.Start with Docker Compose
Access DeepWiki
Set Up Environment Variables
.env
file in the project root:Start the Backend API
Start the Frontend
Enter Repository URL
https://github.com/openai/codex
https://github.com/microsoft/autogen
https://gitlab.com/gitlab-org/gitlab
https://bitbucket.org/redradish/atlassian_app_versions
Add Access Token (For Private Repos)
Select AI Model Provider
Google Gemini (Recommended)
gemini-2.0-flash
gemini-1.5-flash
, gemini-1.0-pro
OpenAI
gpt-4o
o1
, o3
, o4-mini
OpenRouter
Generate Wiki
.env
as GOOGLE_API_KEY=your_key_here
Backend Health Check
Frontend Connection
Environment Variables
Cannot connect to API server
Missing environment variables error
.env
file exists in project rootAPI key not valid error