Thanks to visit codestin.com
Credit goes to github.com

Skip to content

PrivateCaptcha/self-hosting

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

40 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Private Captcha self-hosting

Legal

Private Captcha is free for non-commercial use (community edition). Commercial use (enterprise edition) is a subject to EULA and requires obtaining a license.

Quick start

NOTE: Please visit the official quickstart docs for up-to-date instructions.


Basic instructions

1. Clone the repo

git clone https://github.com/PrivateCaptcha/self-hosting.git private-captcha
cd private-captcha

2. Create .env file

cp .env.example .env
$EDITOR .env

Now edit .env file to set your values. You can find full documentation about environment variables here.

Tips for local use

To run Private Captcha only locally, use privatecaptcha.local:8080 instead of yourdomain.com. To make it work, you need to add a few lines to /etc/hosts file:

127.0.0.1       portal.privatecaptcha.local
127.0.0.1       api.privatecaptcha.local
127.0.0.1       cdn.privatecaptcha.local

NOTE: email with .local domain is not a valid RFC-5322 address, so for 2FA code (required for login) you will need to find "two factor code" from docker logs manually

3. Run the stack

docker compose up

4. Navigate to the Portal

Now you can open $PC_PORTAL_BASE_URL (e.g. portal.yourdomain.com or http://portal.privatecaptcha.local) in browser and log in.

NOTE: For local-only use, when asked for a verification code, you might need to find it in the logs of privatecaptcha container. Search for "two factor code".

Advanced configuration

Please refer to the official documentation which contains descriptions of all configuration options.

Enterprise edition

There are a few changes you will need to make using a compose.override.yml file, namely replace privatecaptcha image to privatecaptcha-ee and set an additional environment variable EE_LICENSE_KEY (which you should do in the .env file).

services:
  privatecaptcha:
    image: ghcr.io/privatecaptcha/privatecaptcha-ee:latest
    environment:
      - EE_LICENSE_KEY=${EE_LICENSE_KEY}
  migration:
    image: ghcr.io/privatecaptcha/privatecaptcha-ee:latest

About

Self-hosting instructions for Private Captcha

Resources

Stars

Watchers

Forks

Contributors 2

  •  
  •