Add docs

Author: ST-DDT

docs/en/client/configuration.md

@@ -38,9 +38,10 @@ If you prefer to read the sources instead, you can do so
 [here](https://github.com/yidongnan/grpc-spring-boot-starter/blob/master/grpc-client-spring-boot-autoconfigure/src/main/java/net/devh/boot/grpc/client/config/GrpcChannelProperties.java#L58).
 
 The properties for the channels are all prefixed with `grpc.client.__name__.` and `grpc.client.__name__.security.`
-respectively. The channel name is taken from the `@GrpcClient` annotation. If you wish to configure some options such as
-trusted certificates for all servers at once you can do so using `GLOBAL` as name. Properties that are defined for a
-name channel take precedence over global once.
+respectively. The channel name is taken from the `@GrpcClient("__name__")` annotation.
+If you wish to configure some options such as trusted certificates for all servers at once,
+you can do so using `GLOBAL` as name.
+Properties that are defined for a specific/named channel take precedence over `GLOBAL` ones.
 
 ### Choosing the Target
 
@@ -55,6 +56,7 @@ There are a number of supported schemes, that you can use to determine the targe
 
 - `static` (Prio 4): \
   A simple static list of IPs (both v4 and v6), that can be use connect to the server (Supports `localhost`). \
+  For resolvable hostnames please use `dns` instead. \
   Example: `static://192.168.1.1:8080,10.0.0.1:1337`
 - [`dns`](https://github.com/grpc/grpc-java/blob/master/core/src/main/java/io/grpc/internal/DnsNameResolver.java#L66)
   (Prio 5): \
@@ -77,6 +79,11 @@ There are a number of supported schemes, that you can use to determine the targe
   This is a special scheme that will bypass the normal channel factory and will use the `InProcessChannelFactory`
   instead. Use it to connect to the [`InProcessServer`](../server/configuration.md#enabling-the-inprocessserver). \
   Example: `in-process:foobar`
+- `unix` (Available on Unix based systems only): \
+  This is a special scheme that uses unix's domain socket addresses to connect to a server. \
+  If you are using `grpc-netty` you also need the `netty-transport-native-epoll` dependency.
+  `grpc-netty-shaded` already contains that dependency, so there is no need to add anything for it to work. \
+  Example: `unix:/run/grpc-server`
 - *custom*: \
   You can define custom
   [`NameResolverProvider`s](https://javadoc.io/page/io.grpc/grpc-all/latest/io/grpc/NameResolverProvider.html) those
@@ -267,6 +274,7 @@ you have to define it via spring context (unless you wish to use `static`).
 - [Getting Started](getting-started.md)
 - *Configuration*
 - [Security](security.md)
+- [Tests with Grpc-Stubs](testing.md)
 
 ----------
 

docs/en/server/configuration.md

@@ -75,6 +75,21 @@ grpc.client.inProcess.address=in-process:<SomeName>
 This is especially useful for tests as they don't need to open a specific port and thus can run concurrently (on a build
 server).
 
+### Using Unix's Domain Sockets
+
+On Unix based systems you can also use domain sockets to locally communicate between server and clients.
+
+Simply configure the address like this:
+
+````properties
+grpc.server.address=unix:/run/grpc-server
+````
+
+Clients can then connect to the server using the same address.
+
+If you are using `grpc-netty` you also need the `netty-transport-native-epoll` dependency.
+`grpc-netty-shaded` already contains that dependency, so there is no need to add anything for it to work.
+
 ## Configuration via Beans
 
 While this library intents to provide most of the features as configuration option, sometimes the overhead for adding it

grpc-client-spring-boot-autoconfigure/src/main/java/net/devh/boot/grpc/client/config/GrpcChannelProperties.java

@@ -104,6 +104,8 @@ public void setAddress(final URI address) {
      * <li>{@code dns:///example.com:9090}</li>
      * <li>{@code discovery:/foo-service}</li>
      * <li>{@code discovery:///foo-service}</li>
+     * <li>{@code unix:<relative-path>} (Additional dependencies may be required)</li>
+     * <li>{@code unix://</absolute-path>} (Additional dependencies may be required)</li>
      * </ul>
      *
      * @param address The string representation of an uri to use as target address or null to use a fallback.

grpc-server-spring-boot-autoconfigure/src/main/java/net/devh/boot/grpc/server/config/GrpcServerProperties.java

@@ -39,6 +39,7 @@
 import io.grpc.netty.shaded.io.grpc.netty.NettyServerBuilder;
 import io.grpc.netty.shaded.io.netty.handler.ssl.SslContextBuilder;
 import lombok.Data;
+import net.devh.boot.grpc.common.util.GrpcUtils;
 
 /**
  * The properties for the gRPC server that will be started as part of the application.
@@ -69,6 +70,8 @@ public class GrpcServerProperties {
     /**
      * Bind address for the server. Defaults to {@link #ANY_IP_ADDRESS "*"}. Alternatively you can restrict this to
      * {@link #ANY_IPv4_ADDRESS "0.0.0.0"} or {@link #ANY_IPv6_ADDRESS "::"}. Or restrict it to exactly one IP address.
+     * On unix systems it is also possible to prefix it with {@link GrpcUtils#DOMAIN_SOCKET_ADDRESS_PREFIX unix:} to use
+     * domain socket addresses/paths (Additional dependencies may be required).
      *
      * @param address The address to bind to.
      * @return The address the server should bind to.