Commit Graph

205 Commits

Author SHA1 Message Date
DrPsychick
8fb0d7a7fa docs: add link to Athens as-a Service on K8s (#2086) 2026-01-26 22:39:19 +01:00
Omar Trigui
d2bf84a45d fix(storage.md): correct redis endpoint format (#2082)
## Fix Redis URL typo in documentation

Removed duplicate port number in Redis configuration example.
2025-12-03 04:46:43 +02:00
DrPsychick
4205b65df4 feat: build docs and publish to GitHub pages (#2067)
* try: build docs

* try: build docs

* try: publish

* try: verify publishing works on fork

* try: verify publishing works on fork

* try: publish pages using actions/deploy-pages

* try: publish pages using actions/deploy-pages

* try: publish pages using actions/deploy-pages

* try: publish pages using actions/deploy-pages

* feat: build docs and deploy to GitHub pages

* fix: run on PRs for main

* try: baseURL with custom domain

* try: baseURL with custom domain

* fix: revert baseURL with custom domain, it works.
2025-09-21 19:54:59 +02:00
Shantanu Gadgil
59253bd64d Update shared-team-instance.md (#2057) 2025-07-19 14:45:10 +02:00
Gerdriaan Mulder
5d36140c5c docfix: use GONOSUMDB on Athens' home page (#2056) 2025-07-19 14:41:09 +02:00
Siyovush
1ac9228759 Update shared-team-instance.md (#2032) 2025-02-18 13:55:37 +01:00
day253
04e425642e add utf8 charset meta to the proxy home (#2017) 2025-01-07 23:54:42 +01:00
opalmer
3ba08f64f0 Support using redis urls to construct the redis client (#1994)
Currently Athens only supports connecting to Redis using a hostname:port combination in addition to a password. While this works in most cases it also means that if you have other options you wish to supply Athens has to be updated to support them. As a basic example Redis clusters that require TLS currently are not supported by Athens but with this change you can simply supply a [redis url](https://github.com/redis/redis-specifications/blob/master/uri/redis.txt) to connect over TLS. It also makes it easy to override the password, set a username and more all from a single configuration option:

`rediss://username:password@redis.example.com:6379/1?protocol=3`
2024-10-22 13:33:03 -07:00
Nicholas Wiersma
71119f8fcf feat: support GitHub App authentication (#1988)
Adds support for using GitHub Apps as a form of authentication
2024-10-21 18:14:34 +00:00
Radon Rosborough
74b3cf5082 Document log level format (#1982)
Specify log levels that can be configured with Athens explicitly in the documentation.
2024-09-30 12:23:00 +02:00
sb464f
86c8a4fc4c Fix helm install command in docs (#1981) 2024-08-27 16:10:04 +02:00
yueluhuan
1e39c23d72 Add aad auth option when using azure storage account (#1973)
Support managed identity authentication in Azure Blob Storage.
2024-07-14 18:21:31 -07:00
Derek Buitenhuis
0ef761cc8b gcp/saver: Only return errors.KindAlreadyExists if all three exist (#1957)
* gcp/saver: Only return errors.KindAlreadyExists if all three exist

In #1124, a GCP lock type was added as a singleflight backend. As part of this work, the GCP backend's Save() was made serial, likely because moduploader.Upload requires a call to Exists() before it, rendering the GCP lock less useful, by doubling the calls to GCS.

However, by doing this, the existence check was now only checking the existence of the mod file, and not the info or zip. This meant that if during a Save, the zip or info uploads failed, on subsequent rquests, that when using the GCP singleflight backend, Athens would assume everything had been stashed and saved properly, and then fail to serve up the info or zip that had failed upload, meaning the cache was in an unhealable broklen state, requiring a manual intervention.

To fix this, without breaking the singleflight behavior, introduce a metadata key that is set on the mod file during its initial upload, indicating that a Stash is still in progress on subsequent files, which gets removed once all three files are uploaded successfully, which can be checked if it it is determined that the mod file already exists. That way we can return a errors.KindAlreadyExists if a Stash is in progress, but also properly return it when a Stash is *not* currently in progress if and only if all three files exist on GCS, which prevents the cache from becoming permanently poisoned.

One note is that it is possible the GCS call to remove the metadata key fails, which would mean it is left on the mod object forever. To avoid this, consider it stale after 2 minutes.

---------

Signed-off-by: Derek Buitenhuis <derek.buitenhuis@gmail.com>
Co-authored-by: Matt <matt.ouille@protonmail.com>
2024-06-02 19:32:54 +00:00
Matt
c35b50f2f3 Docs overhaul (#1954)
Hugo is upgraded to a modern version, the reboot of the original theme is used, and links are replaced or removed. The readme is updated to state our utility in the first sentence. References to vGo and other old terminology has been moved to "modules" and more modern terminology.
2024-04-23 08:15:36 +02:00
Matt
78daa574e9 Add logging configuration docs (#1952)
We should do our best to disambiguate CloudRuntime and logging parameters.
2024-04-21 11:29:42 -07:00
Matt
359c119441 Add an introduction page as the home page (#1945)
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 env

Of course, this won't work on all installations - especially enterprise ones. For that, we've introduced ATHENS_HOME_TEMPLATE_PATH as an environment variable along with HomeTemplatePath in the config. This value defaults to /var/lib/athens/home.html but 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.
2024-04-20 00:19:34 -07:00
Chris Kuehl
3f3fb9b758 Fix Markdown link in Storage docs (#1922)
Fix incorrectly formatted Markdown link in storage docs.
2024-03-19 17:38:40 -07:00
Darryl Blake
a340d6d81e chore: fix broken links to 'absolutely everybody' blog post (#1914) 2024-02-07 11:23:11 +02:00
Jerry Ng
8e1581e10b docs: update hugo-theme-learn version to latest master (#1871)
* docs: reclone hugo theme learn repo

* docs: move athens custom html to hugo custom layout dir

* docs: update HUGO_VERSION to 0.72.0
2023-05-10 08:05:58 +08:00
Aaron Schlesinger
9359ab996b doc: Fixing pacmod command (#1583) 2023-05-07 19:13:06 +02:00
DrPsychick
ac35a44e5a feat: new home for athens chart (#1845) 2023-03-14 07:08:18 +02:00
Nicholas Wiersma
96f7cb8975 feat: add non-root user to docker image (#1843) 2023-03-08 20:13:01 -08:00
Ashish Ranjan
cc496afbf1 read redis lock options from config to support custom TTL & timeout (#1791)
* read redis lock options from config to support custom TTL & timeout

* fix test

* fix typo

* downgrade to bsm/redislock@v0.7.2 to prevent usage of beta go-redis version

* revert test changes

* return error for invalid lock config

* update config parsing test

* udpate docs to include redis lock config

* fix test

* set default max retries to 10

* reduce default redis lock timeout to 15s

* update default TTL to 15mins

Co-authored-by: Manu Gupta <manugupt1@gmail.com>
2022-09-28 22:53:06 -07:00
Steve Coffman
7fc5e15447 Update Cloud Run per #1571 (#1751)
see https://github.com/gomods/athens/issues/1571#issuecomment-599221107
2022-01-18 15:43:09 -05:00
Alex
6da5568081 a new way to pre-fill disk storage (#1747)
* a new way to pre-fill disk storage
* changed a headline to a bold'ed text
2021-12-22 13:46:16 -08:00
Rob Lee
567c939ac4 Finish Removing golint (#1746)
* Set GO111MODULE to auto in golint script– #1743

As mentioned in #1743 the Go modules environment flag is set to `off`
in the script which appears to cause a warning message for each module
of the codebase that it is "not in GOROOT".

Set to `auto` as this allows the same build to be run the original way
should someone choose to delete the `go.mod` file from the project root.

* Remove redundant code – golint script

Go 1.17 ignores `GO111MODULE` and there are no directories in the
project root called `mock`.

* Replace `golint` with `go vet`

`golint` is deprecated (and frozen) replace with the current `go vet`.
This reported one issue on `main` branch:
```pkg/stash/with_etcd.go:33:28:
loop variable ep captured by func literal```

Fixed loop variable capture with extraction to parameterised anonymous
function passed loop variable and passed in to `errgroup.Go` call.

* Finish Removing `golint`

Removed remaining references to `golint` in dev doc, Makefile,
bash scripts, and powershell build scripts.
Removed `get_dev_tools.sh` and `get_dev_tools.ps1` as they only install
the removed `golint` package.
2021-12-11 11:09:03 -05:00
Manu Gupta
898673c600 Deprecate bzr as it is unmaintained. (#1742)
Alpine moved bzr to unmaintained status. See
https://gitlab.alpinelinux.org/alpine/abuild/-/issues/10000
2021-12-04 22:46:27 -05:00
Aaron Schlesinger
0c78ebd630 Removing the known limitations file (#1710)
As @thomasf pointed out, these limitations no longer apply

Fixes #1709
2021-04-06 11:26:48 -07:00
Nick Anderson
a4046cc890 docs: AWS Fargate (ECS) details (#1708) 2021-03-28 09:49:08 -04:00
Trenton Broughton
7152434457 Fix broken link to docker hub (#1674) 2020-10-27 12:14:31 -04:00
Chris Mills
ae69e1f57d Fix 404s within documentation (#1644)
Signed-off-by: Chris Mills <millscj01@gmail.com>
2020-06-29 19:38:05 +01:00
WillAbides
40ef226d3c Replace limit with pagesize in docs for catalog endpoint (#1641)
Co-authored-by: Marwan Sulaiman <marwan.sameer@gmail.com>
2020-06-29 09:26:54 -04:00
Timo Reitz
29a710920d Fix link in deprecation note. (#1642)
Co-authored-by: Timo Reitz <timo.reitz@4com.de>
2020-06-29 09:44:04 +01:00
Rustam Zagirov
8eebda309b fix typo in docs (#1629) 2020-06-16 08:21:08 -04:00
Aaron Schlesinger
c2c5daf61a Switching to using the main default branch (#1628)
* Switching to using the main default branch

* changing links to main branch, not master branch

* Changing a few links to relative

* Bumping chart version

Co-authored-by: Marwan Sulaiman <marwan.sameer@gmail.com>
2020-06-15 16:44:37 -04:00
Bradley
df9728ecd5 docs: typo for ATHENS_DOWNLOAD_MODE custom (#1605) 2020-04-20 09:26:58 -04:00
Marwan Sulaiman
3c4db4ce86 pkg/storage: add External implementation (#1587)
* pkg/storage: add External implementation

* fix conflicts

* use newly instantiated client
2020-03-27 13:35:52 -04:00
Ted Wexler
939e695526 Adds redis sentinel support (#1554)
* Adds redis sentinel support

Fixes #1553

* Fix redis-sentinel test hostnames

* Fix redis master name again

* Fix redis sentinel port in tests

* Upgrade the redis client

* Rmoeve accidental config change

* Fix default config

* Addresses review comments

* Add documentation on single flight mechanisms

* Fix spelling issues

* Fix formatting

Co-authored-by: Aaron Schlesinger <70865+arschles@users.noreply.github.com>
2020-03-17 13:04:37 -07:00
Dylan Meeus
33384411dd update version info in google-cloud-run docs (#1573)
* update version info in google-cloud-run docs

* Update docs/content/install/install-on-google-cloud-run.md

Co-Authored-By: Marwan Sulaiman <marwan.sameer@gmail.com>

Co-authored-by: Marwan Sulaiman <marwan.sameer@gmail.com>
2020-03-16 15:43:35 -07:00
Aaron Schlesinger
e42546a2b0 Adding "Powered by Netlify" text (#1563) 2020-03-04 09:54:15 +00:00
Aaron Schlesinger
9624953236 Updating the sum database documentation (#1494)
* Updating the sum database documentation
2020-02-21 14:25:07 -08:00
Aaron Schlesinger
ed703ee63d Adding docs for setting the GONOSUMDB env var on the Athens side (#1504)
* Adding docs for setting the GONOSUMDB env var on the Athens side

Ref https://github.com/gomods/athens/issues/1363

* Updating with multiple repos, and adding a note

* Update docs/content/configuration/sumdb.md

Co-Authored-By: Ted Wexler <ted@stuckinacan.com>

* Qualifying "user"

Co-authored-by: Ted Wexler <ted@stuckinacan.com>
2020-02-19 19:52:24 -05:00
Sebastian Heid
d7db2d4f11 Add installation instructions for BOSH (#1535)
* Add installation instructions for BOSH

* Fix weight and add link to try-out document

Co-authored-by: Aaron Schlesinger <70865+arschles@users.noreply.github.com>
2020-02-19 16:39:12 -08:00
vapod
4530a58359 Add forcepathstyle config for s3 (#1533)
* Add forcepathstyle config for s3

* Bump chart version

* Fix typos in s3 config struct
2020-02-10 16:03:25 -08:00
Zhongpeng Lin
b456c5c189 Escaping underscore (#1516)
Co-authored-by: Rob j Loranger <dev@loranger.xyz>
2020-01-19 16:58:22 -08:00
Michael D Henderson
1345d1f9a6 fix typo in Atlassian name (#1515)
Co-authored-by: Rob j Loranger <dev@loranger.xyz>
2020-01-19 15:36:13 -08:00
Ted Wexler
24f10b8a25 Adds detailed docker usage instructions (#1527)
* Adds detailed docker usage instructions

* Fixes a couple of typos

* Add link to release image description

* Describe the canary tag
2020-01-19 15:12:48 -05:00
Aaron Schlesinger
15733395eb Fixing filter link (#1524) 2020-01-13 13:53:47 -08:00
Aaron Schlesinger
3edd242848 Revamping the download mode file (#1508)
Also doing a few things in the process:

- Deprecating the documentation that references the filter file
- Changing the order of the configuration documentation to put the deprecated documents at the bottom of the config section
- Adding a note to the disk storage documentation about pre-filling the disk cache

Fixes https://github.com/gomods/athens/issues/1501
2020-01-13 13:28:59 -08:00
Aaron Schlesinger
be84140e6a Adding a "next step" button to our contributing pages (#1486)
* Adding a "next step" button to our contributing pages

Fixes https://github.com/gomods/athens/issues/1485

* a little more text
2019-12-06 13:48:00 -08:00