Skip to content

Commit f5eda6c

Browse files
author
meichuan
committed
docs: add FAQ and Troubleshooting section to README
1 parent 64cfda5 commit f5eda6c

1 file changed

Lines changed: 77 additions & 0 deletions

File tree

‎README.md‎

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -152,6 +152,83 @@ See the [environment variables reference](https://docs.sim.ai/self-hosting/envir
152152
- **Remote Code Execution**: [E2B](https://www.e2b.dev/)
153153
- **Isolated Code Execution**: [isolated-vm](https://github.com/laverdet/isolated-vm)
154154

155+
## Frequently Asked Questions (FAQ)
156+
157+
### General Questions
158+
159+
**Q: What is Sim?**
160+
A: Sim is an open-source platform to build AI agents and run your agentic workforce. It provides a visual workflow builder, 1,000+ integrations, and support for multiple LLMs to orchestrate agentic workflows.
161+
162+
**Q: Is Sim free to use?**
163+
A: Yes, Sim is open-source (Apache 2.0 license). You can self-host it for free or use the cloud-hosted version at [sim.ai](https://sim.ai).
164+
165+
**Q: What's the difference between self-hosted and cloud?**
166+
A:
167+
- **Cloud (sim.ai)**: Managed service with automatic updates, scaling, and support
168+
- **Self-hosted**: Full control over your data and infrastructure, requires your own resources
169+
170+
**Q: Which AI models does Sim support?**
171+
A: Sim supports all major LLM providers including OpenAI, Anthropic, Google, and local models via Ollama and vLLM. See the [documentation](https://docs.sim.ai) for the complete list.
172+
173+
### Installation & Setup
174+
175+
**Q: What are the requirements for self-hosting?**
176+
A:
177+
- **Docker method**: Docker and Docker Compose installed, 12GB+ RAM recommended
178+
- **Manual method**: Bun, Node.js v20+, PostgreSQL 12+ with pgvector extension
179+
180+
**Q: How do I install Sim?**
181+
A: The easiest way is using the NPM package:
182+
```bash
183+
npx simstudio
184+
```
185+
186+
Or with Docker Compose:
187+
```bash
188+
git clone https://github.com/simstudioai/sim.git && cd sim
189+
docker compose -f docker-compose.prod.yml up -d
190+
```
191+
192+
**Q: Can I use local AI models?**
193+
A: Yes! Sim supports local models via Ollama and vLLM. See the [Docker self-hosting docs](https://docs.sim.ai/self-hosting/docker) for setup details.
194+
195+
**Q: How do I enable Copilot in self-hosted instances?**
196+
A: Copilot is a Sim-managed service. Generate a Copilot API key at https://sim.ai → Settings → Copilot, then set `COPILOT_API_KEY` in your `.env` file.
197+
198+
### Troubleshooting
199+
200+
**Port already in use errors**
201+
- Default ports: 3000 (app), 3002 (sockets), 5432 (PostgreSQL)
202+
- Change ports in docker-compose.yml or stop conflicting services
203+
- Check with: `lsof -i :3000` or `docker ps`
204+
205+
**Docker containers not starting**
206+
- Ensure Docker daemon is running: `docker info`
207+
- Check available memory: Sim needs 12GB+ RAM
208+
- View logs: `docker compose -f docker-compose.prod.yml logs`
209+
210+
**Database connection errors**
211+
- Verify PostgreSQL is running with pgvector extension
212+
- Check connection string in `.env` file
213+
- For Docker: ensure the db container is healthy before starting app
214+
215+
**Workflow not executing**
216+
- Check that all required API keys are configured
217+
- Verify node connections in the workflow builder
218+
- Review logs in the Sim dashboard or Docker logs
219+
220+
**Copilot not working**
221+
- Ensure `COPILOT_API_KEY` is set correctly in `.env`
222+
- Verify the key is valid (generate new one if needed)
223+
- Check network connectivity to sim.ai
224+
225+
### Getting More Help
226+
227+
- 📚 **Documentation**: [docs.sim.ai](https://docs.sim.ai)
228+
- 💬 **Discord**: [Join Server](https://discord.gg/Hr4UWYEcTT)
229+
- 🐛 **Bug Reports**: [GitHub Issues](https://github.com/simstudioai/sim/issues)
230+
- 📧 **Contact**: [sim.ai](https://sim.ai)
231+
155232
## Contributing
156233

157234
We welcome contributions! Please see our [Contributing Guide](.github/CONTRIBUTING.md) for details.

0 commit comments

Comments
 (0)