https://github.com/integeralex/fingerprint-oss
https://github.com/integeralex/fingerprint-oss
Last synced: 18 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/integeralex/fingerprint-oss
- Owner: IntegerAlex
- License: gpl-3.0
- Created: 2025-02-22T21:08:07.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2025-02-22T21:35:56.000Z (11 months ago)
- Last Synced: 2025-02-23T00:39:33.041Z (11 months ago)
- Language: TypeScript
- Size: 105 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Fingerprint OSS
[](https://opensource.org/licenses/LGPL-2.1)
[](https://www.npmjs.com/package/fingerprint-oss)
[](https://github.com/IntegerAlex/fingerprint-oss/stargazers)
[](https://www.npmjs.com/package/fingerprint-oss)
[](https://github.com/IntegerAlex/fingerprint-oss/issues)
[](https://github.com/IntegerAlex/fingerprint-oss/pulls)
> A free and open source fingerprinting service unlike FingerprintJS.
## ⚠️ Important Notice
This library is released under the LGPL-3.0 license and includes ethical guidelines for usage. Please read our [Ethical Contribution Notice](./NOTICE.md) before using this library. We are committed to:
- Transparent data collection
- User privacy protection
- Ethical usage of fingerprinting technology
- Compliance with privacy regulations
## About
Fingerprint OSS is a fork of user-info-logger, a simple client-side fingerprinting library that logs user information. Unlike commercial alternatives that are "source available" but not truly open, Fingerprint OSS is released under the LGPL-3.0 license, making it fully open source and free to use.
Fingerprint-OSS is now backed by Cloudflare OSS, Neon, and Netlify.
## Demo
- [Live Demo](https://fingerprint-oss-demo.vercel.app/)
- [Demo Repository](https://github.com/IntegerAlex/fingerprint-oss-demo)
## Features
- Lightweight browser fingerprinting
- Easy integration with any web application
- 100% client-side operation (except the GeoLocation API)
- Comprehensive user data collection
- VPN detection
- Incognito mode detection
- AdBlocker detection
- Bot detection
- GDPR compliance support
- **OpenTelemetry integration for observability and error tracking**
## Installation
Install via npm:
```bash
npm install fingerprint-oss@latest
```
## Usage
Basic usage:
```javascript
import userInfo from 'fingerprint-oss';
const data = await userInfo();
```
## Configuration for GDPR Compliance
```javascript
const config = {
transparency: true,
message: 'Custom message about data collection'
};
const data = await userInfo(config);
```
## Configuration for OpenTelemetry
```javascript
const config = {
transparency: true,
message: 'Custom message about data collection',
telemetry: {
enabled: true,
serviceName: 'my-app',
serviceVersion: '0.9.1',
sampleRate: 0.1,
debug: false
}
};
const data = await userInfo(config);
```
- You can override the endpoint if needed via your telemetry config.
## Documentation
- [API Documentation](./API.md) - Detailed API reference and output structure
- [Telemetry Guide](./TELEMETRY.md) - OpenTelemetry integration and usage examples
- [Wiki](https://deepwiki.com/IntegerAlex/fingerprint-oss)
- [Changelog](./CHANGELOG.md)
- [Ethical Contribution Notice](./NOTICE.md)
## Data Collected
Fingerprint OSS can collect information about:
- Browser type and version
- Operating system
- Screen resolution
- Installed plugins
- Language settings
- Time zone
- Hardware information
- Canvas fingerprinting
- WebGL capabilities
- VPN status
- Incognito mode status
- AdBlocker status
- Bot detection
- And more...
For a complete list of collected data and their structure, please refer to our [API Documentation](./API.md).
## Project Status
This project is currently under active development. See the [changelog](./CHANGELOG.md) for the latest updates.
## License
LGPLv3 - See [LICENSE](./LICENSE.md) file for details.
## Contributing
Contributions are welcome! Please feel free to submit a Pull Request or open issues on our GitHub repository. Before contributing, please read our [Ethical Contribution Notice](./NOTICE.md) to ensure your contributions align with our ethical guidelines.
## Acknowledgements
This project is a fork of user-info-logger, with enhancements and improvements for better performance and features.