introduction and quick start guide

Mariusz Dziemianowicz 2013-10-09 06:13:48 -07:00
parent 7035eb6cd8
commit b289892e0b

33
Home.md

@ -1 +1,32 @@
Welcome to the booru wiki!
# Introduction
Szurubooru is a Danbooru-style board, a gallery where users can upload, browse, tag and comment images, video clips and flash animations.
Szurubooru is powered by chibi, a lightweight PHP framework.
# 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 extension enabled
* Some experience with web servers, installing web applications and/or git.
## Installation instructions
1. Clone this repository somewhere or unpack downloaded repository archive.
**Notice**: Cloning 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 `public_html/` directory (change `DocumentRoot` in `httpd.conf` on Apache web server or change it from server provider administration panel).
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. If it's not possible or you don't want to do that, use the second method.
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 can now use your szurubooru.