Self-Hosting on

Getting started

Mon, 01 Jan 0001 00:00:00 +0000

Get started

There are two main ways to self-host mCaptcha:

«««< Updated upstream

Stashed changes

Deploy bare metal

Mon, 01 Jan 0001 00:00:00 +0000

1. Install Database

The following databases are supported:

Postgres
MariaDB

Please install the database of your choice. Then:

Create new database user for mCaptcha
Create new database for mCaptcha

mCaptcha binary has migrations baked-in and is applied on start up. The choice of database is described using the scheme of the database URL. For instance:

Postgres: postgres://mcaptcha:password@localhost:5432/mcaptcha
Mariadb: mysql://mcaptcha:password@localhost:3306/mcaptcha

2. Optionally, install mCaptcha/cache

We recommend this for larger instances. For single-user instances or for instances that protect personal websites, we recommend using the internal cache system. To do so, please comment out the redis section of the configuration file.

Using Ansible

Mon, 01 Jan 0001 00:00:00 +0000

Ansible playbooks to install mCaptcha are available here.

Instructions

Installation

Clone the repository:

1git clone https://git.batsense.net/mCaptcha/iac && cd iac

Create inventory file. You should have SSH access to the remote machine, and the user must have sudo privileges. Example inventory file:

1[mcaptcha_hosts]
2"mcaptcha_hosts"
3<node name> ansible_host=<node IP> ansible_user=<remote username>


Using Docker
Mon, 01 Jan 0001 00:00:00 +0000
With Docker
1. Configure
mcaptcha is highly configurable.
Configuration is applied/merged in the following order:

path to configuration file passed in via MCAPTCHA_CONFIG
./config/default.toml
/etc/mcaptcha/config.toml
environment variables.

See
CONFIGURATION.md
for configurable options.
2. Run image
If you have already have a Postgres instance running, then:
docker run -p <host-machine-port>:<port-in-configuration-file> \
	--add-host=database:<database-ip-addrss> \
	-e RUST_LOG=debug \
	-e DATABASE_URL="postgres://<db-user>:<db-password>@database:<db-port>/<db-name>" \
	mcaptcha/mcaptcha:latest