https://github.com/steveiliop56/tinyauth-analytics
A simple server to transparently collect version information from Tinyauth instances.
https://github.com/steveiliop56/tinyauth-analytics
analytics tinyauth
Last synced: about 2 months ago
JSON representation
A simple server to transparently collect version information from Tinyauth instances.
- Host: GitHub
- URL: https://github.com/steveiliop56/tinyauth-analytics
- Owner: steveiliop56
- License: mit
- Created: 2025-09-17T13:45:09.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2025-10-08T17:20:02.000Z (7 months ago)
- Last Synced: 2025-10-08T18:30:33.075Z (7 months ago)
- Topics: analytics, tinyauth
- Language: Go
- Homepage:
- Size: 40 KB
- Stars: 2
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Tinyauth analytics
A simple server to transparently collect version information from Tinyauth instances.
## How does it work
Every Tinyauth instance runs a goroutine (unless you choose to opt-out) that does a "heartbeat" every 12 hours indicating the instance is still alive. The heartbeat contains the UUID generated by Tinyauth on start up and the version information. The server stores them in the SQLite database alongside with the last seen date. When you request all the instances, the server responds with an array containing the versions, UUIDs and last seen dates.
## Running
The central information server is hosted at `api.tinyauth.app/v1/` and all instance information can be requested from the `/v1/instances/all` endpoint. But, if you would like to run your own server for your own projects, you can by simply cloning the repository and running:
```sh
docker compose up -d
```
> [!NOTE]
> Make sure to edit the environment variables to suit your needs.
> [!NOTE]
> The docker compose file builds the image from scratch by default but there are also available prebuilt images in the packages section.
## Contributing
If you like you can contribute to this project by picking up an [issue](https://github.com/steveiliop56/tinyauth-analytics/issues) or creating a [pull request](https://github.com/steveiliop56/tinyauth-analytics/pulls). Contributing is appreciated a lot!
## License
Tinyauth analytics is licensed under the MIT License. TL;DR — You can use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the software. Just make sure to include the original license in any substantial portions of the code. There’s no warranty — use at your own risk. See the [LICENSE](./LICENSE) file for full details.