docs icon indicating copy to clipboard operation
docs copied to clipboard

docs: update docker page with updated flow

Open jcstein opened this issue 1 year ago • 4 comments

fix up docker page

  1. quick start - this should be the first step
  2. persistent storage
    1. Don't need init, remove this step
    2. this guide should show you how to (a) make store location (b) then run with that store location
  3. 3rd option, "use light node with rollup"
    1. move the advice for ports to the bottom where you have a
  4. Nice-to-have: use names to name the container to make it easier to interact with

cc @MSevey for vis and for anything I missed

jcstein avatar Oct 03 '24 15:10 jcstein

to be done after https://github.com/celestiaorg/celestia-node/pull/3808 is live

jcstein avatar Oct 03 '24 15:10 jcstein

Another thought for the quick start section might to also just hardcode some more values and make it clear that it is for starting a light node to sample.

Then the only decision is which network to target. And with that even hardcoding the RPC endpoint for them. I honestly mess up that endpoint every time.

Although I know you are also trying to improve the rpc endpoint table documentation page so that might help. But either way I think the quick start shouldn't make someone leave the page for any information.

MSevey avatar Oct 03 '24 21:10 MSevey

Notes from slack discussion:

When I was doing some testing with the docker images, it appears that the ENV VARs are used to set the config.toml file during the celestia init command that the dockerfile entrypoint script calls. While the flags are for the celestia start command. -- I know many people manually set their config files, so they wouldn’t need to set the ENV VARs in that instance I’m pretty sure.

jcstein avatar Nov 19 '24 04:11 jcstein

From discord:

It exposes gateway port, however, documentation says gateway is deprecated

jcstein avatar Dec 02 '24 21:12 jcstein