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

How do users discover the Web UI? #815

Closed
olizilla opened this issue Sep 25, 2018 · 4 comments · Fixed by ipfs/js-ipfs#1595
Closed

How do users discover the Web UI? #815

olizilla opened this issue Sep 25, 2018 · 4 comments · Fixed by ipfs/js-ipfs#1595
Labels
kind/discussion Topical discussion; usually not changes to codebase status/in-progress In progress

Comments

@olizilla
Copy link
Member

It's mentioned in the docs

as:

We also have a web console you can use to check the state of your node. On your favorite web browser, go to:
http://localhost:5001/webui

but if you don't read the docs that far (or at all) then I think the Web UI is basically hidden from you.

What if we added a log line to go-ipfs and js-ipfs start up like:

$ jsipfs daemon
Initializing daemon...
Swarm listening on /ip4/127.0.0.1/tcp/4003/ws/ipfs/QmNTAZYQ5rtaoFtryAX2h9dycuBjhVgXtjPVZNYuMHMBw8
Swarm listening on /ip4/127.0.0.1/tcp/4002/ipfs/QmNTAZYQ5rtaoFtryAX2h9dycuBjhVgXtjPVZNYuMHMBw8
Swarm listening on /ip4/192.168.1.244/tcp/4002/ipfs/QmNTAZYQ5rtaoFtryAX2h9dycuBjhVgXtjPVZNYuMHMBw8
API is listening on: /ip4/127.0.0.1/tcp/5002
Gateway (readonly) is listening on: /ip4/127.0.0.1/tcp/9090
Web UI available at http://localhost:5002/webui
Daemon is ready
@olizilla olizilla added the kind/discussion Topical discussion; usually not changes to codebase label Sep 25, 2018
@meiqimichelle
Copy link

If this is straighforward to add, I don't see any reason not to! That info seems to fit with all the other info listed -- aka, here are all the things you now have available to you at these locations.

While we're there, we should standardize the language for all the sentences (colon versus no-colon). So, it could be:

$ jsipfs daemon
Initializing daemon...
Swarm listening on: /ip4/127.0.0.1/tcp/4003/ws/ipfs/QmNTAZYQ5rtaoFtryAX2h9dycuBjhVgXtjPVZNYuMHMBw8
Swarm listening on: /ip4/127.0.0.1/tcp/4002/ipfs/QmNTAZYQ5rtaoFtryAX2h9dycuBjhVgXtjPVZNYuMHMBw8
Swarm listening on: /ip4/192.168.1.244/tcp/4002/ipfs/QmNTAZYQ5rtaoFtryAX2h9dycuBjhVgXtjPVZNYuMHMBw8
API is listening on: /ip4/127.0.0.1/tcp/5002
Gateway (readonly) is listening on: /ip4/127.0.0.1/tcp/9090
Web UI available at: http://localhost:5002/webui
Daemon is ready

or

$ jsipfs daemon
Initializing daemon...
Swarm listening on /ip4/127.0.0.1/tcp/4003/ws/ipfs/QmNTAZYQ5rtaoFtryAX2h9dycuBjhVgXtjPVZNYuMHMBw8
Swarm listening on /ip4/127.0.0.1/tcp/4002/ipfs/QmNTAZYQ5rtaoFtryAX2h9dycuBjhVgXtjPVZNYuMHMBw8
Swarm listening on /ip4/192.168.1.244/tcp/4002/ipfs/QmNTAZYQ5rtaoFtryAX2h9dycuBjhVgXtjPVZNYuMHMBw8
API is listening on /ip4/127.0.0.1/tcp/5002
Gateway (readonly) is listening on /ip4/127.0.0.1/tcp/9090
Web UI available at http://localhost:5002/webui
Daemon is ready

@olizilla
Copy link
Member Author

Engaging copy editor eyes 👀 ...see also the flip flop between is listening vs listening and the new word readonly which could be human'd to read only, and there is zero mention of IPFS... a little confirmation that you've started the thing you expected wouldn't hurt... so how about:

$ jsipfs daemon
Initializing IPFS daemon...
Swarm listening on /ip4/127.0.0.1/tcp/4003/ws/ipfs/QmNTAZYQ5rtaoFtryAX2h9dycuBjhVgXtjPVZNYuMHMBw8
Swarm listening on /ip4/127.0.0.1/tcp/4002/ipfs/QmNTAZYQ5rtaoFtryAX2h9dycuBjhVgXtjPVZNYuMHMBw8
Swarm listening on /ip4/192.168.1.244/tcp/4002/ipfs/QmNTAZYQ5rtaoFtryAX2h9dycuBjhVgXtjPVZNYuMHMBw8
API listening on /ip4/127.0.0.1/tcp/5002
Gateway (read only) listening on /ip4/127.0.0.1/tcp/9090
Web UI available at http://localhost:5002/webui
Daemon is ready
  • no colons, simply siding with what most of the log lines do currently
  • use "listening on" consistently
  • "read only" not "readonly"
  • Initializing IPFS daemon... to confirm to the user they started the thing they expected.

I'd keep the "Daemon is ready" copy the same though as it's the kind of output that people might be scraping from scripts to check that it started without error, and changing it would frustrate.

@olizilla
Copy link
Member Author

...what I'd actually like to see in my console.

$ jsipfs daemon
Starting IPFS daemon

Peer ID       QmNTAZYQ5rtaoFtryAX2h9dycuBjhVgXtjPVZNYuMHMBw8
Swarm address /ip4/127.0.0.1/tcp/4003/ws/ipfs QmNTAZYQ5rtaoFtryAX2h9dycuBjhVgXtjPVZNYuMHMBw8
Swarm address /ip4/127.0.0.1/tcp/4002/ipfs/QmNTAZYQ5rtaoFtryAX2h9dycuBjhVgXtjPVZNYuMHMBw8
Swarm address /ip4/192.168.1.244/tcp/4002/ipfs/QmNTAZYQ5rtaoFtryAX2h9dycuBjhVgXtjPVZNYuMHMBw8
Gateway       /ip4/127.0.0.1/tcp/9090
API           /ip4/127.0.0.1/tcp/5002

Web UI available at http://localhost:5002/webui

Daemon is ready

olizilla added a commit to ipfs/js-ipfs that referenced this issue Sep 27, 2018
- make it easier for people to discover the Web UI
- tidy up inconsistencies across the log lines
- add IPFS to the first line. confirm to new users they started what they expected to.

fixes ipfs/ipfs-webui#815

License: MIT
Signed-off-by: Oli Evans <oli@tableflip.io>
@olizilla olizilla added the status/in-progress In progress label Sep 27, 2018
@olizilla
Copy link
Member Author

PR on js-ipfs here ipfs/js-ipfs#1595
If that's acceptable I'll brush up my Go and PR there too.

alanshaw pushed a commit to ipfs/js-ipfs that referenced this issue Oct 19, 2018
- make it easier for people to discover the Web UI
- tidy up inconsistencies across the log lines
- add IPFS to the first line. confirm to new users they started what they expected to.

fixes ipfs/ipfs-webui#815

License: MIT
Signed-off-by: Oli Evans <oli@tableflip.io>
alanshaw pushed a commit to ipfs/js-ipfs that referenced this issue Oct 19, 2018
- make it easier for people to discover the Web UI
- tidy up inconsistencies across the log lines
- add IPFS to the first line. confirm to new users they started what they expected to.

fixes ipfs/ipfs-webui#815

License: MIT
Signed-off-by: Oli Evans <oli@tableflip.io>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/discussion Topical discussion; usually not changes to codebase status/in-progress In progress
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants