Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/retracedhq/retraced
🔥 A fully open source audit logs service and embeddable UI easily deployed to your own Kubernetes cluster. Brought to you by replicated.com and boxyhq.com 🚀
https://github.com/retracedhq/retraced
audit-logs enterprise-ready enterprise-software javascript kubernetes security-audit typescript
Last synced: about 2 months ago
JSON representation
🔥 A fully open source audit logs service and embeddable UI easily deployed to your own Kubernetes cluster. Brought to you by replicated.com and boxyhq.com 🚀
- Host: GitHub
- URL: https://github.com/retracedhq/retraced
- Owner: retracedhq
- License: apache-2.0
- Created: 2016-10-04T13:51:18.000Z (almost 8 years ago)
- Default Branch: main
- Last Pushed: 2024-04-27T23:18:16.000Z (5 months ago)
- Last Synced: 2024-04-28T20:45:26.258Z (5 months ago)
- Topics: audit-logs, enterprise-ready, enterprise-software, javascript, kubernetes, security-audit, typescript
- Language: TypeScript
- Homepage: https://boxyhq.com/audit-logs
- Size: 6.86 MB
- Stars: 302
- Watchers: 13
- Forks: 16
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# Retraced Audit Log
Retraced is the easiest way to integrate a compliant audit log into your application.
It provides a searchable, exportable record of read/write events.
Client libraries are available for [Go](https://github.com/retracedhq/retraced-go) and [Javascript](https://github.com/retracedhq/retraced-js).
## Documentation
Please head to [https://boxyhq.com/docs/retraced/overview](https://boxyhq.com/docs/retraced/overview) for detailed documentation on how to get started with Retraced.
- [Step by step tutorial video](https://www.youtube.com/watch?v=4vBxw4kqdwE)
## Usage
### Running with docker-compose
> `docker-compose up -d` or `npm run dev`
**Note:** `ADMIN_ROOT_TOKEN` has been set to `dev` so you can test the setup locally. Please remember to change this (and other relevant sensitive env vars/secrets) in production.
### Run an example to see how Retraced works
Git checkout the Logs Viewer [repo](https://github.com/retracedhq/logs-viewer) and run `npm i` followed by `npm run dev` to start an example which uses Retraced to show you some auto generated events. Refresh the UI a few times for the auto-generated audit logs to kick in. You can also ingest a few custom logs using the following curl command:-
```sh
curl -X POST -H "Content-Type: application/json" -H "Authorization: token=dev" -d '{
"action": "some.record.created",
"teamId": "boxyhq",
"group": {
"id": "dev",
"name": "dev"
},
"crud": "c",
"created": "2023-01-16T15:48:44.573Z",
"source_ip": "127.0.0.1",
"actor": {
"id": "[email protected]",
"name": "Jackson"
},
"target": {
"id": "100",
"name": "tasks",
"type": "Tasks"
}
}' http://localhost:3000/auditlog/publisher/v1/project/dev/event
```
You can also use the [Admin Portal](http://localhost:5225) but will need to setup the SMTP env vars so that you can use the magic link to log into the Portal, we are working to support other forms of authentication and would love to hear which provider you'd like supported next.
### Running with Skaffold
You could alternatively use Skaffold instead of docker-compose to run Retraced locally.
> `npm run run:skaffold` or `skaffold run -f skaffold-dev.yaml --status-check=false --force=true`
## Swagger Documentation
Swagger spec is generated from source using [TSOA](https://github.com/lukeautry/tsoa)
By default, a swagger spec is built as part of `npm run build`, and is served by express at `/publisher/v1/swagger.json`.
#### Generating a spec
To generate swagger.json from Typescript sources use
```sh
npm run swagger
```
The outputs will be written to build/swagger.json
## Contributing
Thanks for taking the time to contribute! Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make will benefit everybody else and are appreciated.
Please try to create bug reports that are:
- _Reproducible._ Include steps to reproduce the problem.
- _Specific._ Include as much detail as possible: which version, what environment, etc.
- _Unique._ Do not duplicate existing opened issues.
- _Scoped to a Single Bug._ One bug per report.
## Support
Reach out to the maintainers at one of the following places:
- [GitHub Issues](https://github.com/retracedhq/retraced/issues) (Bug reports, Contributions)
## Community
- [Discord](https://discord.gg/uyb7pYt4Pa) (For live discussion with the Community and BoxyHQ team)
- [Twitter](https://twitter.com/BoxyHQ) (Get the news fast)