Skip to content

Commit 33a1a18

Browse files
committed
chore: code grooming
1 parent c99ee8b commit 33a1a18

File tree

2 files changed

+16
-5
lines changed

2 files changed

+16
-5
lines changed

.goreleaser.yaml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,6 @@ builds:
7676
archives:
7777
- <<: &archive_defaults
7878
name_template: "{{ .ProjectName }}_{{ .Version }}_{{ .Os }}_{{ .Arch }}{{ if .Arm }}v{{ .Arm }}{{ end }}"
79-
rlcp: true
8079
id: nix
8180
builds:
8281
- darwin
@@ -125,7 +124,7 @@ brews:
125124
description: Syslog ingestion by proxy for Axiom
126125
homepage: https://axiom.co
127126
license: MIT
128-
tap:
127+
repository:
129128
owner: axiomhq
130129
name: homebrew-tap
131130
token: "{{ .Env.HOMEBREW_TOKEN }}"

README.md

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -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+
3338
There 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:
4348
If 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

5062
Export the dataset name to ingest into as `AXIOM_DATASET`. The dataset must
5163
exist prior to ingesting data into it.

0 commit comments

Comments
 (0)