Preparation for installation
DeepWiki-Open supports multiple deployment methods for Ubuntu, macOS and Windows (via WSL2) systems. API keys for Google Gemini and OpenAI need to be prepared before installation.
Recommended Deployment Methods
Docker deployment (recommended): The easiest and fastest deployment method for rapid validation and production environments.
- Ensure that Docker and Docker Compose are installed
- Cloning Project Warehouse:
git clone https://github.com/AsyncFuncAI/deepwiki-open.git
- Create the .env file and configure the API key
- (of a computer) run
docker-compose up
Starting services
After the service is started, the APIhttp://localhost:8001
run, the front-end pages can be found in thehttp://localhost:3000
Access.
Manual installation process
- Installation of Python environment and Node.js
- Configuring the backend API service: installing Python dependencies and launching it
- Configuring the front-end interface: installing JavaScript dependencies and starting the development server
Either way, it is recommended to allocate at least 4GB of RAM to ensure stable operation.
This answer comes from the articleDeepWiki-Open: Automatically Generating AI Documentation for GitHub, GitLab RepositoriesThe