Skip to content

Commit

Permalink
README: Add usage
Browse files Browse the repository at this point in the history
  • Loading branch information
Akihiro Kondo committed Dec 17, 2015
1 parent 7526050 commit ae69513
Showing 1 changed file with 50 additions and 0 deletions.
50 changes: 50 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,53 @@ Status

[![Maven Central](https://maven-badges.herokuapp.com/maven-central/net.rakugakibox.springbootext/spring-boot-ext-logback-access/badge.svg)](https://maven-badges.herokuapp.com/maven-central/net.rakugakibox.springbootext/spring-boot-ext-logback-access)
[![Circle CI](https://circleci.com/gh/akihyro/spring-boot-ext-logback-access.svg?style=shield)](https://circleci.com/gh/akihyro/spring-boot-ext-logback-access)

Supported servlet containers
----------------------------

* Embedded Tomcat
* Embedded Jetty

Usage
-----

### Maven dependency:

```xml
<dependency>
<groupId>net.rakugakibox.springbootext</groupId>
<artifactId>spring-boot-ext-logback-access</artifactId>
<version>1.0</version>
</dependency>
```

### Configuration properties (application.yml):

```yml
logback.access:
config: "classpath:your-logback-access.xml"
# Auto-detected by default.
# => "classpath:logback-access-test.xml"
# => "classpath:logback-access.xml"
# => "classpath:net/rakugakibox/springbootext/logback/access/logback-access.xml"
```

### Logback-access configuration example (logback-access.xml)

```xml
<configuration>
<appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
<encoder>
<pattern>common</pattern>
</encoder>
</appender>
<appender-ref ref="CONSOLE" />
</configuration>
```

See Also: [HTTP-access logs with logback-access, Jetty and Tomcat - Logback-access](http://logback.qos.ch/access.html)

License
-------

Licensed under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0).

0 comments on commit ae69513

Please sign in to comment.