ulysia/szurubooru
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Updated Home (markdown)

Marcin Kurczewski 2016-03-08 21:45:10 +01:00
parent c3ac3c5cf9
commit 09a7582edd
1 changed files with 1 additions and 38 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

39
Home.md

@ -4,41 +4,4 @@ Szurubooru is powered by chibi, a lightweight PHP framework.
Its name have its roots in Polish language, has [onomatopeic meaning of scraping or scrubbing](http://sjp.pwn.pl/slownik/2527372/szuru-buru). It is pronounced _shoorubooru_.
# Quick Start Guide
Szurubooru differs from standard web applications. It has no installation wizard and has uncommon directory structure. Due to this, setting up szurubooru requires some explanation.
## Prerequisites
* A web server running PHP 5.5+ with SQLite, gd2, OpenSSL, fileinfo extensions enabled
* Some experience with web servers, installing web applications and/or git.
## Installation
1. Clone this repository somewhere or unpack downloaded repository archive.
**Notice**: Recursive git clone will download all required linked libraries automatically, otherwise you will need to download each of them manually. In git these are called submodules and you will find them in the `lib/` directory.
2. Setup your szurubooru installation.
1. **Method 1**: Change your web server configuration file to point at repo's `public_html/` directory (change `DocumentRoot` in `httpd.conf` on Apache web server or change it from server provider administration panel). If it's not possible or you don't want to do that, use the second method.
If you cloned this repository directly where you set your root directory to, this method will allow you to perform instant updates with no additional configuration required.
2. **Method 2 (not recommended)**: Deploy `public_html` directory into your web server and rest of these files in a safe place. Then you will need to edit paths in `config.ini` and `chdir` path in `public_html/dispatch.php` on the web server, either with relative or absolute paths.
Keep note that this method will make updating your szurubooru more difficult.
3. _TODO: file permissions and security information_
4. If all done correctly, you should be able to see your szurubooru loading with no major issues. However, you need some more dependencies to be downloaded, such as javascript libraries etc. This can be done by running `init.php` script.
If you're using default path structure, run `init.php` script from command line if possible: `php init.php`. If not, `init.php` must be called from http request - place it in your web server directory and edit destination paths accordingly, invoke `init.php` from your browser, then delete or rename it.
5. szurubooru should be ready to use now. If you still having problems, make sure that all required PHP extensions are enabled and all configured paths are correct.
## Configuration
TODO
# Project management
* Closed issues tagged as `core feature` cannot be reopened. Issues related to this feature should be reported separately.
For installation guide, see [INSTALL.md](https://github.com/rr-/szurubooru/blob/master/INSTALL.md).