設定パラメーター

conf/application.conf ファイルで、キーに対して値を設定することでPlay アプリケーションを設定します。以下も参照してください。

アプリケーション設定

h3(#application.baseUrl). application.baseUrl

The application base URL used for reverse-resolving absolute URLs. This is used by the @@{..} template syntax and in Jobs, which do not have an inbound Http.Request), such as rendering e-mail. For example, for dev mode:
アプリケーションのベースURLは、逆解決する絶対URLとして使用する。@@{..}テンプレートシンタックスとジョブ、e-mailの描画として

application.baseUrl=http://localhost:9000/

For prod mode:

%production%.application.baseUrl=http://www.yourdomain.com/

h3(#application.defaultCookieDomain). application.defaultCookieDomain

Enables session/cookie sharing between subdomains. For example, to make cookies valid for all domains ending with ‘.example.com’, e.g. foo.example.com and bar.example.com:

application.defaultCookieDomain=.example.com

Default: a cookie is only valid for a specific domain.

h3(#application.lang.cookie). application.lang.cookie

The name of the cookie that is used to store the current language, set by play.i18n.Lang.change(String locale), which you can change if you want separate language settings for separate Play applications. For example:

application.lang.cookie=MYAPP_LANG

Default: PLAY_LANG

h3(#application.langs). application.langs

Defines locales used by your application. You can then place localized messages in conf/messages.{locale} files. The value is a comma-separated list of language codes, for example:

application.langs=fr,en,ja

Default: no additional languages.

h3(#application.log). application.log

Specifies log level for your application. For example:

application.log=DEBUG

Default: INFO

Attachments

h3(#attachments.path). attachments.path

Storage path for play.db.jpa.Blob content. This can be an absolute path, or a relative path to a folder inside the Play application folder. For example:

attachments.path=data/attachments

Default: attachments

X509 certificates

h3(#certificate.key.file). certificate.key.file

Specifies an X509 certificate key, for HTTPS support. The file must be named host.key. For example:

certificate.key.file=/certificates/host.key

Default: conf/host.key

h3(#certificate.file). certificate.file

Specifies an X509 certificate file, for HTTPS support. The file must be named host.cert. For example:

certificate.file=/certificates/host.cert

Default: conf/host.cert

h3(#certificate.password). certificate.password

Password for a password-protected X509 certificate key file, for use with the certificate.key.file configuration. For example:

certificate.password=secret

Default: secret

Scheduled jobs

You can configure cron expressions for scheduled jobs as configuration keys that start with cron. and use the key as the value of a @play.jobs.On or @Every annotation. For example, @On(cron.noon) refers to:

cron.noon=0 0 12 * * ?

Date formats

h3(#date.format). date.format

Sets the default date format, using a java.text.SimpleDateFormat pattern. For example:

date.format=dd-MM-yyyy

This property also affects how ${date.format()} renders dates in templates. It also set the default date format when binding a date parameter.

Default: yyyy-MM-dd

You can also set a different date format for specific languages that you have configured with application.langs, for example:

date.format.fr=dd-MM-yyyy

Database configuration

db

Database engine configuration. To quickly set up a development database use a transient in memory database (H2 in memory):

db=mem

For a simple file written database (H2 file stored):

db=fs

For a local MySQL5 database:

db=mysql:user:pwd@database_name

To reuse an existing Datasource from your application server:

db=java:/comp/env/jdbc/myDatasource@

If you specify a Datasource, the database plugin detects the pattern db=java: and will de-activate the default JDBC system.

Default: none.

h3(#db.destroyMethod). db.destroyMethod

A generic ‘destroy’ method name. When using an existing Datasource, this is sometimes needed to destroy it when the application is stopped. For example:

db.destroyMethod=close

Default: none.

h3(#db.driver). db.driver

Database driver class name, for use with db.url. For example:

db.driver=org.postgresql.Driver

Default:

org.h2.Driver when db is set to mem or fs, or if db.url starts with jdbc:h2:mem:
com.mysql.jdbc.Driver if db is a mysql:… configuration.

h3(#db.pass). db.pass

Database connection password, used with db.url.

Default: no value, or an empty string when db is set to mem or fs.

h3(#db.pool.maxIdleTimeExcessConnections). db.pool.maxIdleTimeExcessConnections

The number of seconds before idle connections beyond db.pool.minSize are ‘culled’. See the c3p0 documentation.

Default: 0 – ‘no enforcement’.

h3(#db.pool.maxSize). db.pool.maxSize

Connection pool maximum size (number of connections). See the c3p0 documentation. For example:

db.pool.maxSize=60

Default: 30

h3(#db.pool.minSize). db.pool.minSize

Connection pool minimum size (number of connections). See the c3p0 documentation. For example:

db.pool.minSize=10

Default: 1

h3(#db.pool.timeout). db.pool.timeout

Connection pool time-out in milliseoncds. See the c3p0 documentation. For example:

db.pool.timeout=10000

Default: 5000

h3(#db.url). db.url

A full JDBC configuration, in combination with db.user, db.pass and db.driver. For example:

db.url=jdbc:postgresql:database_name

Default: none.

h3(#db.user). db.user

Database connection user name, used with db.url.

Default: none, or sa when db is set to mem or fs.

Database evoluations

h3(#evolutions.enabled). evolutions.enabled

Used to disable database evolutions.

evolutions.enabled=false

Default: true

Hibernate

You can specify additional hibernate properties. For example, to enable SQL comments:

hibernate.use_sql_comments=true

h3(#hibernate.connection.datasource). hibernate.connection.datasource

Hibernate datasource configuration.

Server configuration

h3(#http.address). http.address

HTTP listener address, to restrict addresses the server listens on. For example:

http.address=127.0.0.1

Default: the server listens for HTTP on the wilcard address.

h3(#http.cacheControl). http.cacheControl

HTTP Response headers control for static files: sets the default max-age in seconds, telling the user’s browser how long it should cache the page. This is only read in prod mode, in dev mode the cache is disabled. For example, to send no-cache:

http.cacheControl=0

Default: 3600 – set cache expiry to one hour.

h3(#http.exposePlayServer). http.exposePlayServer

Disable the HTTP response header that identifies the HTTP server as Play. For example:

http.exposePlayServer=false

Default: true

h3(#http.path). http.path

The URL path where the application runs on the server: use this if you do not host your Play application at the root of the domain you’re serving it from. This parameter has no effect when deployed as a WAR, because the path will be handled by the application server. For example:

http.path=/myapp/

Default: /

h3(#http.port). http.port

The port that the HTTP server listens on.

Default: 9000

h3(#http.proxyHost). http.proxyHost

Proxy server for web services requests. For example:

http.proxyHost=localhost

Default: http.proxyHost system property.

h3(#http.proxyPassword). http.proxyPassword

Proxy password for web services requests.

Default: http.proxyPassword system property.

h3(#http.proxyPort). http.proxyPort

Proxy port for web services requests. For example:

http.proxyPort=3128

Default: http.proxyPort system property.

h3(#http.proxyUser). http.proxyUser

Proxy user for web services requests.

Default: http.proxyUser system property.

h3(#http.useETag). http.useETag

If enabled, Play will generate entity tags automatically and send a 304 when needed. For example, to deactivate use of entity tags:

http.useETag=false

Default: true

h3(#http.userAgent). http.userAgent

Custom USER_AGENT header value for web services requests. For example:

http.userAgent=myApp 1.0

Defualt: none.

h3(#https.port). https.port

Enables an HTTPS connector, listening on the specified port. For example:

https.port=9443

Default: none – no HTTPS configuration.

Java source

h3(#java.source). java.source

Java source level, which overrides the java.version system property. For example:

java.source=1.6

Values: 1.5, 1.6, 1.7 (experimental).

Default: 1.5

JPA

h3(#jpa.dialect). jpa.dialect

Specify the custom JPA dialect to use here. For example:

jpa.dialect=org.hibernate.dialect.PostgreSQLDialect

Default: Play will guess the dialect based on the db.driver configuration.

h3(#jpa.ddl). jpa.ddl

Specify the DDL generation pattern to use. For example, to enable automatic database structure updates. For example:

jpa.ddl=create-drop

Default: update (dev mode) or none (prod mode).

h3(#jpa.debugSQL). jpa.debugSQL

Debug SQL statements (logged using DEBUG level). For example:

jpa.debugSQL=true

Default: false

h3(#jpa.entities). jpa.entities

Comma-separated list of names of additional JPA entity classes to load. This is useful when you have additional entities that are not in the models package, such as model classes in a separate JAR. For example:

org.example.model.Person, org.example.model.Organisation

Default: none.

h3(#jpa.mapping-file). jpa.mapping-file

JPA mapping file.

Default: none.

JVM

h3(#jpda.port). jpda.port

Defines which port is used by JPDA when application is in debug mode. For example:

Default: 8000

keystore

h3(#keystore.algorithm). keystore.algorithm

A JDK Security API standard algorithm name, for use with the keystore.file configuration.

keystore.algorithm=pkcs12

Values – ‘standard names’ from the JDK Security API:

jceks (‘SunJCE’ provider)
jks (‘SUN" provider)
pkcs12

Default: JKS

h3(#keystore.file). keystore.file

Specifies a keystore certificate, for HTTPS support. The file should be named certificate.jks. For example:

keystore.file=conf/certificate.jks

h3(#keystore.password). keystore.password

Keystore configuration, for use with the keystore.file configuration.

keystore.password=secret

Default: secret

Memcached

memcached

Enable Memcached; if you don’t configure Memcached, Play will use a standalone cache that stores data in the JVM heap.

memcached=enabled

Default: disabled

Custom MIME types

You can declare additional MIME types. For example:

mimetype.xpi=application/x-xpinstall

Web services

webservice

Class name of the Web services implementation, or one of the built-in implementations. For example:

webservice=urlfetch

Values:

urlfetch – the JDK’s internal implementation
async – the engine is Async Http Client
class name of a play.libs.WS.WSImpl implementation

Default: async – the engine is Async Http Client.

Mail

h3(#mail.debug). mail.debug

Enables SMTP transaction logging; under the hood, Play uses JavaMail to perform the actual SMTP transactions.

mail.debug=true

Default: false

h3(#mail.smtp). mail.smtp

Simple mail configuration key.

Default: mock – use a mock Mailer

Play run-time

h3(#play.bytecodeCache). play.bytecodeCache

Used to disable the bytecode cache in dev mode; has no effect in prod mode.

play.bytecodeCache=false

Default: true

h3(#play.editor). play.editor

Open file from error pages. If your text editor supports opening files by URL, Play will dynamically link error pages to files. For Textmate, for example:

play.editor=txmt://open?url=file://%s&line=%s

h3(#play.jobs.pool). play.jobs.pool

Size of the Jobs pool. For example:

play.jobs.pool=20

Default: 10

h3(#play.netty.clientAuth). play.netty.clientAuth

Configures javax.net.ssl.SSLEngine client authentication. For example:

play.netty.clientAuth=need

Values:

want – the server will request client authentication
need – the server will require client authentication
none – no client authentication

Default: none

h3(#play.netty.maxContentLength). play.netty.maxContentLength

HTTP server maximum content length for response streaming, in bytes.

Default: none – no maximum.

h3(#play.pool). play.pool

Execution pool size. Try to keep this as low as possible. Setting this to 1 thread will serialize all requests (very useful for debugging purpose). For example:

play.pool=10

Default: 1 (in dev mode), number of processors + 1 (in prod mode).

h3(#play.tmp). play.tmp

Folder used to store temporary files. For example:

play.tmp=/tmp/play

Values:

an absolute path
a relative path, relative to the application directory
none so that no temporary directory will be used

Default: tmp

SSL

trustmanager

h3(#trustmanager.algorithm). trustmanager.algorithm

A JDK Security API standard algorithm name, for use with X509 certificates and keystore configurations.

trustmanager.algorithm=pkcs12

Values – ‘standard names’ from the JDK Security API:

jceks (‘SunJCE’ provider)
jks (‘SUN" provider)
pkcs12

Default: JKS

play.netty.clientAuth

Values

want Controls whether accepted server-mode SSLSockets will be initially configured to request client authentication.
need Controls whether accepted server-mode SSLSockets will be initially configured to require client authentication.
none None of the above

Default: none

File upload

h3(#upload.threshold). upload.threshold

The threshold in bytes at which upload files will be written to disk, for org.apache.commons.io.output.DeferredFileOutputStream. For example:

upload.threshold=20480

Default: 10240

Proxy forwarding

XForwardedHost

Overrides the X-Forwarded-Host HTTP header value – the original host requested by the client, for use with proxy servers.

Default: X-Forwarded-Host HTTP header value.

XForwardedProto

Sets the proxy request to SSL, overriding the X-Forwarded-Proto and X-Forwarded-SSL HTTP header values – the protocol originally requested by the client. For example:

XForwardedProto=https

XForwardedSupport

A comma-separated list of IP addresses that are allowed X-Forwarded-For HTTP request header values, used to restrict local addresses when an X-Forwarded-For request header is set by a proxy server.

Default: 127.0.0.1

masahitojp/configuration.textile

設定パラメーター

アプリケーション設定

Attachments

X509 certificates

Scheduled jobs

Date formats

Database configuration

db

Database evoluations

Hibernate

Server configuration

Java source

JPA

JVM

keystore

Memcached

memcached

Custom MIME types

Web services

webservice

Mail

Play run-time

SSL

trustmanager

File upload

Proxy forwarding

XForwardedHost

XForwardedProto

XForwardedSupport