If you would like to run with Docker, you'll need install docker and docker-compose:
- Install options for docker here.
- Install options for docker-compose (if it doesn’t come bundled with Docker) here.
Make sure you have configured your
packages/api/.envfile with the environment variables you need for your cloud provider(s).
Ensure you have cloud provider credentials files in the following locations on your filesystem:
Ensure you have saved your environment variables as files on your local file system. Docker compose will use these securely as Docker Secrets at run time, in the ~/.docker/secrets directory. To aid with this, we have a script you can run that does this:cd packages/api && ./create_docker_secrets.sh && cd ../..
Remove any secrets in
docker-compose.ymlthat you aren’t not using.
Run the application with docker compose:docker-compose up
You can then access the dashboard at http://localhost:80
If you would like to only run the API as a docker container, for example to deploy this as a service for your organization, you can pull and run it with these commands:
Then you can access the API at: http://localhost:4000/api/footprint?start=2021-01-01&end=2021-02-01