Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update docker page with updated flow #1749

Open
jcstein opened this issue Oct 3, 2024 · 4 comments
Open

docs: update docker page with updated flow #1749

jcstein opened this issue Oct 3, 2024 · 4 comments
Labels
good first issue Good for newcomers help wanted Extra attention is needed

Comments

@jcstein
Copy link
Member

jcstein commented Oct 3, 2024

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
Copy link
Member Author

jcstein commented Oct 3, 2024

to be done after celestiaorg/celestia-node#3808 is live

@MSevey
Copy link
Member

MSevey commented Oct 3, 2024

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.

@jcstein
Copy link
Member Author

jcstein commented Nov 19, 2024

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 jcstein added good first issue Good for newcomers help wanted Extra attention is needed labels Nov 27, 2024
@jcstein
Copy link
Member Author

jcstein commented Dec 2, 2024

From discord:

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants