Skip to content

Commit 1dc4176

Browse files
committed
docs: add docker guide
1 parent f370bd2 commit 1dc4176

File tree

2 files changed

+14
-3
lines changed

2 files changed

+14
-3
lines changed

.github/readme/partials/documentation/setup.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ There are several ways to setup metrics, each having its advantages and disadvan
1212
* [🏗️ Deploying a web instance *(~20 min)*](/.github/readme/partials/documentation/setup/web.md)
1313
* ✔️ Create another shared instance
1414
* ➖ Requires some sysadmin knowlegde
15-
* [🐳 Using command line with docker *(~5 min)*](/.github/readme/partials/documentation/setup/docker.md)
15+
* [🐳 Using command line with docker *(~2 min)*](/.github/readme/partials/documentation/setup/docker.md)
1616
* ✔️ Suited for one-time rendering
1717
* [🔧 Local setup for development *(~20 min)*](/.github/readme/partials/documentation/setup/local.md)
1818

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,14 @@
1-
# 🐳 Using command line with docker (~5 min)
1+
# 🐳 Using command line with docker (~2 min)
22

3-
*Documentation not available yet*
3+
## 0️ Prepare your machine
4+
5+
A server with a recent version of [docker](https://www.docker.com/) is required.
6+
7+
## 1️ Run docker image
8+
9+
The command to use is similar to the following:
10+
```shell
11+
docker run --env INPUT_TOKEN=**** --env INPUT_USER=user --volume=/tmp:/metrics_renders ghcr.io/lowlighter/metrics:latest
12+
```
13+
14+
To pass parameters, pass environment variable with the same name as the corresponding action option but in uppercase and prefixed with `INPUT_`.

0 commit comments

Comments
 (0)