beenull/mCaptcha
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
A no-nonsense CAPTCHA system with seamless UX | Backend component
123 commits 32 branches 0 tags 32 MiB
JavaScript 81.5%
Rust 11.1%
TypeScript 4.3%
HTML 1.8%
SCSS 0.9%
Other 0.3%
Find a file
realaravinth cd729effb9
updated docs route
2021-05-08 15:12:25 +05:30
.github/workflows CI: coverage build step 2021-05-08 13:59:13 +05:30
config docs use const routes 2021-05-02 18:36:39 +05:30
docs OAS: yaml to json 2021-04-01 15:23:36 +05:30
migrations sitekey list 2021-05-04 18:34:36 +05:30
src updated docs route 2021-05-08 15:12:25 +05:30
static-assets/img typescript migration 2021-05-01 19:22:44 +05:30
templates updated docs route 2021-05-08 15:12:25 +05:30
.dockerignore Dockerfile init 2021-05-04 10:30:22 +05:30
.gitignore router.ts tests 2021-05-06 10:53:05 +05:30
build.rs static dir renamed and cookie auth middleware 2021-05-01 11:28:39 +05:30
Cargo.lock static dir renamed and cookie auth middleware 2021-05-01 11:28:39 +05:30
Cargo.toml CI: coverage build step 2021-05-08 13:59:13 +05:30
code_of_conduct.md added code_of_conduct.md 2021-05-02 18:13:13 +05:30
DEVELOPMENT.md docs: dev environment instructions 2021-04-11 14:08:14 +05:30
Dockerfile Dockerfile init 2021-05-04 10:30:22 +05:30
jest.config.ts removelevelbutton tests 2021-05-07 21:14:15 +05:30
LICENSE.md licence 2021-03-09 17:49:20 +05:30
Makefile build tools: webpack with typescript and scss compilation 2021-05-05 23:21:59 +05:30
openapi.yaml update openapi spec 2021-04-11 22:59:35 +05:30
package.json registration tests 2021-05-06 13:48:28 +05:30
README.md docs: dev environment instructions 2021-04-11 14:08:14 +05:30
sailfish.yml frontend integration 2021-04-09 14:21:43 +05:30
tsconfig.json addlevelbutton test 2021-05-07 15:21:27 +05:30
webpack.config.js addlevelbutton test 2021-05-07 15:21:27 +05:30
yarn-error.log registration tests 2021-05-06 13:48:28 +05:30
yarn.lock registration tests 2021-05-06 13:48:28 +05:30

README.md

mCaptcha Guard

Back-end component of mCaptcha

Documentation CI (Linux) dependency status codecov
AGPL License

Guard is the back-end component of mCaptcha system.

STATUS: UNUSABLE BUT ACTIVE DEVELOPMENT

Development:

See DEVELOPMENT.md

How to build

  • Install Cargo using rustup with:
$ curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
  • Clone the repository with:
$ git clone https://github.com/mCaptcha/guard
  • Build with Cargo:
$ cd guard && cargo build

Configuration:

Guard is highly configurable. Configuration is applied/merged in the following order:

  1. config/default.toml
  2. environment variables.

Setup

Environment variables:

Setting environment variables are optional. The configuration files have all the necessary parameters listed. By setting environment variables, you will be overriding the values set in the configuration files.

Database:
Name Value
GUARD_DATEBASE_PASSWORD Postgres password
GUARD_DATEBASE_NAME Postgres database name
GUARD_DATEBASE_PORT Postgres port
GUARD_DATEBASE_HOSTNAME Postgres hostmane
GUARD_DATEBASE_USERNAME Postgres username
GUARD_DATEBASE_POOL Postgres database connection pool size
Server:
Name Value
GUARD_SERVER_PORT (or) PORT** The port on which you want wagon to listen to
GUARD_SERVER_IP The IP address on which you want wagon to listen to
GUARD_SERVER_STATIC_FILES_DIR Path to directory containing static files