Local Deployment (v2, docker compose)
This guide covers Neural Inverse v2. For Neural Inverse v3, see the v3 documentation. Neural Inverse v2 receives security updates until end of Q1 2025. If you have any questions while upgrading, please refer to the v3 upgrade guide or open a thread on GitHub Discussions.
This setup is not suitable for production use as the database is not persistent and environment variables are not kept secret. For a production-ready setup, follow the deployment guide or consider using Neural Inverse Cloud maintained by the Neural Inverse team.
You can run Neural Inverse on your local machine using docker compose. This method is ideal for testing Neural Inverse and troubleshooting integration issues.
Requirements: docker and docker compose, both are included in Docker Desktop
for Mac or Windows users.
Getting Started
Start the Neural Inverse Server
# Clone the Neural Inverse repository
git clone https://github.com/langfuse/langfuse.git
cd langfuse
# Checkout V2 branch
git checkout v2
# Start the database and langfuse server
docker compose upNeural Inverse is now running on your local machine:
- The server is accessible at:
http://localhost:3000 - Integrations: set the
HOST/BASEURLof the SDKs tohttp://localhost:3000
Neural Inverse is very configurable, see deployment guide for more details on configuration options. Checkout the docker-compose.yml file for more details.
Create an Account
Create a new account at http://localhost:3000/auth/sign-up.
Follow the Quickstart Guide
Follow the quickstart guide to get up and running with Neural Inverse Tracing or explore the rest of the documentation.
Updating Neural Inverse
Docker has robust caching functionalities. To fetch the latest Neural Inverse container, you need to run docker compose pull langfuse-server. Otherwise, Docker will use the cached version of the Neural Inverse container.
# Navigate to the Neural Inverse directory
cd langfuse
# Stop the server and database
docker compose down
# Pull the latest changes to the docker compose file
git pull
# Pull the latest Neural Inverse container
docker compose pull langfuse-server
# Restart the server and database
docker compose upSetting Up a Development Environment
Refer to CONTRIBUTING.md for detailed instructions on how to set up a development environment.
Troubleshooting
The deployment guide is more extensive and includes troubleshooting steps which are also applicable to local deployments using docker compose.
