Skip to content

Latest commit

 

History

History
84 lines (56 loc) · 5.25 KB

README.md

File metadata and controls

84 lines (56 loc) · 5.25 KB
Raw

VicVerify

All Contributors Code of Conduct GitHub

Discord verification system for Te Herenga Waka - Victoria University of Wellington. You can invite it here.

About

This is a Discord bot that handles verification between Discord accounts and Vic uni accounts. It has the ability to verify students and staff separately and assign roles based on the verification. It is designed to be used by both university clubs and official course servers providing a painless and seamless verification system. This system was designed with privacy in mind with the Victoria Engineering Club not having access to any data and all processes are fully automated.

How to use

Verification

The verification process is fairly straightforward and only requires the user to have access to their university email.

  1. Run /verify in Discord which begins the verification process, you will also need to provide if you are a student and your email address which ends in @vuw.ac.nz or @myvuw.ac.nz.
  2. You will receive a verification code in your email in the following few minutes.
  3. Run /verifycode <code> in Discord to verify your account which will then be synced across all servers.
  4. Done!!!

To unlink your Discord account from your Vic account, run /unlink in Discord. This will remove all verification roles and after 1 years time delete all data related to your Discord account.

Server Administration

Server administration is originally handled by the bot but requires additional configuration. When the the bot joins the server it will create a Student and Staff role which will be used for verified users. These roles have no permissions and it is up to you to add those permissions. It is recommended to remove send messages from @everyone and instead require users to be verified in order to send messages.

If you these roles are not created please kick and re-add the bot to the server. If you do this once roles are created the bot will create new roles when it joins.

Development

This is a fully open-source project coordinated by the Victoria Engineering Club from at their discord found here. If you have any questions or suggestions, please feel free to contact us.

Requirements

The following tools and software are used for development of this service.

  • Docker
  • Node.js (v18)
  • Yarn (v3)

Installation

This will install all packages and commit hooks allowing local development.

yarn install

To deploy the full stack which is especially useful for testing, you can use the following command.

docker compose up -d

Contributors ✨

Thanks goes to these wonderful people (emoji key):


NightFish
💻 🚧 🛡️
Leon Bowie
🚧 💻 🚇

This project follows the all-contributors specification. Contributions of any kind welcome!

Privacy Policy

We collect personal information from you, including information about your: Email address Discord account ID

We collect your personal information in order to: verify Te Herenga Waka - Victoria University of Wellington students and link their Discord accounts to their email address.

We keep your information safe by storing it in a private database and only allowing University staff and the Student Interest and Conflict Resolution team to access you linked email address and history of verification attempts.

We keep your information for as long as you remain verified at which point we securely destroy it by securely erasing all data after 30 days from your request.

You have the right to ask for a copy of any personal information we hold about you, and to ask for it to be corrected if you think it is wrong. If you’d like to ask for a copy of your information, or to have it corrected, please contact us at [email protected].