Skip to content

Commit bf7828f

Browse files
committed
add details about altcha
1 parent b9980e9 commit bf7828f

File tree

3 files changed

+42
-12
lines changed

3 files changed

+42
-12
lines changed

admin-guide/en/deploy-jobs.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ Replace the following variables in the configuration above with the correct path
6464
| `<root>` | Absolute path to the root directory of the application (OJS, OMP, OPS). |
6565
| `<log-file>` | Absolute path to a log file. If hosting in a cloud environment, you may want to [direct logs to stdout](https://stackoverflow.com/a/26897648/1723499). |
6666

67-
> Take a special note that workers are long running process that loads the application in memory. As a result, any changes when workers are running will not reflect instantly without restarting the worker.
67+
> Take note that workers are long-running processes that load the application in memory. As a result, any changes when workers are running will not reflect instantly without restarting the worker.
6868
{:.notice}
6969

7070
Restart Worker.
@@ -154,7 +154,7 @@ job_runner_max_jobs = 30
154154
; Lower this setting if jobs are failing due to timeouts.
155155
job_runner_max_execution_time = 30
156156
157-
; The maximum consumerable memory that should be spent by the built-in
157+
; The maximum consumable memory that should be spent by the built-in
158158
; job runner when running jobs.
159159
;
160160
; Set as a percentage, such as 80%:

admin-guide/en/deploy-users.md

Lines changed: 32 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,9 @@ require_validation = On
2727

2828
Google's [reCAPTCHA](https://www.google.com/recaptcha/) service can be enabled for the registration and login forms. This will reduce the number of bots that can sign up by requiring users to complete a task that is difficult for bots to perform during registration and login.
2929

30-
You will need to [sign up](https://www.google.com/recaptcha/) for an account with Google to receive public and private keys. Then set the following options in `config.inc.php`.
30+
You will need to [sign up for a Google account](https://www.google.com/recaptcha/) to receive public and private keys.
31+
32+
To enable reCAPTCHA, set the following options in `config.inc.php`.
3133

3234
```
3335
;;;;;;;;;;;;;;;;;;;;
@@ -57,6 +59,34 @@ recaptcha_enforce_hostname = Off
5759

5860
Use of Google's reCAPTCHA service will send your visitors' data to Google's servers. You may be required to notify users of this depending on the privacy laws in your jurisdiction.
5961

62+
### Altcha
63+
64+
[ALTCHA](https://altcha.org/open-source-captcha/) is an open-source and self-hosted alternative to Google's reCAPTCHA. ALTCHA can be enabled to reduce spam activity on registration, login, and password reset forms.
65+
66+
You will need to set up a self-hosted installation to create a private key. Review [the ALTCHA documentation](https://altcha.org/docs/v2/) for more information.
67+
68+
Once you have a private key for ALTCHA, set the following options in `config.inc.php`:
69+
70+
```
71+
; Whether or not to enable ALTCHA
72+
altcha = on
73+
74+
; Private key for ALTCHA
75+
altcha_hmackey = 'Example key'
76+
77+
; Whether or not to use ALTCHA on user registration
78+
altcha_on_register = on
79+
80+
; Whether or not to use ALTCHA on user login
81+
altcha_on_login = on
82+
83+
; Whether or not to use ALTCHA on user lost password
84+
altcha_on_lost_password = on
85+
86+
; The quantity of encryption cycles performed by the ALTCHA system
87+
altcha_encrypt_number = 10000
88+
```
89+
6090
### Honeypot
6191

6292
The [pkp-formHoneypot](https://github.com/ulsdevteam/pkp-formHoneypot) plugin from the University of Pittsburgh implements a [honeypot](https://en.wikipedia.org/wiki/Honeypot_(computing)) mechanism to protect new user registrations from bots. This plugin is effective against most bots and does not send your visitor's data to any third parties.
@@ -157,4 +187,4 @@ Learn how to import or export data about user accounts in the [Import/Export](./
157187

158188
---
159189

160-
The next section describes best practices for running lots of independent journals, presses or preprint servers from one [multi-tenant install](./deploy-multi-tenant).
190+
The next section describes best practices for running lots of independent journals, presses or preprint servers from one [multi-tenant install](./deploy-multi-tenant).

admin-guide/en/deploy.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ In a production environment, the software needs to be configured to send email,
1414

1515
## What you need to know
1616

17-
In order to run this software securely, you will need to understand how to do the following:
17+
To run this software securely, you will need to understand how to do the following:
1818

1919
- Upload and edit files on your web server
2020
- Modify file permissions on your web server
@@ -31,9 +31,9 @@ If you are unfamiliar with some of these topics, you may be able to learn by fol
3131

3232
The configuration file is found in the root directory of the application. For example, if you installed the software to the directory `/var/www`, the configuration file would be located at `/var/www/config.inc.php`.
3333

34-
Some of the settings in this file, like the database connection, are set during the installation process (see [Getting Started](./getting-started)). However, you will need to edit the file directly to configure other settings.
34+
Some settings in this file, like the database connection, are set during the installation process (see [Getting Started](./getting-started)). However, you will need to edit the file directly to configure other settings.
3535

36-
Open the config file, find the `base_url` setting and change it to the web address of your install.
36+
Open the config file, find the `base_url` setting, and change it to the web address of your installation.
3737

3838
```
3939
base_url = "<url>"
@@ -45,15 +45,15 @@ Add this domain to your `allowed_hosts` list.
4545
allowed_hosts = '["<url>"]'
4646
```
4747

48-
Two secret keys need to be set in order to safely encrypt secure tokens on your server. You can use the following command to generate a random key in most Linux and Mac environments.
48+
Two secret keys need to be set to safely encrypt secure tokens on your server. You can use the following command to generate a random key in most Linux and Mac environments.
4949

5050
```bash
5151
openssl rand -base64 32
5252
```
5353

5454
Use the string created by this command to set the `salt` and `api_key_secret` values in `config.inc.php`. Each config setting should have a different value.
5555

56-
(We have not provided an example, because copying the example could compromise your site's security.)
56+
(We have not provided an example because copying the example could compromise your site's security.)
5757

5858
Set the `require_validation` in order to require new users to validate their email addresses before using a new account.
5959

@@ -119,7 +119,7 @@ validation_timeout = 14
119119

120120
## SSL / HTTPS
121121

122-
Every site should encrypt it's web traffic using a SSL certificate. This will make your site run from `https://` instead of `http://`. If you don't have a SSL certificate, you should [get one](./securing-your-system#sslencryption).
122+
Every site should encrypt its web traffic using an SSL certificate. This will make your site run from `https://` instead of `http://`. If you don't have an SSL certificate, you should [get one](./securing-your-system#sslencryption).
123123

124124
Edit the `config.inc.php` file to force URLs to use SSL:
125125

@@ -145,7 +145,7 @@ Learn more about how to configure the [job runner](./deploy-jobs).
145145

146146
## Pretty URLs
147147

148-
Enable URL rewriting on your server in order to drop the `index.php` from URLs. For example, instead of `https://example.org/index.php/publicknowledge`, the URL will be `https://example.org/publicknowledge`.
148+
Enable URL rewriting on your server to drop the `index.php` from URLs. For example, instead of `https://example.org/index.php/publicknowledge`, the URL will be `https://example.org/publicknowledge`.
149149

150150
The following is an example `.htaccess` file that can be used to enable `mod_rewrite` for Apache servers. This file should be placed in the web root.
151151

@@ -171,4 +171,4 @@ The configuration file includes settings to control the default date formats, ma
171171

172172
---
173173

174-
You've now configured all of the critical application functions. Next, you can learn how to configure your [email server](./deploy-email) to reliably deliver email.
174+
You've now configured all the critical application functions. Next, you can learn how to configure your [email server](./deploy-email) to reliably deliver email.

0 commit comments

Comments
 (0)