This guide will go over how to set up a Rapture API server on your own machine using Docker
Prerequisite: You must have Docker installed on your machine. If you do not have Docker, please install the appropriate version for your operating system from: https://docs.docker.com/engine/installation/
- Ensure that your Docker machine (if using a VM) is up and running, and that it has at least 4gb of memory allowed. You can check the allotted memory by opening Virtual Box and adjusting the system settings of the default Docker VM.
To download the docker-compose.yml file from our open source github repository, use the following command:
Then, in the same directory, run the following command:
To tail the API server's log in a terminal, do the following:
- You should now be able to see the recent log entries from the RaptureAPI server. If you see "Local api url is <URL>..." then the API server has successfully started.
- API calls can be directed to http://<dockerMachineIP>:8665/rapture
Now that you have your own Rapture API server up & running, you're probably curious how to use the API itself. We have extensive API & Reflex documentation as well as a few tutorials to get you started: