Add an introduction page as the home page #1945
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
nrwiersma
requested changes
Apr 18, 2024
|
@nrwiersma great ideas code wise. What do you think about the concept of the feature though? I have an alternative idea that I also listed here that I'm kind of leaning in the direction of, which is to allow the user to specify their own template and we just load it from disk. |
|
I like the idea here of a fixed one to start, and should people need a customisable, then add the complexity, IMO. |
This is great feedback. I do think I'm going to move it to a file based Go-template the user can swap out, but I'll add something to the container image so that we ship a default one. |
Normalize the homepage test to be like the others. We just want to make sure it results in a 200.
|
@nrwiersma let me know what you think of this. Instead of adding a file to the container image I just kept the default baked in and simplified the logic. |
nrwiersma
reviewed
Apr 20, 2024
Revert linting changes and improve error handling of the template file read
matt0x6F
added
enhancement
nrwiersma
approved these changes
Apr 20, 2024
nrwiersma
approved these changes
Apr 20, 2024
DrPsychick
added a commit
to gomods/athens-charts
that referenced
this pull request
May 2, 2024
[](https://renovatebot.com) This PR contains the following updates: | Package | Update | Change | |---|---|---| | [gomods/athens](https://togithub.com/gomods/athens) | minor | `v0.13.3` -> `v0.14.0` | --- ### Release Notes <details> <summary>gomods/athens (gomods/athens)</summary> ### [`v0.14.0`](https://togithub.com/gomods/athens/releases/tag/v0.14.0) [Compare Source](https://togithub.com/gomods/athens/compare/v0.13.3...v0.14.0) #### What's Changed - update-go-pkg(deps): bump github.com/aws/aws-sdk-go from 1.44.220 to 1.51.21 by [@​dependabot](https://togithub.com/dependabot) in [gomods/athens#1942 - Add an introduction page as the home page by [@​matt0x6F](https://togithub.com/matt0x6F) in [gomods/athens#1945 - build(deps): bump golang.org/x/net from 0.22.0 to 0.23.0 by [@​dependabot](https://togithub.com/dependabot) in [gomods/athens#1946 - Add logging configuration docs by [@​matt0x6F](https://togithub.com/matt0x6F) in [gomods/athens#1952 - Docs overhaul by [@​matt0x6F](https://togithub.com/matt0x6F) in [gomods/athens#1954 - Upgrade to AWS SDK v2 ([#​1938](https://togithub.com/gomods/athens/issues/1938)) by [@​nesangcode](https://togithub.com/nesangcode) in [gomods/athens#1950 - update-github-action(deps): bump golangci/golangci-lint-action from 4 to 5 by [@​dependabot](https://togithub.com/dependabot) in [gomods/athens#1956 - Bump go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc from 0.25.0 to 0.46.0 by [@​dependabot](https://togithub.com/dependabot) in [gomods/athens#1901 - update-go-pkg(deps): bump github.com/unrolled/secure from 0.0.0-20181221173256-0d6b5bb13069 to 1.14.0 by [@​dependabot](https://togithub.com/dependabot) in [gomods/athens#1955 #### New Contributors - [@​nesangcode](https://togithub.com/nesangcode) made their first contribution in [gomods/athens#1950 **Full Changelog**: gomods/athens@v0.13.3...v0.14.0 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/gomods/athens-charts). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4zMzEuMCIsInVwZGF0ZWRJblZlciI6IjM3LjMzMS4wIiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6W119--> --------- Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: DrPsychick <drpsychick@drsick.net>
](https://renovatebot.com){kind=link}
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What is the problem I am trying to address?
The home page of Athens is just "Welcome to The Athens Proxy". While this is cute in an old internet kind of way, it isn't super informative to users of Athens. At my workplace we spent a decent amount of time building messaging for how to configure clients. It would be nice if users could land on the Athens page and know how to configure their clients.
How is the fix applied?
A default homepage is baked into the server that uses the request host address, or in HTTP 2 the authority. This includes ports. It also checks for schema. The values are used to indicate to users how to configure their
go envOf course, this won't work on all installations - especially enterprise ones. For that, I've introduced
ATHENS_HOME_TEMPLATE_PATHas an environment variable along withHomeTemplatePathin the config. This value defaults to/var/lib/athens/home.htmlbut can be configured to any location that Athens can reliably read from. This is a Go HTML template so it should use Go HTML template formatting and logic.What GitHub issue(s) does this PR fix or close?
Closes #1944