FuelLabs / fuel-indexer

🗃 The Fuel indexer is a standalone service that can be used to index various components of the Fuel blockchain.
https://docs.fuel.network/docs/indexer/
140 stars 66 forks source link

Docker container documentation #1479

Open Braqzen opened 8 months ago

Braqzen commented 8 months ago

We provide a docker-compose.yml but do not inform the user of what to do with it, how to alter it etc.

It would be useful to show the user the command to build / start a container, when to update via pull, how to update the compose file with additional flags and which sections to leave as they are.

Ex. in order to redeploy an indexer that has been updated I needed to update the container with a flag for the service and also deploy with an additional flag. This was undocumented at the time and I have raised an issue which may have been specifically addressed since then.

The idea is to get the user up and running quickly instead of assume that they know how to user docker.