sangelo/plausible-pageviews-api
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions
Get the requested page's views or unique visitors from Plausible Analytics
3 commits 1 branch 0 tags 77 KiB
JavaScript 96.9%
Dockerfile 3.1%
Find a file
Sangelo f5ce64f31f
Some checks failed
Build and Push Docker Image / docker-build (push) Failing after 1s
Details
[c] update container reference in workflow
2024-10-21 15:32:56 +02:00
.forgejo/workflows [c] update container reference in workflow 2024-10-21 15:32:56 +02:00
.env.example Initial Commit 2024-10-21 15:13:13 +02:00
.gitignore Initial Commit 2024-10-21 15:13:13 +02:00
Dockerfile [a] docker container and workflow 2024-10-21 15:29:20 +02:00
main.js Initial Commit 2024-10-21 15:13:13 +02:00
package.json Initial Commit 2024-10-21 15:13:13 +02:00
README.md [a] docker container and workflow 2024-10-21 15:29:20 +02:00
yarn.lock Initial Commit 2024-10-21 15:13:13 +02:00

README.md

plausible-pageviews-api

Get the requested page's views or unique visitors from Plausible Analytics.

Configuration in .env

PORT=3000 # the api port
METRICS_PORT=9100 # the port on which prometheus metrics are hosted on, endpoint: /metrics
PLAUSIBLE_DOMAIN=plausible.io # the plausible instance domain
PLAUSIBLE_API_KEY="api_key_goes_here" # your plausible API key
ALLOWED_ORIGINS="https://example.com" # allowed CORS origins
RATE_LIMIT_MINUTES=15 # the amount of time in minutes to rate limit
RATE_LIMIT_REQUESTS=100 # amount of max. requests

Don't change the PORT value when running in a Docker Container. Instead, export a different port and forward that to the container's port 3000.

# example for docker-compose.yml:
ports:
  - "5678:3000"

You also have to mount the .env file inside the container, if you're using Docker:

volumes:
  - .env:/app/.env

Run the API

$ yarn install
$ yarn start