docs: ✏️ Updated readme
Dominik Frantisek Bucik
parent
b2b8efe516
commit
8f54c284f6
38
README.md
38
README.md
|
|
@ -7,3 +7,41 @@ This project has been forked from the [MITREid Connect repository](https://githu
|
|||
This repository uses [Conventional Commits](https://www.npmjs.com/package/@commitlint/config-conventional).
|
||||
Any change that significantly changes behavior in a backward-incompatible way or requires a configuration change must be marked as BREAKING CHANGE.
|
||||
|
||||
# Building
|
||||
|
||||
Project is built with `mvn clean package` command. Following parameters can be passed to modify the final build:
|
||||
|
||||
### General properties
|
||||
- location of the configuration files (path to the containing dir) : `-Dconfig.location=/etc/oidc/config`
|
||||
- default: `/etc/perun`
|
||||
- final build name: `-Dfinal.name=name`
|
||||
- default: `oidc`
|
||||
|
||||
### Logging configuration
|
||||
Following are the options for customization of logging when building
|
||||
|
||||
- logging style: `-Dlog.to=FILE`
|
||||
- default: `FILE`
|
||||
- available: `SYSLOG,FILE,ROLLING_FILE`
|
||||
- logging level: `-Dlog.level=level`
|
||||
- default: `info`
|
||||
- available: `error,warn,info,debug,trace`
|
||||
- logging to SYSLOG
|
||||
- logging contextName (program name in syslog): `-Dlog.contextName=contextName`
|
||||
- default: `oidc`
|
||||
- logging facility: `-Dlog.facility=facility`
|
||||
- default: `LOCAL7`
|
||||
- logging to file
|
||||
- file path specification: `-Dlog.file=/var/log/oidc`
|
||||
- default: `${catalina.base}/logs/${CONTEXT_NAME}`
|
||||
- file extension: `-Dlog.file-extension=debug`
|
||||
- default: `log`
|
||||
- logging to rolling-file
|
||||
- file path specification: `-Dlog.rolling-file=/var/log/oidc`
|
||||
- default: `${catalina.base}/logs/${CONTEXT_NAME}`
|
||||
- file extension: `-Dlog.file-extension=debug`
|
||||
- default: `log`
|
||||
|
||||
## WAR file
|
||||
|
||||
The result war-file is located under the `perun-oidc-server-webapp/target/{NAME}.war`. The WAR should be deployed into a tomcat.
|
||||
|
|
|
|||
|
|
@ -1,38 +0,0 @@
|
|||
# MITREid Connect
|
||||
---
|
||||
|
||||
[](https://maven-badges.herokuapp.com/maven-central/org.mitre/openid-connect-parent) [](https://travis-ci.org/mitreid-connect/OpenID-Connect-Java-Spring-Server)
|
||||
|
||||
此项目提供了一个业经认证的、用Java语言构筑于Spring平台之上的OpenID Connect参考实现，包括 [服务器端的实现库](openid-connect-server), [可部署的服务器包](openid-connect-server-webapp), [客户端 (RP) 的库](openid-connect-client), 以及 [工具类库](openid-connect-common)。该服务器可以用做OpenID Connect身份提供者，也可以用做一般意义上的OAuth 2.0授权服务器。
|
||||
|
||||
[](https://openid.net/certification/)
|
||||
|
||||
有关项目的更多信息参见：
|
||||
|
||||
* [项目在GitHub上的主页 (及相关项目)](https://github.com/mitreid-connect/)
|
||||
* [完整的文档](https://github.com/mitreid-connect/OpenID-Connect-Java-Spring-Server/wiki)
|
||||
* [Maven文档及Java API](http://mitreid-connect.github.com/)
|
||||
* [问题（Issue）追踪系统 (用于报告bug及提交支持请求)](https://github.com/mitreid-connect/OpenID-Connect-Java-Spring-Server/issues)
|
||||
* 项目的邮件列表： `mitreid-connect@mit.edu`, 及其 [在线存档](https://mailman.mit.edu/mailman/listinfo/mitreid-connect).
|
||||
|
||||
|
||||
项目的作者及主要贡献者有:
|
||||
|
||||
* [Justin Richer](https://github.com/jricher/)
|
||||
* [Amanda Anganes](https://github.com/aanganes/)
|
||||
* [Michael Jett](https://github.com/jumbojett/)
|
||||
* [Michael Walsh](https://github.com/nemonik/)
|
||||
* [Steve Moore](https://github.com/srmoore)
|
||||
* [Mike Derryberry](https://github.com/mtderryberry)
|
||||
* [William Kim](https://github.com/wikkim)
|
||||
* [Mark Janssen](https://github.com/praseodym)
|
||||
|
||||
|
||||
项目的中文译者：
|
||||
|
||||
* [刘晓曦](https://github.com/liouxiao/)
|
||||
|
||||
|
||||
|
||||
|
||||
版权所有 ©2018 [MIT因特网信任联盟](http://www.mit-trust.org/). 采用Apache 2.0许可证, 详见 `LICENSE.txt`.
|
||||
|
|
@ -38,9 +38,7 @@
|
|||
<log.rolling-file>${catalina.base}/logs/${CONTEXT_NAME}</log.rolling-file>
|
||||
<!--suppress UnresolvedMavenProperty -->
|
||||
<log.file>${catalina.base}/logs/${CONTEXT_NAME}</log.file>
|
||||
<log.trace.file-extension>trace</log.trace.file-extension>
|
||||
<log.file-extension>log</log.file-extension>
|
||||
<log.times.file-extension>times</log.times.file-extension>
|
||||
<final.name>oidc</final.name>
|
||||
</properties>
|
||||
|
||||
|
|
@ -86,7 +84,6 @@
|
|||
</dependencies>
|
||||
|
||||
<build>
|
||||
<finalName>${final.name}</finalName>
|
||||
<resources>
|
||||
<resource>
|
||||
<directory>src/main/resources</directory>
|
||||
|
|
@ -110,7 +107,7 @@
|
|||
<groupId>org.apache.maven.plugins</groupId>
|
||||
<artifactId>maven-war-plugin</artifactId>
|
||||
<configuration>
|
||||
<warName>openid-connect-server-webapp</warName>
|
||||
<warName>${final.name}</warName>
|
||||
<webResources>
|
||||
<resource>
|
||||
<directory>src/main/webapp</directory>
|
||||
|
|
|
|||
Loading…
Reference in New Issue