https://github.com/puppetlabs/trapperkeeper
A services framework for Clojure / JVM applications.
https://github.com/puppetlabs/trapperkeeper
Last synced: 7 months ago
JSON representation
A services framework for Clojure / JVM applications.
- Host: GitHub
- URL: https://github.com/puppetlabs/trapperkeeper
- Owner: puppetlabs
- License: apache-2.0
- Created: 2013-10-28T23:14:43.000Z (about 12 years ago)
- Default Branch: main
- Last Pushed: 2025-02-04T02:09:53.000Z (10 months ago)
- Last Synced: 2025-04-03T09:05:37.885Z (9 months ago)
- Language: Clojure
- Homepage: https://tickets.puppetlabs.com/browse/TK
- Size: 1.11 MB
- Stars: 587
- Watchers: 184
- Forks: 75
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# Trapperkeeper
[](https://travis-ci.org/puppetlabs/trapperkeeper)
Trapperkeeper is a Clojure framework for hosting long-running applications and services.
You can think of it as a sort of "binder" for Ring applications and other modular bits of Clojure code.
## Installation
Add the following dependency to your `project.clj` file:
[](http://clojars.org/puppetlabs/trapperkeeper)
## Community
* Bug reports and feature requests: you can submit a Github issue, but we use [JIRA](https://tickets.puppetlabs.com/browse/TK) as our main issue tracker.
* freenode: #trapperkeeper
* [](https://gitter.im/puppetlabs/trapperkeeper?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
## Documentation
You can find a quick-start, example code, and lots and lots of documentation in our:
* [Documentation](documentation/Index.md)
## Lein Template
A Leiningen template is available that shows a suggested project structure:
lein new trapperkeeper my.namespace/myproject
Once you've created a project from the template, you can run it via the lein alias:
lein tk
Note that the template is not intended to suggest a specific namespace organization;
it's just intended to show you how to write a service, a web service, and tests
for each.
## Related Projects
Here are some additional projects that provide Trapperkeeper services, and
other related functionality:
* [trapperkeeper-webserver-jetty9](https://github.com/puppetlabs/trapperkeeper-webserver-jetty9): a Jetty9-based webserver for use with TK applications
* [trapperkeeper-rpc](https://github.com/puppetlabs/trapperkeeper-rpc): a TK service that allows you to easily build a way to call remote TK services over RPC
* [trapperkeeper-metrics](https://github.com/puppetlabs/trapperkeeper-metrics): a TK service that manages the life cycle of a [MetricRegistry](https://github.com/dropwizard/metrics), so that all of your TK services can register metrics with a common configuration syntax.
* [trapperkeeper-comidi-metrics](https://github.com/puppetlabs/trapperkeeper-comidi-metrics): a TK utility library that provides middleware to automatically generate metrics for all requests to each of your bidi/comidi HTTP routes.
* [trapperkeeper-status](https://github.com/puppetlabs/trapperkeeper-status): a TK service that provides a mechanism for registering status callbacks for all of your other TK services, and web API for requesting status information about the entire TK system.
* [trapperkeeper-scheduler](https://github.com/puppetlabs/trapperkeeper-scheduler): a TK service that provides an API for scheduling periodic background tasks
## License
Copyright © 2013 Puppet Labs
Distributed under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.html)
## Support
Please log tickets and issues at our [JIRA tracker](https://tickets.puppetlabs.com/browse/TK).
There is also a #trapperkeeper channel on Freenode as well as [](https://gitter.im/puppetlabs/trapperkeeper?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge).