mirrors/mCaptcha
1
0
Fork 0
mirror of https://github.com/mCaptcha/mCaptcha.git synced 2024-11-27 11:59:56 +03:00
Code Issues Projects Releases Packages Wiki Activity
A no-nonsense CAPTCHA system with seamless UX | Backend component
73 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 343c37ae1c
changed login route
2021-04-30 18:06:28 +05:30
.github/workflows CI: rm linting and mv doc into main config 2021-04-09 23:28:27 +05:30
config url prefix processing 2021-04-11 23:23:14 +05:30
docs OAS: yaml to json 2021-04-01 15:23:36 +05:30
migrations pow stats 2021-04-30 11:14:29 +05:30
src changed login route 2021-04-30 18:06:28 +05:30
static changed login route 2021-04-30 18:06:28 +05:30
templates changed login route 2021-04-30 18:06:28 +05:30
.gitignore color scheme 2021-04-16 23:57:36 +05:30
build.rs pow verification 2021-04-10 20:19:59 +05:30
Cargo.lock url prefix processing 2021-04-11 23:23:14 +05:30
Cargo.toml pow stats 2021-04-30 11:14:29 +05:30
DEVELOPMENT.md docs: dev environment instructions 2021-04-11 14:08:14 +05:30
LICENSE.md licence 2021-03-09 17:49:20 +05:30
Makefile changed login route 2021-04-30 18:06:28 +05:30
openapi.yaml update openapi spec 2021-04-11 22:59:35 +05:30
package.json frontend integration 2021-04-09 14:21:43 +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
webpack.common.js frontend integration 2021-04-09 14:21:43 +05:30
webpack.dev.js registration link correction 2021-04-09 15:03:50 +05:30
webpack.prod.js frontend integration 2021-04-09 14:21:43 +05:30
yarn.lock frontend integration 2021-04-09 14:21:43 +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