Skip to content

Commit 44d4fa6

Browse files
committed
#1323 cleanup OCS references and minor copyedits
1 parent c70626a commit 44d4fa6

11 files changed

+34
-39
lines changed

admin-guide/3.3/en/data-import-and-export.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -154,10 +154,10 @@ If you are importing users into OJS, first create the XML import file. [See the
154154
Here are some things to consider:
155155

156156
* Be sure to define the document type appropriately using `<!DOCTYPE ...>`.
157-
* Your XML file should UTF8-encoded.
157+
* Your XML file should be UTF8-encoded.
158158
* `<firstname>`, `<lastname>` and `<email>` are mandatory.
159159
* If you allow the system to generate passwords for the users you are uploading, you can optionally allow the system to email the users with their account credentials. This option can be found on the Users XML Plugin Page \("Send a notification email to each imported user containing the user's username and password."\).
160-
* You can require the user change their password when they next log in by setting the password attribute "change" to "true": `<password must\_change="true">`myoldpassword`</password>`
160+
* You can require the user changes their password when they next log in by setting the password attribute "change" to "true": `<password must\_change="true">`myoldpassword`</password>`
161161
* The default password encryption is "plaintext" \(ie., none\). Encrypted assumes it was encrypted by `Validation::encryptCredentials()` and is using the same encryption algorithm used by the system.
162162
* If the imported file contains any usernames or email addresses that already exist in the system, the user data for those users will not be imported and any new roles to be created will be assigned to the existing users.
163163

admin-guide/3.3/en/email.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ version: 3.3
44
---
55
# Email
66

7-
This chapter explains how emails are sent in OJS, OMP, and OCS; the configuration options that are available; and how to troubleshoot email issues.
7+
This chapter explains how emails are sent in OJS, OMP, and OPS; the configuration options that are available; and how to troubleshoot email issues.
88

99
Mail in PKP software applications uses [the PHPMailer library](https://github.com/PHPMailer/PHPMailer). You can find out more about PHPMailer on [their wiki](https://github.com/PHPMailer/PHPMailer/wiki). Other code related to mail can be found in [the pkp-lib mail class](https://github.com/pkp/pkp-lib/tree/main/classes/mail).
1010

@@ -70,7 +70,7 @@ By default, PHPMailer will send mail through PHP's built-in `mail()` facility.
7070

7171
On Windows, PHP needs to be configured to send email through a SMTP server \(running either on the same machine or on another machine\).
7272

73-
On other platforms such as Linux and Mac OS X, PHP will sent mail using the local sendmail client, so a local MTA such as Sendmail or Postfix must be running and configured to allow outgoing mail.
73+
On other platforms such as Linux and Mac OS X, PHP will send mail using the local sendmail client, so a local MTA such as Sendmail or Postfix must be running and configured to allow outgoing mail.
7474

7575
See [https://www.php.net/manual/en/function.mail.php](https://www.php.net/manual/en/function.mail.php) for more details on configuring PHP's mail functionality.
7676

@@ -96,9 +96,7 @@ Reloading templates will override any modifications that you may have made. To k
9696

9797
All PKP applications require that primary and technical contacts are configured under Setup for proper daily operations. This is required for every journal, press, or conference in the system.
9898

99-
- In OJS 2.x, this can be done under _Setup Step 1_.
100-
- In OCS 2.x, this can be done under _Website Management Step 1_.
101-
- In OJS/OMP 3.x, this can be done under _Settings &gt; Journal &gt; Contact_.
99+
In OJS/OMP/OPS 3.x, this can be done under _Settings &gt; Journal/Press/Server &gt; Contact_.
102100

103101
## Email Validation for New Users
104102

admin-guide/3.3/en/securing-your-system.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,13 @@ Please see [https://pkp.sfu.ca/ojs/README](https://pkp.sfu.ca/ojs/README), [http
1010

1111
In general, the `files_dir` should not be web accessible and should be placed outside of the main software install directory. The software application will manage access to private submission files based on user roles and permissions \(i.e. Editors will have access to all submission files, whereas authors will only be able to access their own submission files\).
1212

13-
In addition, to ensure security the `files_dir` folder should not be readable by other users on the server. Only the webserver should have the necessary read/write permissions so that OJS, OMP, or OCS can read existing files and add new files to the folder, e.g.
13+
In addition, to ensure security the `files_dir` folder should not be readable by other users on the server. Only the webserver should have the necessary read/write permissions so that OJS, OMP, or OPS can read existing files and add new files to the folder, e.g.
1414

1515
`drwxrwx--- 6 ojs www 204B 11 Sep 2017 files/`
1616

1717
The exact details of file permissions will depend on how your web server runs PHP scripts (this is called the "server API" or "SAPI"). For example, if it uses `mod_php`, all PHP scripts will run as the `www-data` user or similar (this is inherently not 100% secure on a multi-user server). If it uses CGI, FastCGI, FPM, or a similar mechanism, it will likely run under your user account.
1818

19-
It is recommended that you install an SSL certificate for your OJS, OMP, or OCS install and ensure that your site always uses the HTTPS protocol to manage user registration, login, and to present content to readers. Once your SSL certificate has been installed and is confirmed to be working \(i.e. you can access your site via [https://myjournal.org](https://myjournal.org/)\) you can configure your site to always use HTTPS by using the following setting in `config.inc.php`:
19+
It is recommended that you install an SSL certificate for your OJS, OMP, or OPS install and ensure that your site always uses the HTTPS protocol to manage user registration, login, and to present content to readers. Once your SSL certificate has been installed and is confirmed to be working \(i.e. you can access your site via [https://myjournal.org](https://myjournal.org/)\) you can configure your site to always use HTTPS by using the following setting in `config.inc.php`:
2020

2121
`; Force SSL connections site-wide
2222
force_ssl = On`
@@ -37,16 +37,16 @@ salt = "sdlkjfhleiqwrfgbksdlkjgbelruywoeiyt7384gdqlywqvlwjf"`
3737
3838
A secure deployment of PKP software can be best achieved by using the following recommendations, which are described in docs/README in every download of the software:
3939

40-
* Dedicate a database to OJS, OMP, and OCS; use unique credentials to access it. Configure this database to perform automated backups on a regular basis. Perform a manual backup when upgrading or performing maintenance. If you do not have access to your database contact your system administrator and ensure that database backups are taking place for your OJS.
40+
* Dedicate a database to OJS, OMP, and OPS; use unique credentials to access it. Configure this database to perform automated backups on a regular basis. Perform a manual backup when upgrading or performing maintenance. If you do not have access to your database contact your system administrator and ensure that database backups are taking place for your OJS.
4141
* Configure the software (`config.inc.php`) to use SHA1 hashing rather than MD5.
4242
* Enable captcha or recaptcha in your `config.inc.php` file, and test that they are working. This will prevent most spam user registrations.
4343
* Configure the software (`config.inc.php`) to use `force_login_ssl` so that authenticated users communicate with the server via HTTPS. (You will also have to properly create and configure an SSL certificate to do this properly.)
44-
* Install the software so that the files directory is NOT a subdirectory of the OJS, OMP, or OCS installation and cannot be accessed directly via the web server.
44+
* Install the software so that the files directory is NOT a subdirectory of the OJS, OMP, or OPS installation and cannot be accessed directly via the web server.
4545
* Restrict file permissions as much as possible.
4646
* Deploy and test a proper backup mechanism. The backup mechanism should back up the database, the system files, and the file storage area (the `files_dir` parameter in `config.inc.php`). Ideally, you should make both on-site and off-site backups.
4747
* Ensure that your web server environment is regularly updated, in particular with any and all security patches.
4848

49-
If these steps are followed, you will substantially reduce the risk of falling prey to common hacking techniques. If already running OJS, OMP, or OCS, we strongly urge you to review your existing configurations and ensure these steps have been followed.
49+
If these steps are followed, you will substantially reduce the risk of falling prey to common hacking techniques. If already running OJS, OMP, or OPS, we strongly urge you to review your existing configurations and ensure these steps have been followed.
5050

5151
### Secure File Management
5252

@@ -55,7 +55,7 @@ Authors, reviewers, and editors deal with submission files from people they don
5555
* Make sure you have antivirus software installed, and that it is up to date
5656
* Make sure your operating system and all software (especially Word and Excel) are kept up to date, ideally by turning on any auto-update features available to you
5757
* Make sure you have a backup solution available for your work computers
58-
* Practice good password management: don’t use the same username/password in OJS, OMP, or OCS as you would for any other online account, and don’t use an easy to guess password
58+
* Practice good password management: don’t use the same username/password in OJS, OMP, or OPS as you would for any other online account, and don’t use an easy to guess password
5959
* Treat everything that you get online with the knowledge that you received it from someone you don’t know, and act likewise. If a submission appears to be suspicious for any reason (strange email address, suspiciously generic title or abstract, etc.), treat the included files with an additional level of diligence.
6060

6161
## Encryption
@@ -76,7 +76,7 @@ Google announced in 2014 that https [would be treated as a ranking signal](https
7676

7777
### Getting a Certificate
7878

79-
A certificate enables a secure connection from the user's Web browser to the server hosting your site. Installing a certificate for your site can not be done within the OJS, OMP, or OCS software and will require technical expertise or assistance at the server level. When considering a software host, determining their level of certificate support is an important consideration.
79+
A certificate enables a secure connection from the user's Web browser to the server hosting your site. Installing a certificate for your site can not be done within the OJS, OMP, or OPS software and will require technical expertise or assistance at the server level. When considering a software host, determining their level of certificate support is an important consideration.
8080

8181
A good start is asking your hosting service provider if they have an existing solution for supporting TLS or SSL certificates -- Your hosting provider may be able to create/issue an TLS or SSL certificate for you. If you do not have shell access to your installation this may be the only way to go about adding SSL/TLS protection for your site.
8282

@@ -126,7 +126,7 @@ Don’t forget to test this setup by registering a test account and confirming t
126126

127127
### Enable Account Validation
128128

129-
OJS, OMP, and OCS can be configured so that an email account validation step must be completed for all new user accounts before they can log in and interact with the system. To do this, uncomment and configure the following lines in `config.inc.php`:
129+
OJS, OMP, and OPS can be configured so that an email account validation step must be completed for all new user accounts before they can log in and interact with the system. To do this, uncomment and configure the following lines in `config.inc.php`:
130130

131131
```
132132
; If enabled, email addresses must be validated before login is possible.

admin-guide/3.3/en/single-signon.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ version: 3.3
44
---
55
# User Authentication and Single Sign-on
66

7-
For synchronizing user accounts across multiple applications, OJS and OCS support LDAP and Shibboleth, both of which have varying degrees of support in other applications including PhpBB, Drupal, WordPress, and other content management systems.
7+
For synchronizing user accounts across multiple applications, OJS supports LDAP and Shibboleth, both of which have varying degrees of support in other applications including PhpBB, Drupal, WordPress, and other content management systems.
88

99
*LDAP* (the Lightweight Directory Access Protocol), while not as powerful as Shibboleth (e.g. LDAP does not support single sign-on, where logging into one service automatically logs into all others), is a common choice for centralizing authentication on a server. A popular LDAP implementation is [OpenLDAP](https://www.openldap.org/) an open source implementation of the protocol.
1010

@@ -13,8 +13,6 @@ For synchronizing user accounts across multiple applications, OJS and OCS suppor
1313

1414
## Setting up Shibboleth
1515

16-
*Note*: Please note that Shibboleth support has not yet been ported to OCS.
17-
1816
Shibboleth is maintained by the [Internet2 Middleware Initiative](http://shibboleth.internet2.edu/), and as such their website provides a central location for downloads and documentation. Currently, they provide Shibboleth Service Provider 2.1 in binary form for all major operating systems, as well as providing source code. For further information on installing and setting up the Shibboleth Service Provider, please consult Internet2's support documentation.
1917

2018
Once Shibboleth is set up on your system, integration with your PKP application requires the use of the [Shibboleth plugin](https://github.com/pkp/shibboleth) from the Plugin Gallery. After enabling this plugin, visit the plugin's Settings page for instructions on configuration.

admin-guide/3.4/en/data-import-and-export.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ There are many ways to import and export data with OJS, OMP and OPS. To access t
1111

1212
## REST API
1313

14-
You can use the REST API to read and write some data in the application. See the [api documentation](https://docs.pkp.sfu.ca/dev/api).
14+
You can use the REST API to read and write some data in the application. See the [API documentation](https://docs.pkp.sfu.ca/dev/api).
1515

1616
## Native XML
1717

@@ -76,7 +76,7 @@ There are a few ways to import or export user accounts. User accounts control ac
7676

7777
### REST API
7878

79-
See the [api documentation](https://docs.pkp.sfu.ca/dev/api) to see what user data can be read or written with the REST API.
79+
See the [API documentation](https://docs.pkp.sfu.ca/dev/api) to see what user data can be read or written with the REST API.
8080

8181
### CSV
8282

@@ -129,7 +129,7 @@ Consider the following when creating your xml import file.
129129

130130
## Export to Services
131131

132-
Each application provides plugins to export published metadata to indexing services, such as Crossref, PubMed, DataCite, DOAJ, MEDRA and more. Some of these plugins deposit directly to the services. Others generate an export file according to the service's specifications.
132+
Each application provides plugins to export published metadata to indexing services, such as Crossref, PubMed, DataCite, DOAJ, mEDRA and more. Some of these plugins deposit directly to the services. Others generate an export file according to the service's specifications.
133133

134134
Go to **Settings** > **Website** > **Plugins** to install and configure these plugins. Our [user documentation hub](/) provides guidance for working with many of them.
135135

admin-guide/3.4/en/deploy-email.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Your hosting service should provide instructions on how to add the `TXT` record.
2020

2121
## DMARC
2222

23-
To comply with the the [DMARC](https://en.wikipedia.org/wiki/Sender_Policy_Framework) framework, the application must be configured with an envelope sender. The envelope sender is an email address that the server has permission to send as. For example, if the application is hosted at https://my-journals.com, the envelope sender should be an email address `@my-journals.com`.
23+
To comply with the [DMARC](https://en.wikipedia.org/wiki/Sender_Policy_Framework) framework, the application must be configured with an envelope sender. The envelope sender is an email address that the server has permission to send as. For example, if the application is hosted at https://my-journals.com, the envelope sender should be an email address `@my-journals.com`.
2424

2525
When a user signs up to the application with the email address `[email protected]`, your email server does not have permission to send as `[email protected]`. The envelope sender acts as the "true" sender, and the email is sent "on behalf of" `[email protected]`.
2626

admin-guide/3.4/en/securing-your-system.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ version: 3.4
1010
> This section describes how to run a secure server. Before reading this section, make sure you have followed the [recommended configuration](./deploy) instructions to secure the application.
1111
{:.warning}
1212

13-
It's important to run OJS, OMP and OPS on a secure server environment. In addition to the security settings in the [recommended configuration](./deploy) of the application, you must ensure the server is secure where the applicaiton is run.
13+
It's important to run OJS, OMP and OPS on a secure server environment. In addition to the security settings in the [recommended configuration](./deploy) of the application, you must ensure the server is secure where the application is run.
1414

1515
This section makes a few recommendations for running secure servers. However, if you are unfamiliar with server administration, we strongly encourage you to use a professional hosting service or hire a professional system administrator.
1616

@@ -44,7 +44,7 @@ The following section describes how to get a SSL certificate, enable it, and con
4444

4545
### Getting a Certificate
4646

47-
A certificate enables a secure connection from the user's Web browser to the server hosting your site. Installing a certificate for your site can not be done within the OJS, OMP, or OCS software and will require technical expertise or assistance at the server level. When considering a software host, determining their level of certificate support is an important consideration.
47+
A certificate enables a secure connection from the user's Web browser to the server hosting your site. Installing a certificate for your site can not be done within the OJS, OMP, or OPS software and will require technical expertise or assistance at the server level. When considering a software host, determining their level of certificate support is an important consideration.
4848

4949
A good start is asking your hosting service provider if they have an existing solution for supporting TLS or SSL certificates -- Your hosting provider may be able to create/issue an TLS or SSL certificate for you. If you do not have shell access to your installation this may be the only way to go about adding SSL/TLS protection for your site.
5050

@@ -72,4 +72,3 @@ Required step to generate a certificate if you are going to be purchasing a cert
7272
When you purchase a certificate from a CA, you will typically purchase a certificate that lasts between 1 to 3 years. Certificates are set to expire and will need to be renewed resulting in a new expense at the time of renewal. Let’s Encrypt certificates expire every 90 days. The Let’s Encrypt software (certbot) can be configured to automatically renew certificates before they expire. Meaning once installed you should have minimal maintenance moving forward. Automation is done with `cron` or `systemd`.
7373

7474
> Contributors: PKP staff, Kenton Good
75-

0 commit comments

Comments
 (0)