ircWebRegistration/README.md
Pratyush Desai acf4dce66f
Include ref to old version and misc
Signed-off-by: Pratyush Desai <pratyush.desai@liberta.casa>
2023-03-20 13:28:58 +05:30

1.5 KiB

IRC Web Registration

Version 1

The v1 of this concept can be referenced in the old and not updated README

The v1.1 enhancements added by Georg Pfuetzenreuter implements support for additional SSO integration to our KeyCloak setup. It also works-in SSL support.

This webform available here is purely demonstrative and does not successfully POST user data

Introduction

This is a basic still WIP overhaul framework for registering an account on an ircd using a webform that is referenced above.

Features

  • It relies on the draft IRCv3 spec draft/account-registration
  • It utilizes the flask framework and WEBIRC to relay remote host ip address.
  • Can be tweaked to allow registration attempts from exit-nodes and other unsavory hosts allowing them to securely work with the require-sasl constraint if needed.

Requirements

This will work with python3.6 and above.

It is recommended to work within a virtual environment.

  1. mkdir ircwebreg && cd ircwebreg
  2. Clone this repository.
  3. python3 -m venv venv
  4. source venv/bin/activate
  5. pip install -r requirements.txt

Installation and Setup

Todo! Refer to the issues and the Milestones and Projects for more

Note

Only works with setups not requiring verification at this moment as stated in #4