Frequently Asked Questions
Installation and deployment
Q: What are the system requirements?
- A:
- Python 3.8+ or PHP 7.4+
- At least 2GB of memory
- 10GB of free disk space
- SQLite 3, MySQL 5.7+ or PostgreSQL 10+
Q: How do I change the default port?
A: Set the listen_port option in the configuration file, or use Docker port mapping:
docker run -d -p 8080:80 neurova/neurova:latestUsing the API
Q: I lost my API key. What now?
- A: An API key is displayed only once, at creation time. If it is lost:
- Open the admin console at
/admin/agent-keys.php - Delete the old key
- Create a new key
- Update everywhere the old key was used
Q: How do I check that the API works?
A: Test it with curl:
curl -X GET "https://your-site.com/api/agent/releases.php" \
-H "Authorization: Bearer <key_id>|<secret_key>"Agent management
Q: How do I restrict what an agent may do?
- A: When creating or editing an API key, choose the matching permission:
read: read operations onlywrite: read and write operationsadmin: manage API keys
Q: How does rate limiting work?
A: Each API key has its own rate limit, counted in requests per hour. Requests beyond the limit return 429 Too Many Requests.
Data safety
Q: Is my data uploaded to a cloud?
A: No. Neurova is deployed entirely on your own infrastructure, and all data stays on your server.
Q: How do I back up the database?
A: Back up the data/neurova.db file on a schedule:
# restore
cp backup/neurova-20240101.db data/neurova.db
```