ShareTOTP

Enable seamless sharing of 2FA codes within teams.

This project is a compact solution designed to facilitate the sharing of TOTP codes typically found in apps like Google Authenticator and Authy, with tailored customizations in its development.

Preparing the project

• Clone the repository:

  git clone https://github.com/avicoder/ShareTOTP.git
  cd ShareTOTP

• Create an environment file:

  cp .env.example .env

• Install NodeJS on your machine and run:

  npm i && npm run build

Running the app in local machine

• Install Docker on your local machine and ensure the following ports are free:

  • 33061
  • 8000
  • 8081

• Run the following command in the project root:

  docker compose up -d

• Run Migrations through the webpage.

Accessing Services

• Web Application: http://localhost:80/login
• phpMyAdmin: http://localhost:8081/

Homepage

• The homepage will display all the service codes in a grid.
• Click on the code to copy it to the clipboard

Admin Login

• Default credentials:
  • User: admin@admin.com
  • Password: password

Dashboard

• List the TOTPs and other customizations using /dashboard

OTPs

• Create, Edit, or Delete the OTPs using /otps page

• It also supports major protocols for generating the OTPs )

Services

• Create services and customize the logo and name using /services page

Manage Team Members

• Add, delete, or update the users using /users page

Settings

• Add the org name and Logo using /settings page

Security

While authorization is required to access the Admin page, if you want to add an extra layer of protection to the homepage, consider using OAuth2proxy or Cloudflare Access. Feel free to implement either of these solutions to enhance security.

---

Contributing

We welcome contributions from the community! If you'd like to contribute to ShareTOTP, please follow these steps:

1. Fork the repository.
2. Create a new branch for your feature or bug fix.
3. Make your changes and ensure they are properly tested.
4. Commit your changes with clear and descriptive messages.
5. Push your changes to your fork.
6. Submit a pull request, explaining the changes you've made and why they are valuable.

Thank you for considering contributing to ShareTOTP. Together, we can make it even better!

---

Feel free to adjust the language or steps as needed for this project!