Toru is a Go module proxy with caching and rewrite capabilities, built on top of the goproxy/goproxy library.

Toru extends the functionality by adding features such as caching (S3) and configurable rewrite rules for module paths.

• Proxies Go module requests
• Supports caching (S3 and disk)
• Configurable rewrite rules for module paths
• Prometheus-compatible metrics endpoint

You can use the following command to run Toru using Docker:

docker run --rm -p 8888:8888 ghcr.io/mr-karan/toru:latest

Toru supports rewrite rules that allow you to map vanity import paths to their actual repository locations. This feature is particularly useful for organizations that want to use custom import paths for their Go packages.

Consider the following rewrite rule in your config.toml:

[[rewrite_rules]]
vanity_path = "go.corp.com"
target_path = "gitlab.corp.com"

With this rule in place:

1. When a user tries to fetch a package with the import path go.corp.com/awesome-pkg, Toru intercepts this request.
2. Instead of looking for the package at go.corp.com/awesome-pkg, Toru rewrites the request to gitlab.corp.com/awesome-pkg.
3. Toru then fetches the package from the actual repository location at gitlab.corp.com/awesome-pkg.

1. Vanity URLs: You can use a clean, memorable vanity URL for your packages, making it easier for user to import them.
2. Repository abstraction: You can change the underlying repository location without affecting the import paths used by your user.
3. Private repositories: You can use rewrite rules to map public vanity URLs to private repository locations, allowing you to control access to your internal packages.

Toru can be configured using a TOML file and environment variables. Refer to config.sample.toml for reference.

To build the project, use the provided Makefile:

make build
make run

This will build the binary and run it with the default configuration file (config.toml).

Toru exposes Prometheus-compatible metrics at the /metrics endpoint. Available metrics include:

toru_requests_total: Total number of requests
toru_request_duration_seconds: Request duration
toru_upstream_fetch_duration_seconds: Upstream fetch duration
toru_response_size_bytes: Response size
toru_rewrite_rules_applied_total: Number of times rewrite rules were applied
toru_errors_total: Total number of errors encountered

Create or edit the .netrc file in your home directory:

machine gitlab.corp.com
login your-username
password your-access-token

Add this to your .gitconfig

[url "ssh:https://[email protected]"]
	insteadOf = https://gitlab.corp.com

Toru provides support for client-side authentication through authentication modules.

To enable authentication, you can specify the modules in your configuration file:

[auth.modules]
name = "gitlab"
type = "gitlab_access_token"
options.root_url = "https://gitlab.corp.tech"
options.protected_uri = "corp.tech"

By providing the GitLab access token in the basic auth, clients can authenticate with the GitLab API to check if the user has access to the repository.

To authenticate using the access token, use the following command:

export GOPROXY=https://gitlab:<access_token>@toru.corp.io:9443