Skip to content
This repository was archived by the owner on Apr 20, 2026. It is now read-only.
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .env-sample
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
NGROK_AUTHTOKEN=1g......foo...bar
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,5 +35,26 @@ To run on a specific port use `server.port` system property:
java -Dserver.port=PORT_NUMBER -jar target/exkeymo-web-*-jar-with-dependencies.jar
```

### Docker
If you do not have Java installed, you can run the app with Docker Compose.
Use the `docker-compose` or `docker compose` command, depending on which one is installed:

```bash
docker compose up app

```

Next, browse to [http://localhost:6789](http://localhost:6789/) to access the application.

If you want to get a public URL, obtain ngrok credentials, edit the `.env` file
(`NGROK_AUTHTOKEN=…`), and run ngrok using the following command:

```bash
docker compose run --rm --interactive --service-ports ngrok

```

Ngrok will print the public tunnel, so you can simply browse to it!

### Use
Visit [http://localhost/](http://localhost/). Documentation page [http://localhost/docs.html](http://localhost/docs.html).
24 changes: 24 additions & 0 deletions docker-compose.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
version: '3'

services:
ngrok:
depends_on: [app]
env_file: .env
image: ngrok/ngrok:alpine
command: http app:6789
ports:
- 127.0.0.1:4040:4040

app:
image: maven:3.9-amazoncorretto-17
command: sh -c "
set -x;
cd /app;
mvn clean install;
java -Dserver.port=6789 -jar target/exkeymo-web-*-jar-with-dependencies.jar
"
volumes:
- .:/app
ports:
- 127.0.0.1:6789:6789