sudacode/metrics
1
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

docs: add docker guide

Browse Source
This commit is contained in:
lowlighter
2022-01-16 09:07:39 -05:00
parent f370bd2a2d
commit 1dc41763c3
2 changed files with 14 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
.github/readme/partials/documentation/setup.md vendored
View File

@@ -12,7 +12,7 @@ There are several ways to setup metrics, each having its advantages and disadvan
* [🏗️ Deploying a web instance *(~20 min)*](/.github/readme/partials/documentation/setup/web.md)
* ✔️ Create another shared instance
* ➖ Requires some sysadmin knowlegde
* [🐳 Using command line with docker *(~5 min)*](/.github/readme/partials/documentation/setup/docker.md)
* [🐳 Using command line with docker *(~2 min)*](/.github/readme/partials/documentation/setup/docker.md)
* ✔️ Suited for one-time rendering
* [🔧 Local setup for development *(~20 min)*](/.github/readme/partials/documentation/setup/local.md)

15
.github/readme/partials/documentation/setup/docker.md vendored
View File

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