usage

package
v2.0.4 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 3, 2026 License: Apache-2.0 Imports: 3 Imported by: 0

Documentation

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

func PrintUsage

func PrintUsage()

PrintUsage prints Trickster's usage instructions

Example

ExamplePrintUsage tests the output of the PrintUsage() func

appinfo.Version = "test"
PrintUsage()
Output:
Trickster version: test (/), buildInfo:  , goVersion: , copyright: © 2018 The Trickster Authors

Trickster Usage:

 You must provide -version, -config or both -origin-url and -provider.

 Print Version Info:
 trickster -version

 Validating a configuration file:
  trickster -validate-config -config /path/to/file.yaml

 Using a configuration file:
  trickster -config /path/to/file.yaml [-log-level DEBUG|INFO|WARN|ERROR] [-proxy-port 8480] [-metrics-port 8481]

 Using origin-url and provider:
  trickster -origin-url https://example.com -provider reverseproxycache [-log-level DEBUG|INFO|WARN|ERROR] [-proxy-port 8480] [-metrics-port 8481]

------

 Simple HTTP Reverse Proxy Cache listening on 8080:
   trickster -origin-url https://example.com/ -provider reverseproxycache -proxy-port 8080

 Simple Prometheus Accelerator listening on 9090 (default port) with Debugging:
   trickster -origin-url http://prometheus.example.com:9090/ -provider prometheus -log-level DEBUG

 Simple InfluxDB Accelerator listening on 8086:
   trickster -origin-url http://influxdb.example.com:8086/ -provider influxdb -proxy-port 8086

 Simple ClickHouse Accelerator listening on 8123:
   trickster -origin-url http://clickhouse.example.com:8123/ -provider clickhouse -proxy-port 8123

------

Trickster listens on port 8480 by default. Set in a config file, or override using -proxy-port.

Default log level is INFO. Set in a config file, or override with -log-level.

The configuration file is much more robust than the command line arguments, and the example file
is well-documented. We also have docker images on DockerHub, as well as Kubernetes in our GitHub
repository, Charts on Helm Hub, and standalone binaries on our GitHub releases page.

Thank you for using and contributing to Open Source Software!

https://github.com/trickstercache/trickster

func PrintVersion

func PrintVersion()

PrintVersion prints Trickster's Version

Example

ExamplePrintVersion tests the output of the PrintVersion() func

appinfo.Version = "test"
PrintVersion()
Output:
Trickster version: test (/), buildInfo:  , goVersion: , copyright: © 2018 The Trickster Authors

Types

This section is empty.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL