website/docs/self-hosting/index.xml

40 lines
3.7 KiB
XML

<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom">
<channel>
<title>Self-Hosting on </title>
<link>/docs/self-hosting/</link>
<description>Recent content in Self-Hosting on </description>
<generator>Hugo -- gohugo.io</generator>
<language>en-US</language>
<atom:link href="/docs/self-hosting/index.xml" rel="self" type="application/rss+xml" />
<item>
<title>Getting started</title>
<link>/docs/self-hosting/getting-started/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>/docs/self-hosting/getting-started/</guid>
<description>Get started There are two main ways to self-host mCaptcha:&#xA;Bare metal With Docker With Ansible </description>
</item>
<item>
<title>Deploy bare metal</title>
<link>/docs/self-hosting/bare-metal/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>/docs/self-hosting/bare-metal/</guid>
<description>1. Install Database The following databases are supported:&#xA;Postgres MariaDB Please install the database of your choice. Then:&#xA;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:&#xA;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.</description>
</item>
<item>
<title>Using Ansible</title>
<link>/docs/self-hosting/ansible/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>/docs/self-hosting/ansible/</guid>
<description>Ansible playbooks to install mCaptcha are available here.&#xA;Instructions Installation Clone the repository: 1git clone https://git.batsense.net/mCaptcha/iac &amp;amp;&amp;amp; cd iac Create inventory file. You should have SSH access to the remote machine, and the user must have sudo privileges. Example inventory file:&#xA;1[mcaptcha_hosts] 2&amp;#34;mcaptcha_hosts&amp;#34; 3&amp;lt;node name&amp;gt; ansible_host=&amp;lt;node IP&amp;gt; ansible_user=&amp;lt;remote username&amp;gt; It is important that the group name be mcaptcha_hosts.&#xA;Configure installation by editing ansible/vars/mcaptcha/vars.yml. Most parameters have defaults, and the required parameters are annotated.</description>
</item>
<item>
<title>Using Docker</title>
<link>/docs/self-hosting/docker/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>/docs/self-hosting/docker/</guid>
<description>With Docker 1. Configure mcaptcha is highly configurable.&#xA;Configuration is applied/merged in the following order:&#xA;path to configuration file passed in via MCAPTCHA_CONFIG ./config/default.toml /etc/mcaptcha/config.toml environment variables. See CONFIGURATION.md for configurable options.&#xA;2. Run image If you have already have a Postgres instance running, then:&#xA;docker run -p &amp;lt;host-machine-port&amp;gt;:&amp;lt;port-in-configuration-file&amp;gt; \ --add-host=database:&amp;lt;database-ip-addrss&amp;gt; \ -e RUST_LOG=debug \ -e DATABASE_URL=&amp;#34;postgres://&amp;lt;db-user&amp;gt;:&amp;lt;db-password&amp;gt;@database:&amp;lt;db-port&amp;gt;/&amp;lt;db-name&amp;gt;&amp;#34; \ mcaptcha/mcaptcha:latest If you don&amp;rsquo;t have a Postgres instance running, you can either install one using a package manager or launch one with docker.</description>
</item>
</channel>
</rss>