-
Notifications
You must be signed in to change notification settings - Fork 227
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
#1090 Add Quick Start to admin guide and change config to Deployment … #1091
Merged
Merged
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,86 @@ | ||
--- | ||
title: Getting Started with OJS, OMP or OPS - Admin Guide - PKP Developer Docs | ||
description: A quick-start guide to install OJS, OMP or OPS in a test environment. | ||
book: admin-guide | ||
version: 3.4 | ||
--- | ||
|
||
# Getting Started | ||
|
||
This is a quick-start guide to install and run OJS, OMP or OPS in a local test environment. Use this guide to try out the software on your own or to install it to a private, test environment. Before hosting the installation on a public server, you should read the [Deployment](./deploy) guide to learn how to safely configure the application. | ||
|
||
## System Requirements | ||
|
||
Your server — or your local development environment — must meet the following requirements in order to run the 3.4 release of OJS, OMP or OPS. | ||
|
||
- [PHP 8.0+](http://www.php.net/) with php-mbstring, php-xml, and php-intl enabled | ||
- [MySQL 4.1+](http://www.mysql.com/), [MariaDB 4.1+](https://mariadb.org/) or [PostgreSQL 9.5+](http://www.postgresql.org/) | ||
- Linux, or one of the following: BSD, Solaris, Mac OS X, Windows | ||
|
||
> **Older Versions**: Check the README.md file located in the download package of the version you want to install. | ||
|
||
## Download | ||
|
||
Download the latest stable release package (`.tar.gz`) from the PKP website. | ||
|
||
- [Open Journal Systems](https://pkp.sfu.ca/software/ojs/download) (OJS) | ||
- [Open Monograph Press](https://pkp.sfu.ca/software/omp/download) (OMP) | ||
- [Open Preprint Systems](https://pkp.sfu.ca/software/ops/download) (OPS) | ||
|
||
Use the `tar` command, or any archive software on your system, to unpack the `.tar.gz` file to a local directory. For example, if you downloaded the OJS 3.4.0 release package, you can use the following command to unpack the file. | ||
|
||
``` | ||
tar -xvf ojs-3.4.0.tar.gz | ||
``` | ||
|
||
This will create a directory for the software at `ojs-3.4.0`. Create another directory for file uploads. | ||
|
||
``` | ||
mkdir ojs-files | ||
``` | ||
|
||
Start PHP's built-in server from the release package's root directory. | ||
|
||
``` | ||
cd ojs-3.4.0 | ||
php -S localhost:8000 | ||
``` | ||
|
||
## Install | ||
|
||
Open your browser and navigate to the installation page at the following URL. | ||
|
||
``` | ||
http://localhost:8000 | ||
``` | ||
|
||
You should see an installation screen like the one below. | ||
|
||
|
||
![Screenshot of the installation screen of OJS](./assets/install-start.png) | ||
|
||
Complete the form to finish the installation, using the file uploads directory that you created. It may take a minute to install. You should see the following success screen when it is finished. | ||
|
||
![Screenshot of the install complete screen of OJS](./assets/install-complete.png) | ||
|
||
Once you have finished the install, login with the administrator account you set up to access the admin area. Depending on whether you installed OJS, OMP or OPS, you will be taken to a screen where you can create your first journal, press or preprint server. | ||
|
||
- In OJS, click the **Add Journal** button. | ||
- In OMP, click the **Add Press** button. | ||
- In OPS, click the **Add Server** button. | ||
|
||
Once you have created your first journal, press, or preprint server, you will be taken to it's Settings Wizard. | ||
|
||
![Screenshot of the settings wizard screen for a new journal](./assets/settings-wizard.png) | ||
|
||
Click the **Users** tab to create a new user for the Journal Manager, Press Manager, or Server Manager who will be responsible for managing the journal, press or preprint server. | ||
|
||
And you're done! You've successfully installed the software and created a manager user account. Login as the manager to explore the software as it will appear to the managing user of the journal, press or preprint server. This is usually a managing editor, an editor-in-chief, or a publishing assistant responsible for the day-to-day running of the journal. Or you can stay logged in as the administrator to see all of the features available to you as an admin. | ||
|
||
To explore the software further, click the small icon at the top to switch to your new journal, press or preprint server. | ||
|
||
![Screenshot of the journal switcher in OJS](./assets/settings-wizard-context-switcher.png) | ||
|
||
--- | ||
|
||
Congratulations! The software is now installed and you can begin testing it out. In a real environment, you will need to ensure your install is configured correctly and secured properly. Learn how to [deploy the software](./deploy). |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add a warning that this needs to be outside the web root. (I know these are tryout instructions, but it's a very common mistake people make.)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These instructions are set up to do that automatically. The
tar
command creates a directoryojs-3.4.0
, then themkdir
command creates a directory beside it. The last command has them launch the web server from the ojs direcettory, so it will be separate unless someone has deliberately not followed the instructions.Do you still want me to add a warning here?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes -- anyplace we mention the files directory in the context of creating or moving it, we should warn people not to put it someplace web-accessible. This remains the leading cause of security problems.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ok, does this look alright? 0b7fd3f