|
1 | 1 | 
|
2 | 2 | 
|
3 | 3 |
|
4 |
| -<div align="center"> |
| 4 | +# Axiom Syslog Proxy |
5 | 5 |
|
6 |
| -[![Documentation][docs_badge]][docs] |
7 |
| -[![Go Workflow][workflow_badge]][workflow] |
8 |
| -[![Latest Release][release_badge]][release] |
9 |
| -[![License][license_badge]][license] |
| 6 | +The Axiom Syslog Proxy acts as a syslog server to send data to Axiom. |
10 | 7 |
|
11 |
| -</div> |
| 8 | +## Documentation |
12 | 9 |
|
13 |
| -[Axiom](https://axiom.co) unlocks observability at any scale. |
14 |
| - |
15 |
| -- **Ingest with ease, store without limits:** Axiom's next-generation datastore |
16 |
| - enables ingesting petabytes of data with ultimate efficiency. Ship logs from |
17 |
| - Kubernetes, AWS, Azure, Google Cloud, DigitalOcean, Nomad, and others. |
18 |
| -- **Query everything, all the time:** Whether DevOps, SecOps, or EverythingOps, |
19 |
| - query all your data no matter its age. No provisioning, no moving data from |
20 |
| - cold/archive to "hot", and no worrying about slow queries. All your data, all. |
21 |
| - the. time. |
22 |
| -- **Powerful dashboards, for continuous observability:** Build dashboards to |
23 |
| - collect related queries and present information that's quick and easy to |
24 |
| - digest for you and your team. Dashboards can be kept private or shared with |
25 |
| - others, and are the perfect way to bring together data from different sources. |
26 |
| - |
27 |
| -For more information check out the |
28 |
| -[official documentation](https://axiom.co/docs) and our |
29 |
| -[community Discord](https://axiom.co/discord). |
30 |
| - |
31 |
| -## Usage |
32 |
| - |
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 |
| - |
38 |
| -There are multiple ways you can install the Axiom Syslog Proxy: |
39 |
| - |
40 |
| -- With Homebrew: `brew install axiomhq/tap/axiom-syslog-proxy` |
41 |
| -- Download the pre-built binary from the |
42 |
| - [GitHub Releases](https://github.com/axiomhq/axiom-syslog-proxy/releases/latest) |
43 |
| -- Using Go: `go install github.com/axiomhq/axiom-syslog-proxy/cmd/axiom-syslog-proxy@latest` |
44 |
| -- Use the [Docker image](https://hub.docker.com/r/axiomhq/axiom-syslog-proxy): `docker run axiomhq/axiom-syslog-proxy` |
45 |
| - |
46 |
| -### Configuration |
47 |
| - |
48 |
| -If you use the [Axiom CLI](https://github.com/axiomhq/cli), run |
49 |
| -`eval $(axiom config export -f)` to configure your environment variables. |
50 |
| - |
51 |
| -Otherwise create an API token with the appropriate scopes in |
52 |
| -[the Axiom API token settings](https://app.axiom.co/settings/api-tokens) and |
53 |
| -export it as `AXIOM_TOKEN`. |
54 |
| - |
55 |
| -Export the dataset name to ingest into as `AXIOM_DATASET`. The dataset must |
56 |
| -exist prior to ingesting data into it. |
57 |
| - |
58 |
| -## License |
59 |
| - |
60 |
| -Distributed under the [MIT License](./LICENSE). |
61 |
| - |
62 |
| -<!-- Badges --> |
63 |
| - |
64 |
| -[docs]: https://docs.axiom.co |
65 |
| -[docs_badge]: https://img.shields.io/badge/docs-reference-blue.svg |
66 |
| -[workflow]: https://github.com/axiomhq/axiom-syslog-proxy/actions/workflows/push.yaml |
67 |
| -[workflow_badge]: https://img.shields.io/github/actions/workflow/status/axiomhq/axiom-syslog-proxy/push.yaml?branch=main&ghcache=unused |
68 |
| -[release]: https://github.com/axiomhq/axiom-syslog-proxy/releases/latest |
69 |
| -[release_badge]: https://img.shields.io/github/release/axiomhq/axiom-syslog-proxy.svg |
70 |
| -[license]: https://opensource.org/licenses/MIT |
71 |
| -[license_badge]: https://img.shields.io/github/license/axiomhq/axiom-syslog-proxy.svg?color=blue |
| 10 | +For more information on how to set up and use the Axiom Syslog Proxy, see the [Axiom documentation](https://axiom.co/docs/send-data/syslog-proxy). |
0 commit comments