improved documentation

This commit is contained in:
Bernhard B
2021-02-19 22:25:00 +01:00
parent 7dfb69000e
commit e5b0e817b1
2 changed files with 11 additions and 1 deletions

View File

@@ -24,6 +24,8 @@ version: "3"
services:
signal-cli-rest-api:
image: bbernhard/signal-cli-rest-api:latest
environment:
- USE_NATIVE=0
ports:
- "8080:8080" #map docker port 8080 to host port 8080.
volumes:
@@ -31,6 +33,14 @@ services:
```
## Native Image (EXPERIMENTAL)
On Systems like the Raspberry Pi, some operations like sending messages can take quite a while. That's because signal-cli is a Java application and a significant amount of time is spent in the JVM (Java Virtual Machine) startup. signal-cli recently added the possibility to compile the Java application to a native binary (done via GraalVM).
By adding `USE_NATIVE=1` as environmental variable to the `docker-compose.yml` file the native mode will be enabled. In case there's no native binary available (e.g on a 32 bit Raspian OS), it will fall back to the signal-cli Java application.
## API documentation
The Swagger API documentation can be found [here](https://bbernhard.github.io/signal-cli-rest-api/). If you prefer a simple text file like API documentation have a look [here](https://github.com/bbernhard/signal-cli-rest-api/blob/master/doc/EXAMPLES.md)
In case you need more functionality, please **file a ticket** or **create a PR**.

View File

@@ -3,7 +3,7 @@ services:
signal-cli-rest-api:
build: "."
environment:
- USE_NATIVE=1
- USE_NATIVE=0
- PORT=8080
ports:
- "8080:8080" #map docker port 8080 to host port 8080.