-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Create minimal readme linking to main docs
- Loading branch information
Showing
1 changed file
with
4 additions
and
65 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,71 +1,10 @@ | ||
![axiom-syslog-proxy: Syslog ingestion by proxy for Axiom](.github/images/banner-dark.svg#gh-dark-mode-only) | ||
![axiom-syslog-proxy: Syslog ingestion by proxy for Axiom](.github/images/banner-light.svg#gh-light-mode-only) | ||
|
||
<div align="center"> | ||
# Axiom Syslog Proxy | ||
|
||
[![Documentation][docs_badge]][docs] | ||
[![Go Workflow][workflow_badge]][workflow] | ||
[![Latest Release][release_badge]][release] | ||
[![License][license_badge]][license] | ||
The Axiom Syslog Proxy acts as a syslog server to send data to Axiom. | ||
|
||
</div> | ||
## Documentation | ||
|
||
[Axiom](https://axiom.co) unlocks observability at any scale. | ||
|
||
- **Ingest with ease, store without limits:** Axiom's next-generation datastore | ||
enables ingesting petabytes of data with ultimate efficiency. Ship logs from | ||
Kubernetes, AWS, Azure, Google Cloud, DigitalOcean, Nomad, and others. | ||
- **Query everything, all the time:** Whether DevOps, SecOps, or EverythingOps, | ||
query all your data no matter its age. No provisioning, no moving data from | ||
cold/archive to "hot", and no worrying about slow queries. All your data, all. | ||
the. time. | ||
- **Powerful dashboards, for continuous observability:** Build dashboards to | ||
collect related queries and present information that's quick and easy to | ||
digest for you and your team. Dashboards can be kept private or shared with | ||
others, and are the perfect way to bring together data from different sources. | ||
|
||
For more information check out the | ||
[official documentation](https://axiom.co/docs) and our | ||
[community Discord](https://axiom.co/discord). | ||
|
||
## Usage | ||
|
||
💡 _Setting up `axiom-syslog-proxy` for secure syslog? Think about using | ||
[an endpoint](https://axiom.co/docs/endpoints/introduction)! You can create one | ||
by visiting | ||
[the Axiom endpoint settings](https://app.axiom.co/vercel-pbue/settings/endpoints)._ | ||
|
||
There are multiple ways you can install the Axiom Syslog Proxy: | ||
|
||
- With Homebrew: `brew install axiomhq/tap/axiom-syslog-proxy` | ||
- Download the pre-built binary from the | ||
[GitHub Releases](https://github.com/axiomhq/axiom-syslog-proxy/releases/latest) | ||
- Using Go: `go install github.com/axiomhq/axiom-syslog-proxy/cmd/axiom-syslog-proxy@latest` | ||
- Use the [Docker image](https://hub.docker.com/r/axiomhq/axiom-syslog-proxy): `docker run axiomhq/axiom-syslog-proxy` | ||
|
||
### Configuration | ||
|
||
If you use the [Axiom CLI](https://github.com/axiomhq/cli), run | ||
`eval $(axiom config export -f)` to configure your environment variables. | ||
|
||
Otherwise create an API token with the appropriate scopes in | ||
[the Axiom API token settings](https://app.axiom.co/settings/api-tokens) and | ||
export it as `AXIOM_TOKEN`. | ||
|
||
Export the dataset name to ingest into as `AXIOM_DATASET`. The dataset must | ||
exist prior to ingesting data into it. | ||
|
||
## License | ||
|
||
Distributed under the [MIT License](./LICENSE). | ||
|
||
<!-- Badges --> | ||
|
||
[docs]: https://docs.axiom.co | ||
[docs_badge]: https://img.shields.io/badge/docs-reference-blue.svg | ||
[workflow]: https://github.com/axiomhq/axiom-syslog-proxy/actions/workflows/push.yaml | ||
[workflow_badge]: https://img.shields.io/github/actions/workflow/status/axiomhq/axiom-syslog-proxy/push.yaml?branch=main&ghcache=unused | ||
[release]: https://github.com/axiomhq/axiom-syslog-proxy/releases/latest | ||
[release_badge]: https://img.shields.io/github/release/axiomhq/axiom-syslog-proxy.svg | ||
[license]: https://opensource.org/licenses/MIT | ||
[license_badge]: https://img.shields.io/github/license/axiomhq/axiom-syslog-proxy.svg?color=blue | ||
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). |