2
0

README.adoc 3.2 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667
  1. image::https://badges.gitter.im/Join%20Chat.svg[Gitter,link=https://gitter.im/spring-projects/spring-security?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge]
  2. image:https://github.com/spring-projects/spring-security/workflows/CI/badge.svg?branch=master["Build Status", link="https://github.com/spring-projects/spring-security/actions?query=workflow%3ACI"]
  3. image:https://img.shields.io/badge/Revved%20up%20by-Gradle%20Enterprise-06A0CE?logo=Gradle&labelColor=02303A["Revved up by Gradle Enterprise", link="https://ge.spring.io/scans?search.rootProjectNames=spring-security"]
  4. = Spring Security
  5. Spring Security provides security services for the https://docs.spring.io[Spring IO Platform]. Spring Security 5.0 requires Spring 5.0 as
  6. a minimum and also requires Java 8.
  7. For a detailed list of features and access to the latest release, please visit https://spring.io/projects[Spring projects].
  8. == Code of Conduct
  9. Please see our https://github.com/spring-projects/.github/blob/master/CODE_OF_CONDUCT.md[code of conduct]
  10. == Downloading Artifacts
  11. See https://docs.spring.io/spring-security/site/docs/current/reference/html5/#getting[Getting Spring Security] for how to obtain Spring Security.
  12. == Documentation
  13. Be sure to read the https://docs.spring.io/spring-security/site/docs/current/reference/htmlsingle/[Spring Security Reference].
  14. Extensive JavaDoc for the Spring Security code is also available in the https://docs.spring.io/spring-security/site/docs/current/api/[Spring Security API Documentation].
  15. == Quick Start
  16. We recommend you visit https://docs.spring.io/spring-security/site/docs/current/reference/htmlsingle/[Spring Security Reference] and read the "Getting Started" page.
  17. == Building from Source
  18. Spring Security uses a https://gradle.org[Gradle]-based build system.
  19. In the instructions below, https://vimeo.com/34436402[`./gradlew`] is invoked from the root of the source tree and serves as
  20. a cross-platform, self-contained bootstrap mechanism for the build.
  21. === Prerequisites
  22. https://help.github.com/set-up-git-redirect[Git] and the https://www.oracle.com/technetwork/java/javase/downloads[JDK11 build].
  23. Be sure that your `JAVA_HOME` environment variable points to the `jdk-11` folder extracted from the JDK download.
  24. === Check out sources
  25. [indent=0]
  26. ----
  27. git clone git@github.com:spring-projects/spring-security.git
  28. ----
  29. === Install all spring-\* jars into your local Maven cache
  30. [indent=0]
  31. ----
  32. ./gradlew install
  33. ----
  34. === Compile and test; build all jars, distribution zips, and docs
  35. [indent=0]
  36. ----
  37. ./gradlew build
  38. ----
  39. Discover more commands with `./gradlew tasks`.
  40. See also the https://github.com/spring-projects/spring-framework/wiki/Gradle-build-and-release-FAQ[Gradle build and release FAQ].
  41. == Getting Support
  42. Check out the https://stackoverflow.com/questions/tagged/spring-security[Spring Security tags on Stack Overflow].
  43. https://spring.io/services[Commercial support] is available too.
  44. == Contributing
  45. https://help.github.com/articles/creating-a-pull-request[Pull requests] are welcome; see the https://github.com/spring-projects/spring-security/blob/master/CONTRIBUTING.adoc[contributor guidelines] for details.
  46. == License
  47. Spring Security is Open Source software released under the
  48. https://www.apache.org/licenses/LICENSE-2.0.html[Apache 2.0 license].