mirror of
https://github.com/twofas/2fas-server.git
synced 2024-11-22 02:10:38 +01:00
44 lines
2.1 KiB
Markdown
44 lines
2.1 KiB
Markdown
|
# Open Source 2FAS API
|
||
|
|
|
||
|
|
This is the official server-side API for the Open Source 2FAS project.
|
||
|
|
|
||
|
|
## What is 2FAS?
|
||
|
|
|
||
|
|
2FAS (Two-Factor Authentication Service) is a user authentication method that provides an additional layer of security for online accounts. In addition to a username and password, 2FAS uses a second factor, such as a one-time password (OTP) shown on a user's phone, to verify a user's identity. This helps prevent unauthorized access to accounts, even if a password is compromised.
|
||
|
|
|
||
|
|
## Features
|
||
|
|
|
||
|
|
- Connecting the 2FAS app with the 2FAS browser extension (API and websocket API)
|
||
|
|
- Connecting to the 2FAS icons system
|
||
|
|
- Connecting to 2FAS support (receiving debug log files)
|
||
|
|
- Sending in-app notifications to 2FAS app users
|
||
|
|
- Other miscellaneous features
|
||
|
|
|
||
|
|
## Bug Reporting
|
||
|
|
|
||
|
|
We use GitHub for bug reports. Please visit the [2FAS Server API issues page](https://github.com/twofas/2fas-api/issues) to search for and report any bugs you may have found. Before adding a new issue, please search for existing issues to avoid duplicates.
|
||
|
|
|
||
|
|
## Contributing
|
||
|
|
|
||
|
|
We welcome contributions to the Open Source 2FAS project. If you would like to contribute, please follow these steps:
|
||
|
|
|
||
|
|
1. Fork the repository.
|
||
|
|
2. Create a new branch for your changes.
|
||
|
|
3. Make your changes.
|
||
|
|
4. Commit your changes and push them to your fork.
|
||
|
|
5. Create a new pull request from your fork to the `master` branch of the main repository.
|
||
|
|
|
||
|
|
We will review your pull request and, if it is approved, merge it into the main codebase.
|
||
|
|
|
||
|
|
By sharing ideas and code with the 2FAS community, either through GitHub or Discord, you agree that these contributions become the property of the 2FAS community and may be implemented into the 2FAS open source code.
|
||
|
|
|
||
|
|
## Donations
|
||
|
|
|
||
|
|
If you would like to support the development of the Open Source 2FAS project, you can [make a donation](https://2fas.com/donate). All donations will be used to support the ongoing development and maintenance of the project.
|
||
|
|
|
||
|
|
We appreciate your support!
|
||
|
|
|
||
|
|
|
||
|
|
## License
|
||
|
|
|
||
|
|
The Open Source 2FAS project is licensed under the [GNU General Public License v3.0](https://www.gnu.org/licenses/gpl-3.0.en.html).
|