volskaya / norman Goto Github PK

Norman is a house keeping bot, intended for private servers, that stores keys of users and requests the user to validate them, upon login.

The bot has an API interface for setting those keys from your web server or just accessing regular DB info via json.

Currently the bot only supports a local file DB

Bot holds its own DB of members. Every user will have an empty entry created, under their ID, whenever they join the server.

If the user has an unapproved key, bot will send out a private message, requesting that key to be provided within --timeout or 60 seconds. After the key is validated, user will receive approved role, if not, kicked.

• ID
• Name , username, not nickname
• avatar_url
• key
• approved
• valid

Note: Server owner has access to the bot by default.

Your token and server need to be specified in config.json, along with role id's for admin, bot, approved roles. It is important, that id's are declared as integers, meaning no "" around the numbers, because that's how the bot differentiates between discord.Objects and regular ID references.

server_ip and server_port refer to the inbuilt API for fetching or setting user info from your web page.

owner refers to the person, hosting the bot, not to the server owner.

• admin role can be left blank, if you don't want to give them any permissions.
• bot is the only role, the bot is gonna track for permissions. If this is blank, its gonna emit error messages.
• approved is the role, that's assigned, after a member has validated its assigned key with the bot. Your servers default role should forbid anyone from seeing, talking or accessing other channels or server info in any way, if you're using this bot.

{
  "name": "Norman",
  "avatar": "./data/norman.jpg",
  "server_ip": "127.0.0.1",
  "server_port": "8080",
  "token": "",
  "owner": 111111111111111111,
  "server": 222222222222222222,
  "role": {
    "admin": 333333333333333333,
    "bot": 444444444444444444,
    "approved": 555555555555555555
  }
}

Your servers @everyone role should have all its permissions revoked. Create a new role for approved, name it whatever you want and mimic roles from @everyone. Also disable Display role members separately from online members.

Remove every permission from @everyone so new players can't do anything without the approved role.

Create a role bot, name it whatever you want. Give it permissions to:

• Kick Members
• Ban Members (For swiping the ban list and revoke keys for banned players, while the bot was offline)
• Manage Roles
• Move Members

Write down its id's in config.json as integers.

Besides manual chat commands, you can also access the bot from your back-end. By default the server is listening on 127.0.0.1:8080, but you can change this with --ip and --port

All of the routes return a json object for that user, except /user/remove/

1. Clone the repository

git clone https://github.com/volskaya/norman

2. Cd into norman folder and edit config.json
3. Launch with

python norman.py

# --help for help
python norman.py --help