mirror of
https://github.com/techno-tim/littlelink-server.git
synced 2025-03-04 16:08:28 -06:00
Update Read Me (#150)
* Added Ghost to Docker-Compose * Updated Readme * Rm extra dividers * Updated description * Added screenshot * Added Config Heading * RM configuration * Added missing links * Added configuration * Added emoji * Rm docs reference * Small typo * Updated manylink * RM littlelink logo * Updated URL * Changed fork of to Inspired by * Linting * Linting * Added link emoji for h1
This commit is contained in:
42
docs/analytics.md
Normal file
42
docs/analytics.md
Normal file
@@ -0,0 +1,42 @@
|
||||
## 📈 Analytics Support
|
||||
|
||||
### Google Analytics
|
||||
|
||||
See [Getting Started with Analytics](https://support.google.com/analytics/answer/1008015?hl=en). After getting your GA Tracking Id, use your tracking Id as environment variable like `GA_TRACKING_ID=G-XXXXXXXXXX` (See the example below)
|
||||
|
||||
All buttons clicked will be tracked automatically if `GA_TRACKING_ID` exists.
|
||||
|
||||
Sample event for YouTube button.
|
||||
|
||||
```javascript
|
||||
window.gtag('event', 'youtube-button');
|
||||
```
|
||||
|
||||
### Umami
|
||||
|
||||
See [Adding a website & Collecting data](https://umami.is/docs/collect-data) page to add and generate your tracking code.
|
||||
|
||||
Generated tracking code should look like:
|
||||
|
||||
```javascript
|
||||
<script async defer data-website-id="00000000-1111-2222-3333-444444444444" src="https://your-umami-app.com/umami.js"></script>
|
||||
```
|
||||
|
||||
Use `data-website-id` as environment variable `UMAMI_WEBSITE_ID` and `src` as `UMAMI_APP_URL`.
|
||||
|
||||
Sample event for YouTube button.
|
||||
|
||||
```javascript
|
||||
window.umami('youtube-button');
|
||||
```
|
||||
|
||||
### Matomo
|
||||
|
||||
See [Installing Matomo fo how to configure analytics](https://matomo.org/docs/installation/) and [how to find your site id](https://matomo.org/faq/general/faq_19212/)
|
||||
|
||||
Use `MATOMO_URL` for your URL and `MATOMO_SITE_ID` for your site id
|
||||
|
||||
Sample event for YouTube button.
|
||||
|
||||
```javascript
|
||||
window._paq.push(['trackEvent', 'youtube-button']]);
|
||||
15
docs/healthcheck.md
Normal file
15
docs/healthcheck.md
Normal file
@@ -0,0 +1,15 @@
|
||||
## 🩺 Health Check
|
||||
|
||||
A health check endpoint exists on `/healthcheck`. If healthy, it will return with a `200` and the following response:
|
||||
|
||||
```json
|
||||
{
|
||||
"status": "ok"
|
||||
}
|
||||
```
|
||||
|
||||
To skip express from logging these calls, add the environment variable:
|
||||
|
||||
```bash
|
||||
SKIP_HEALTH_CHECK_LOGS=true
|
||||
```
|
||||
Reference in New Issue
Block a user