README.adoc 3.2 KB
Newer Older
R
Rob Winch 已提交
1 2
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]

E
Ellie Bahadori 已提交
3 4
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"]

5 6
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"]

S
shaehnel 已提交
7 8
= Spring Security

S
Spring Operator 已提交
9
Spring Security provides security services for the https://docs.spring.io[Spring IO Platform]. Spring Security 5.0 requires Spring 5.0 as
R
Rob Winch 已提交
10
a minimum and also requires Java 8.
S
shaehnel 已提交
11

S
Spring Operator 已提交
12
For a detailed list of features and access to the latest release, please visit https://spring.io/projects[Spring projects].
S
shaehnel 已提交
13

R
Rob Winch 已提交
14
== Code of Conduct
R
Rob Winch 已提交
15
Please see our https://github.com/spring-projects/.github/blob/master/CODE_OF_CONDUCT.md[code of conduct]
R
Rob Winch 已提交
16

S
shaehnel 已提交
17
== Downloading Artifacts
18
See https://docs.spring.io/spring-security/site/docs/current/reference/html5/#getting[Getting Spring Security] for how to obtain Spring Security.
S
shaehnel 已提交
19 20

== Documentation
S
Spring Operator 已提交
21
Be sure to read the https://docs.spring.io/spring-security/site/docs/current/reference/htmlsingle/[Spring Security Reference].
R
Rafiullah Hamedy 已提交
22
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].
S
shaehnel 已提交
23 24

== Quick Start
S
Spring Operator 已提交
25
We recommend you visit https://docs.spring.io/spring-security/site/docs/current/reference/htmlsingle/[Spring Security Reference] and read the "Getting Started" page.
S
shaehnel 已提交
26 27

== Building from Source
S
Spring Operator 已提交
28 29
Spring Security uses a https://gradle.org[Gradle]-based build system.
In the instructions below, https://vimeo.com/34436402[`./gradlew`] is invoked from the root of the source tree and serves as
S
shaehnel 已提交
30 31 32
a cross-platform, self-contained bootstrap mechanism for the build.

=== Prerequisites
33
https://help.github.com/set-up-git-redirect[Git] and the https://www.oracle.com/technetwork/java/javase/downloads[JDK11 build].
S
shaehnel 已提交
34

35
Be sure that your `JAVA_HOME` environment variable points to the `jdk-11` folder extracted from the JDK download.
S
shaehnel 已提交
36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54

=== Check out sources
[indent=0]
----
git clone git@github.com:spring-projects/spring-security.git
----

=== Install all spring-\* jars into your local Maven cache
[indent=0]
----
./gradlew install
----

=== Compile and test; build all jars, distribution zips, and docs
[indent=0]
----
./gradlew build
----

R
Rob Winch 已提交
55
Discover more commands with `./gradlew tasks`.
S
shaehnel 已提交
56 57 58
See also the https://github.com/spring-projects/spring-framework/wiki/Gradle-build-and-release-FAQ[Gradle build and release FAQ].

== Getting Support
S
Spring Operator 已提交
59 60
Check out the https://stackoverflow.com/questions/tagged/spring-security[Spring Security tags on Stack Overflow].
https://spring.io/services[Commercial support] is available too.
S
shaehnel 已提交
61 62

== Contributing
63
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.
S
shaehnel 已提交
64 65

== License
R
Rob Winch 已提交
66
Spring Security is Open Source software released under the
S
Spring Operator 已提交
67
https://www.apache.org/licenses/LICENSE-2.0.html[Apache 2.0 license].