mirrors/mCaptcha
1
0
Fork 0
mirror of https://github.com/mCaptcha/mCaptcha.git synced 2024-11-27 03:48:52 +03:00
Code Issues Projects Releases Packages Wiki Activity
A no-nonsense CAPTCHA system with seamless UX | Backend component
39 commits 42 branches 2 tags 36 MiB
JavaScript 80.8%
Rust 11.7%
TypeScript 4.3%
HTML 1.8%
SCSS 0.9%
Other 0.4%
Find a file
realaravinth d7b1a9f29b
wip makefile
2021-04-08 15:49:55 +05:30
.github/workflows CI: tarpaulin env var 2021-04-02 11:28:11 +05:30
config m_captcha bump and gc config in settings 2021-03-24 14:31:11 +05:30
docs OAS: yaml to json 2021-04-01 15:23:36 +05:30
frontend wip makefile 2021-04-08 15:49:55 +05:30
migrations domain verification 2021-03-26 22:18:01 +05:30
src wip makefile 2021-04-08 15:49:55 +05:30
templates panel 2021-04-05 16:38:32 +05:30
.gitignore wip makefile 2021-04-08 15:49:55 +05:30
build.rs OAS: yaml to json 2021-04-01 15:23:36 +05:30
Cargo.lock panel 2021-04-05 16:38:32 +05:30
Cargo.toml frontend templating 2021-04-03 17:18:18 +05:30
LICENSE.md licence 2021-03-09 17:49:20 +05:30
Makefile wip makefile 2021-04-08 15:49:55 +05:30
openapi.yaml OAS: example payload 2021-03-31 15:27:23 +05:30
README.md readme and env var prefix 2021-03-10 21:55:39 +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

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