Update README for version 3

This commit is contained in:
Timothy Warren 2016-04-19 13:24:21 -04:00
parent 1844f89e63
commit 1bc1d2fa31
1 changed files with 23 additions and 4 deletions

View File

@ -33,21 +33,40 @@ A self-hosted client that allows custom formatting of data from the hummingbird
### Requirements
* PHP 5.5+
* PDO SQLite (For collection tab)
* PDO SQLite or PDO PostgreSQL (For collection tab)
* GD
* Redis and PHP Redis extension (optional, for caching)
### Installation
1. Install via composer: `composer create-project timw4mail/hummingbird-anime-client`
2. Configure settings in `app/config/config.php` to your liking
3. Create the following directories if they don't exist, and make sure they are world writable
* app/cache
or
1. Install via git, then install dependencies via composer: `composer install`
2. Duplicate `app/config/*.toml.example` files as `app/config/*.toml`
3. Configure settings in `app/config/config.toml` to your liking
4. Create the following directories if they don't exist, and make sure they are world writable
* public/js/cache
* public/images/manga
* public/images/anime
5. Make sure the `console` script is executable
6. To batch-create image thumbnails, run `console cache-images`.
### Server Setup
#### Caching
To setup API caching, choose a caching method:
* Database
1. Follow the instructions for the Anime Collection setup below.
2. Set `cache_driver` in `app/config/config.toml` to 'SQLDriver'
* Redis
1. Copy `app/redis.toml.example` to `app/redis.toml`, and edit to match your setup.
2. Set `cache_driver` in `app/config/config.toml` to 'RedisDriver'
#### nginx
Basic nginx setup