index : license-api-rs.git

4cdfc8bb80de6b09aadc80324c095949fcc5c7e8 [patch]

70a0f4d1308e240daeba5b46f13d31f55041acce

5a0277d1cef2b288b9a7c8e0a7f9f39f20e3ba93

4cdfc8bb80de6b09aadc80324c095949fcc5c7e8.tar.gz

chore: update readme, docker-compose.yml with examples

Diff

 README.md          | 2 +-
 docker-compose.yml | 8 ++++++--
 2 files changed, 7 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index b1b8e89..71062a9 100644
--- a/README.md
+++ b/README.md
@@ -41,7 +41,7 @@ I am using [Alpine](https://hub.docker.com/_/alpine/) as a base image, and the a

A sample `docker-compose.yml` file is also included.

On my home server, this service uses 964 KB of RAM with my license database, so it is lightweight.
On my staging server, this service uses 964 KB of RAM with my [license database](https://git.holly.sh/license-db.git), so it is lightweight.

## License

diff --git a/docker-compose.yml b/docker-compose.yml
index 7695b4a..bd5f0de 100644
--- a/docker-compose.yml
+++ b/docker-compose.yml
@@ -3,9 +3,13 @@ services:
  lapi:
    image: lapi:latest
    volumes:
      - /path/to/my/data/:/config
      - /path/to/license_db:/config
    environment:
      - LICENSE_API_DATABASE=/config/licenses/database.yml
      - LICENSE_API_DATABASE="/config/database.yml" # required
      - LICENSE_API_BASE_URL="/" # optional
      - LICENSE_API_SERVER_IP="0.0.0.0" # optional
      - LICENSE_API_SERVER_PORT="8080" # optional
      - LICENSE_API_WELCOME_MESSAGE="/path/to/welcome.txt" # optional
    ports:
      - 3535:8080
    restart: unless-stopped