@@ -30,6 +30,11 @@ For more information check out the
3030
3131## Usage
3232
33+ 💡 _ Setting up ` axiom-syslog-proxy ` for secure syslog? Think about using
34+ [ an endpoint] ( https://axiom.co/docs/endpoints/introduction ) ! You can create one
35+ by visiting
36+ [ the Axiom endpoint settings] ( https://app.axiom.co/vercel-pbue/settings/endpoints ) ._
37+
3338There are multiple ways you can install the Axiom Syslog Proxy:
3439
3540- With Homebrew: ` brew install axiomhq/tap/axiom-syslog-proxy `
@@ -43,9 +48,16 @@ There are multiple ways you can install the Axiom Syslog Proxy:
4348If you use the [ Axiom CLI] ( https://github.com/axiomhq/cli ) , run
4449` eval $(axiom config export -f) ` to configure your environment variables.
4550
46- Otherwise create a personal token in [ the Axiom settings] ( https://app.axiom.co/profile )
47- and export it as ` AXIOM_TOKEN ` . Set ` AXIOM_ORG_ID ` to the organization ID from
48- the settings page of the organization you want to access.
51+ Otherwise create an api token with the appropriate scopes in
52+ [ the Axiom API tokens settings] ( https://app.axiom.co/settings/api-tokens ) and
53+ export it as ` AXIOM_TOKEN ` .
54+
55+ When using a personal token, export it as ` AXIOM_TOKEN ` and set ` AXIOM_ORG_ID `
56+ to the organization ID from the settings page of the organization you want to
57+ access.
58+
59+ _ ❗ We recommend to follow security best-practices and use an ** api token with
60+ minimal privileges** , only!_
4961
5062Export the dataset name to ingest into as ` AXIOM_DATASET ` . The dataset must
5163exist prior to ingesting data into it.
0 commit comments