Skip to content

docs: update the quickstart page #16666

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Feb 25, 2025
Merged

docs: update the quickstart page #16666

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bded76f
quickstart: fix web UI address and update setup screenshot
hugodutka Feb 23, 2025
5787987
resize screenshot; intro github auth
EdwardAngert Feb 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file modified docs/images/screenshots/welcome-create-admin-user.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
18 changes: 11 additions & 7 deletions docs/tutorials/quickstart.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,18 +82,22 @@ persistent environment from your main device, a tablet, or your phone.

## Configure Coder with a new Workspace

1. If you're running Coder locally, go to <http://0.0.0.0:3001/setup>.
1. Coder will attempt to open the setup page in your browser. If it doesn't open
automatically, go to <http://localhost:3000>.

- If you get a browser warning similar to `Secure Site Not Available`, you
can ignore the warning and continue to the setup page.

If your Coder server is on a network or cloud device, locate the message in
your terminal that reads,
`View the Web UI: https://<CUSTOM-STRING>.<TUNNEL>.try.coder.app`. The server
begins to stream logs immediately and you might have to scroll up to find it.
If your Coder server is on a network or cloud device, or you are having
trouble viewing the page, locate the web UI URL in Coder logs in your
terminal. It looks like `https://<CUSTOM-STRING>.<TUNNEL>.try.coder.app`.
It's one of the first lines of output, so you might have to scroll up to find
it.

1. On the **Welcome to Coder** page, enter the information to create an admin
user, then select **Create account**.
1. On the **Welcome to Coder** page, to use your GitHub account to log in,
select **Continue with GitHub**.
You can also enter an email and password to create a new admin account on
the Coder deployment:

![Welcome to Coder - Create admin user](../images/screenshots/welcome-create-admin-user.png)_Welcome
to Coder - Create admin user_
Expand Down
Loading