Pedestal is a set of libraries written in Clojure that aims to bring both the language and its principles (Simplicity, Power and Focus) to server-side development.
Pedestal requires Java 1.8+ and Servlet 3.1
Getting the Latest Release
[io.pedestal/pedestal.service "0.5.4"] [io.pedestal/pedestal.service-tools "0.5.4"] ;; Only needed for ns-watching; WAR tooling [io.pedestal/pedestal.jetty "0.5.4"] [io.pedestal/pedestal.immutant "0.5.4"] [io.pedestal/pedestal.tomcat "0.5.4"] [io.pedestal/pedestal.aws "0.5.4"] ;; API-Gateway, Lambda, and X-Ray support
You can also use Pedestal's internal modules standalone
[io.pedestal/pedestal.log "0.5.4"] ;; Logging and runtime metrics [io.pedestal/pedestal.interceptor "0.5.4"] ;; The Interceptor chain and the Interceptor API [io.pedestal/pedestal.route "0.5.4"] ;; Efficient routing algorithms and data structures
Please see our Releases for version details, updates, and necessary migration steps.
- Fast and secure by default (automatically uses secure headers, CSRF-protection, and other best practices)
- A guiding principle of "data > functions > macros" - the core pieces of Pedestal are data-driven and programmed against protocols. The entire platform is extensible.
- A high-performance prefix-tree router
that is significantly faster and more space efficient than other Clojure web routers
- When avoiding wildcard and param-routes, the router will be O(log32 N), otherwise O(log N), for the number of routes
- The ability to plug-in any router, including one you write
- The ability to express routes in any format you like
- Full/true async support (Async Servlet + core.async + NIO), resulting in better performance and capacity than a synchronous-only solution
- Advanced error handling for async systems
- Integrated streaming capabilities like Server-sent events
- Integrated support for Cross-origin resource sharing/CORS
- Integrated support for content negotiation
- Integrated linking and testing tools
- Integrated logging and runtime metrics (which can be published to JMX, StatsD, Cloudwatch, and more)
- Integrated tracing with support for Open-Tracing, Jaeger, AWS X-Ray, and more.
- A fundamentally simple system (absolutely everything is an interceptor; interceptors compose)
- The ability to utilize Java Web technology directly in your service (Pedestal can integrate ServletFilters)
- The ability to utilize Ring Middleware as Pedestal Interceptors
- Support to run on Jetty, Immutant/Undertow, and Tomcat
- The ability to run Pedestal services on non-Servlet containers (Vert.x, nginx, Netty, etc.)
- HTTP/2, HTTP/2 Cleartext, and ALPN support
- WebSocket support
- Docker and OSv support
- and more!
Starting a new project
# To create a new service: lein new pedestal-service the-next-big-server-side-thing
- Getting started tutorial and other guides
- Main concepts
- Advanced usage
- API docs
- Reference docs
Our primary focus for the near future is Pedestal documentation, sample applications and improving general ease of use.
Pedestal's roadmap gets captured within the GitHub issues.
- Pedestal documentation
- Older docs are coupled within this repository - some may be outdated.
- The latest API Docs.
- Build your own API docs with
lein sub install; lein docs
At present Pedestal supports OSX and Linux environments. At this time we do not support using Pedestal on a Windows environment.
Some good news: We will still gladly accept pull requests extending our Windows support
The bad news: We will not invest significant amounts of time into diagnosing or correcting Windows issues.
Find out more
Looking for Pedestal App?
- Pedestal App now lives in its own github repo.
- Please see the community announcement discontinuing "App" for more details.
See CONTRIBUTING.md for details on contributing to Pedestal.
To install Pedestal library components in your local Maven repository run
lein sub install from a local checkout of this repository.
Running the tests
After installing all the library components, you can run the tests with
lein sub test from a local checkout of this repository. The majority of the
tests are in the service directory
Copyright 2013 Relevance, Inc.
Copyright 2014-2017 Cognitect, Inc.
The use and distribution terms for this software are covered by the Eclipse Public License 1.0 (http://opensource.org/licenses/eclipse-1.0) which can be found in the file epl-v10.html at the root of this distribution.
By using this software in any fashion, you are agreeing to be bound by the terms of this license.
You must not remove this notice, or any other, from this software.