Pepperminty-Wiki/docs/04-Getting-Started.md

# Getting Started

## System Requirements
- PHP-enabled web-server (must be PHP 7+)
- PHP session support (for logging in, see [here](https://php.net/manual/en/session.installation.php) for more information)
- The following PHP extensions:
    - `mbstring` (for utf8 string handling - currently **required**)
    - `imagick` (for preview generation)
    - `fileinfo` (for proper mime type checking of uploaded files)
    - `zip` (for compressing exports)
    - `intl` (for Unicode text normalization when searching and in the id index, and when sending emails when utf-8 mode is disabled)
    - `sqlite` (for search index storage; uses [PDO](https://www.php.net/manual/en/ref.pdo-sqlite.php))
- Write access to Pepperminty Wiki's own folder (only for editing)
- Recommended: Block access to `peppermint.json`, where it stores it's settings

## Setup Instructions
1. Once you've ensured your web server meets the requirements, obtain a copy of Pepperminty Wiki (see _[Getting a copy](05-Getting-A-Copy.html)_).
2. Put the `index.php` file on your web server.
3. Navigate to Pepperminty Wiki in your web browser. If you uploaded the `index.php` to `wiki/` on your web server `bobsrockets.com`, then you should navigate to `bobsrockets.com/wiki/`.
4. See the [Configuring](06-Configuration.html) section for information on how to customise your installation, including the default login credentials.
5. Ensure you configure your web server to block access to `peppermint.json`, as this contains all your account details (including your hashed password!)
Fill out the remaining documentation sections 2018-12-12 22:05:48 +00:00			`# Getting Started`

			`## System Requirements`
			`- PHP-enabled web-server (must be PHP 7+)`
			`- PHP session support (for logging in, see [here](https://php.net/manual/en/session.installation.php) for more information)`
			`- The following PHP extensions:`
			- `mbstring` (for utf8 string handling - currently required)
			- `imagick` (for preview generation)
			- `fileinfo` (for proper mime type checking of uploaded files)
			- `zip` (for compressing exports)
Fix command and PHP module checks in build system - closes #178 2019-12-24 17:32:45 +00:00			- `intl` (for Unicode text normalization when searching and in the id index, and when sending emails when utf-8 mode is disabled)
Do some documentation work, and add missing help sections 2019-08-24 18:56:14 +00:00			- `sqlite` (for search index storage; uses [PDO](https://www.php.net/manual/en/ref.pdo-sqlite.php))
Fill out the remaining documentation sections 2018-12-12 22:05:48 +00:00			`- Write access to Pepperminty Wiki's own folder (only for editing)`
			- Recommended: Block access to `peppermint.json`, where it stores it's settings

			`## Setup Instructions`
URL fixes 2019-09-11 01:31:37 +00:00			`1. Once you've ensured your web server meets the requirements, obtain a copy of Pepperminty Wiki (see _[Getting a copy](05-Getting-A-Copy.html)_).`
Fill out the remaining documentation sections 2018-12-12 22:05:48 +00:00			2. Put the `index.php` file on your web server.
			3. Navigate to Pepperminty Wiki in your web browser. If you uploaded the `index.php` to `wiki/` on your web server `bobsrockets.com`, then you should navigate to `bobsrockets.com/wiki/`.
sbrl req 2019-09-18 04:01:28 +00:00			`4. See the [Configuring](06-Configuration.html) section for information on how to customise your installation, including the default login credentials.`
Fill out the remaining documentation sections 2018-12-12 22:05:48 +00:00			5. Ensure you configure your web server to block access to `peppermint.json`, as this contains all your account details (including your hashed password!)