Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
kohlschuetter committed Sep 24, 2023
1 parent b4396ef commit e2d5d10
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,9 +46,13 @@ from Java.
* [Demo code](https://kohlschutter.github.io/junixsocket/demo.html) ([Java source](https://kohlschutter.github.io/junixsocket/junixsocket-demo/xref/index.html))
- Sockets (`org.newsclub.net.unix.demo`)
- RMI over Unix Sockets (`org.newsclub.net.unix.demo.rmi` and `org.newsclub.net.unix.demo.rmi.services`)
- MySQL over Unix Sockets (`org.newsclub.net.mysql.demo`)
- MySQL over Unix Sockets (`org.newsclub.net.mysql.demo`)
- Postgres over Unix Sockets (`org.newsclub.net.unix.demo.jdbc`)
- Apache Mina (`org.newsclub.net.unix.demo.mina`)
- NanoHttpd (`org.newsclub.net.unix.demo.nanohttpd`)
- Netty (`org.newsclub.net.unix.demo.netty`)
- OkHttp (`org.newsclub.net.unix.demo.okhttp`)
- SSL (`org.newsclub.net.unix.demo.ssl`)
* [API Javadocs](https://kohlschutter.github.io/junixsocket/apidocs/)
* [Unix Domain Socket Reference](https://kohlschutter.github.io/junixsocket/unixsockets.html)
* [TIPC documentation](https://kohlschutter.github.io/junixsocket/junixsocket-tipc/index.html)
Expand Down
18 changes: 18 additions & 0 deletions src/site/markdown/dependency.md.vm
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,17 @@ If you're going to use the Jetty connectors, add the following dependency:
<version>${project.version}</version>
</dependency>

If you're going to use the SSL extension, add the following dependency:

<dependency>
<groupId>com.kohlschutter.junixsocket</groupId>
<artifactId>junixsocket-ssl</artifactId>
<version>${project.version}</version>
</dependency>

(On Android, you may also want to add `org.bouncycastle:bcprov-jdk18on` and
`org.bouncycastle:bctls-jdk18on`, since the default SSL implementation is incomplete)

If you're going to use Darwin-specific sockets, add the following dependency:

<dependency>
Expand Down Expand Up @@ -157,6 +168,13 @@ For Jetty support, add:

implementation 'com.kohlschutter.junixsocket:junixsocket-jetty:${project.version}'

For SSL support, add:

implementation 'com.kohlschutter.junixsocket:junixsocket-ssl:${project.version}'

(On Android, you may also want to add `org.bouncycastle:bcprov-jdk18on` and
`org.bouncycastle:bctls-jdk18on`, since the default SSL implementation is incomplete)

For Darwin socket support, add:

implementation 'com.kohlschutter.junixsocket:junixsocket-darwin:${project.version}'
Expand Down

0 comments on commit e2d5d10

Please sign in to comment.