Skip to content

docs: document local install.sh script #16125

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

Merged
merged 8 commits into from
Jan 21, 2025
Merged

Conversation

aslilac
Copy link
Member

@aslilac aslilac commented Jan 13, 2025

To be merged once #16064 lands

This neat little addition feels worth documenting!

Copy link
Contributor

@EdwardAngert EdwardAngert left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm trying to find a way to clarify the way both the script and binaries are available, and I'm not sure I've done that, so I suggested some edits, and fully expect that they should be edited further.

Additionally, should we more-strongly recommend that the script be included in templates?

aslilac and others added 3 commits January 15, 2025 14:11
Co-authored-by: Edward Angert <EdwardAngert@users.noreply.github.com>
Co-authored-by: Edward Angert <EdwardAngert@users.noreply.github.com>
Co-authored-by: Edward Angert <EdwardAngert@users.noreply.github.com>
@aslilac
Copy link
Member Author

aslilac commented Jan 15, 2025

Additionally, should we more-strongly recommend that the script be included in templates?

I'm not sure. Probably not immediately. I think it'd be a good idea to dogfood it for a while and then maybe then if it proves to be a good idea we can more strongly recommend it to users.

It's also lacking a good Windows equivalent, and idk how much of an issue that'll be for customers.

@matifali
Copy link
Member

matifali commented Jan 16, 2025

It's also lacking a good Windows equivalent, and idk how much of an issue that'll be for customers.

Many of our users use Windows or macOS devices. So this will be an issue.
We could provide a Windows equivalent install script, too.

iwr https://coder.example.com/install.ps1 | iex

Also, let's include these as part of CLI suggestions when we detect a version mismatch instead of documenting this in docs. E.g.,

version mismatch: client v2.17.0+5a6d23a, server v2.18.2-devel+3a81aac31
- download the server version with: 'curl -L https://coder.com/install.sh | sh -s -- --version 2.18.2-devel'
+ Download the server version with: 'curl -L https://dev.coder.com/install.sh | sh'

And best if we can automagically do that,

version mismatch: client v2.17.0+5a6d23a, server v2.18.2-devel+3a81aac31
- download the server version with: 'curl -L https://coder.com/install.sh | sh -s -- --version 2.18.2-devel'
+ Download the matching version from the server (y/n): y

Note

These are suggestions and not hard requirements, so take them with a grain of salt.

@aslilac
Copy link
Member Author

aslilac commented Jan 21, 2025

providing a windows equivalent and changing the cli are waaaay out of scope for this PR. I'm relatively comfortable writing bash scripts, but powershell is a whole different beast.

@aslilac aslilac merged commit 250f3c7 into main Jan 21, 2025
29 checks passed
@aslilac aslilac deleted the lilac/docs-local-install-script branch January 21, 2025 21:16
@github-actions github-actions bot locked and limited conversation to collaborators Jan 21, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants