For ease of installation, we highly recommend installing Investbrain using the provided Docker Compose file, which uses the official Investbrain Docker image and includes all the necessary dependencies to seamlessly build everything you need to get started quickly!
Before getting started, you should already have Docker Engine installed on your machine.
Ready? Let's get started!
1. Download copy of Docker Compose file
Grab a copy of the docker-compose.yml using wget, curl or similar:
curl -O https://raw.githubusercontent.com/investbrainapp/investbrain/main/docker-compose.yml
2. Set your environment
Adjust the environment properties in the compose file to your preferences.
Importantly, you need to set the APP_KEY value. If you're unsure, Investbrain will generate an APP_KEY for you on first run, but it will not persist. You must manually update your environment configuration with this generated value!
Alternatively, create a .env file in the same directory as your compose file, then reference the .env file using the env_file property.
Want to know what other configuration options are available? You can reference the .env.example file in this respository for available environment configurations.
3. Run docker compose up
It might take a few minutes to pull the Docker images. But assuming everything worked as expected, you should now be able to access Investbrain in the browser by visiting:
http://localhost:8000/register
Congrats! You've just installed Investbrain!