Skip to content

Adding a getit script for easier Docker files download - #93

Closed
vcampitelli wants to merge 3 commits into
FusionAuth:masterfrom
vcampitelli:master
Closed

vcampitelli wants to merge 3 commits into
FusionAuth:masterfrom
vcampitelli:master

Conversation

@vcampitelli

@vcampitelli vcampitelli commented Sep 5, 2023 •

Copy link
Copy Markdown
Contributor

Description

This adds a getit script to simplify downloading Docker files to start an instance. Instead of running:

curl -o docker-compose.yml https://raw.githubusercontent.com/FusionAuth/fusionauth-containers/master/docker/fusionauth/docker-compose.yml
curl -o .env https://raw.githubusercontent.com/FusionAuth/fusionauth-containers/master/docker/fusionauth/.env

One would only need to do:

curl -s https://fusionauth.io/getit | sh -s -- --download

Secondary scenario

I know we only have to download those 2 files right now, but we've been copying them into every quickstart demo app. So if we'd ever want to update those files, we'd have to replace them in every single repo. In this scenario, we'd just need to add a step to the quickstart article with the command below to download files with Kickstart settings:

curl -s https://fusionauth.io/getit | sh -s -- --download-kickstart         

Screenshot

This is how it looks like:

Usage sample

Redirect

@mooreds said we could add this a redirect script to our website to have it on fusionauth.io/getit. Can we do that?


@vcampitelli
vcampitelli requested a review from a team as a code owner September 5, 2023 21:06
@robotdan

robotdan commented Sep 6, 2023 •

Copy link
Copy Markdown
Contributor

I like this idea in theory.

Some thoughts:

  • It is less transparent than what we have today. What we are asking the user to download is now opaque.
  • It now requires a managed redirect that is not managed in GitHub along with the other source code.
    • If we want a short URL, we could use a common online URL shortener. I know it isn't as cool as using our own domain.
  • There isn't anything in the URL that would indicate I'm downloading a Docker compose configuration.
    • curl -s https://fusionauth.io/getit | sh - seems like the arg should be --docker-compose or something like that?
  • It seems code like this should belong in fusionauth-install? It could then cover all install use cases, not just for Docker compose. I would not generally not think to look for download scripts in fusionauth-container.

@mooreds

mooreds commented Sep 6, 2023 •

Copy link
Copy Markdown
Contributor

It is less transparent than what we have today. What we are asking the user to download is now opaque.

I like the idea of telling people to review the shell script. We used to have that messaging on the download pages. (Here's a install script, but please feel free to read the script before executing it.)

It now requires a managed redirect that is not managed in GitHub along with the other source code.

It is managed under fusionauth-site (or is planned to be).

It seems code like this should belong in fusionauth-install?

Ooh, that's a good call. I told @vcampitelli that it should go here, but I like fusionauth-install better. I do want to make sure this isn't ballooning in scope, so I'd recommend keeping it to a docker install for now.

@lyleschemmerling

Copy link
Copy Markdown
Contributor

I like the idea of telling people to review the shell script

I sort of assume people don't read, especially shell, though I don't think it hurts to say they should. With the colors and stuff it is a little less legible than ideal for that, so I think we should be hyper verbose in the script's help doc as that is the thing most people will interact with

@lyleschemmerling lyleschemmerling left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

approve of the script with more words in the help. No notes or where it should live or get hosted

Comment thread docker/fusionauth/getit Outdated
@vcampitelli

Copy link
Copy Markdown
Contributor Author

Moved this to FusionAuth/fusionauth-install#13

@vcampitelli vcampitelli closed this Mar 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants