Files
metrics/.github/readme/partials/documentation/setup.md
2022-01-15 00:24:30 -05:00

19 lines
1.1 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
## 🦮 Setup
There are several ways to setup metrics, each having its advantages and disadvantages:
* [⚙️ Using GitHub Action on a profile repository *(~10 min)*](/.github/readme/partials/documentation/setup/action.md)
* ✔️ All features
* ✔️ High availability (no downtimes)
* Configuration can be a bit time-consuming
* [💕 Using the shared instance *(~1 min)*](/.github/readme/partials/documentation/setup/shared.md)
* ✔️ Easily configurable and previewable
* Limited features *(compute-intensive features are disabled)*
* 🐳 Using command line with docker *(~5 min)* *(documentation not available yet)*
* ✔️ Suited for one-time rendering
* [🏗️ Deploying your own web instance *(~20 min)*](/.github/readme/partials/documentation/setup/web.md)
* Mostly intended for development, or to create another shared instance
Additional resources for setup:
* [🏦 Configuring metrics for organizations](/.github/readme/partials/documentation/organizations.md)
* 🧰 Template/Plugin compatibility matrix *(documentation not available yet)*