README.adoc 3.0 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]

R
Rob Winch 已提交
3
image:https://travis-ci.org/spring-projects/spring-security.svg?branch=master["Build Status", link="https://travis-ci.org/spring-projects/spring-security"]
R
Rob Winch 已提交
4

S
shaehnel 已提交
5 6
= Spring Security

S
Spring Operator 已提交
7
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 已提交
8
a minimum and also requires Java 8.
S
shaehnel 已提交
9

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

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

S
shaehnel 已提交
15 16 17 18
== Downloading Artifacts
See https://github.com/spring-projects/spring-framework/wiki/Downloading-Spring-artifacts[downloading Spring artifacts] for Maven repository information.

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

== Quick Start
S
Spring Operator 已提交
23
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 已提交
24 25

== Building from Source
S
Spring Operator 已提交
26 27
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 已提交
28 29 30
a cross-platform, self-contained bootstrap mechanism for the build.

=== Prerequisites
S
Spring Operator 已提交
31
https://help.github.com/set-up-git-redirect[Git] and the https://www.oracle.com/technetwork/java/javase/downloads[JDK8 build].
S
shaehnel 已提交
32

P
pkovacs 已提交
33
Be sure that your `JAVA_HOME` environment variable points to the `jdk1.8.0` folder extracted from the JDK download.
S
shaehnel 已提交
34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52

=== 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 已提交
53
Discover more commands with `./gradlew tasks`.
S
shaehnel 已提交
54 55 56
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 已提交
57 58
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 已提交
59 60

== Contributing
R
Rafiullah Hamedy 已提交
61
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.md[contributor guidelines] for details.
S
shaehnel 已提交
62 63

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