Skip to content

Commit 7a5746b

Browse files
committed
better doc for .securePort
1 parent c6d882f commit 7a5746b

File tree

1 file changed

+51
-1
lines changed

1 file changed

+51
-1
lines changed

jooby/src/main/java/org/jooby/Jooby.java

Lines changed: 51 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3855,7 +3855,57 @@ public Jooby port(final int port) {
38553855
}
38563856

38573857
/**
3858-
* Set the HTTPS port.
3858+
* <p>
3859+
* Set the HTTPS port to use.
3860+
* </p>
3861+
* <p>
3862+
* Jooby comes with a self-signed certificate, useful for development and test. But of course, you
3863+
* should NEVER use it in the real world.
3864+
* </p>
3865+
*
3866+
* <p>
3867+
* In order to setup HTTPS with a secure certificate, you need to set these properties:
3868+
* </p>
3869+
*
3870+
* <ul>
3871+
* <li>
3872+
* <code>ssl.keystore.cert</code>: An X.509 certificate chain file in PEM format. It can be an
3873+
* absolute path or a classpath resource.
3874+
* </li>
3875+
* <li>
3876+
* <code>ssl.keystore.key</code>: A PKCS#8 private key file in PEM format. It can be an absolute
3877+
* path or a classpath resource.
3878+
* </li>
3879+
* </ul>
3880+
*
3881+
* <p>
3882+
* Optionally, you can set these too:
3883+
* </p>
3884+
*
3885+
* <ul>
3886+
* <li>
3887+
* <code>ssl.keystore.password</code>: Password of the keystore.key (if any). Default is:
3888+
* null/empty.
3889+
* </li>
3890+
* <li>
3891+
* <code>ssl.trust.cert</code>: Trusted certificates for verifying the remote endpoint’s
3892+
* certificate. The file should contain an X.509 certificate chain in PEM format. Default uses the
3893+
* system default.
3894+
* </li>
3895+
* <li>
3896+
* <code>ssl.session.cacheSize</code>: Set the size of the cache used for storing SSL session
3897+
* objects. 0 to use the default value.
3898+
* </li>
3899+
* <li>
3900+
* <code>ssl.session.timeout</code>: Timeout for the cached SSL session objects, in seconds. 0 to
3901+
* use the default value.
3902+
* </li>
3903+
* </ul>
3904+
*
3905+
* <p>
3906+
* As you can see setup is very simple. All you need is your <code>.crt</code> and
3907+
* <code>.key</code> files.
3908+
* </p>
38593909
*
38603910
* @param port HTTPS port.
38613911
* @return This instance.

0 commit comments

Comments
 (0)