Update 'Home'

Mya 2022-07-02 16:04:21 +00:00
commit 681a993828

27
Home.md Normal file

@ -0,0 +1,27 @@
`pages` aims to provide a simple alternative to Google Analytics, without the need for cookie disclosures. The
JavaScript components are optional, making it compatible with older browsers / devices where JavaScript may not
be enabled.
## Quickstart with Docker
The easiest way to get started is with Docker. Your web content will be exposed on port `8080` while metrics
will be available on `8081`.
```shell
docker run --rm -it \
-e PAGES_GIT_URL=<your repo> \
-e PAGES_GIT_BRANCH=gh-pages \
-p 8080:8080 \
-p 8081:8081 \
img.pitz.tech/mya/pages
```
## Syncing the git repository
You can instruct the server to reload the Git branch by curling this `/_admin/sync` endpoint.
```shell
curl -X POST http://localhost:8080/_admin/sync
```
This endpoint is exposed publicly so your CI solution can issue the command to cause the servers to update.