malhuda/jikan-rest
1
0
Fork 0
mirror of https://github.com/jikan-me/jikan-rest.git synced 2025-02-20 11:23:35 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

update installation instructions & prerequisites

Browse Source
This commit is contained in:
Irfan 2019-07-01 16:39:46 +05:00 committed by GitHub
parent 660b9984f4
commit f9c95e4d5f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 81 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

118
README.MD
View File

@ -25,15 +25,16 @@ The word _Jikan_ literally translates to _Time_ in Japanese (**時間**). And th
#### 🐳 Docker
- [JikanREST Docker](https://github.com/fethica/jikan-rest-docker) by Fethi El Hassasna
#### Linux
#### Prerequisites
##### Linux
This is specifically for Ubuntu, but other distributions should work similarly.
1. Install requirements:
- Add PHP related packages: `sudo add-apt-repository -y ppa:ondrej/php`
- If `add-apt-repository` is not installed, you can install it by doing `sudo apt install python-software-properties` or `sudo apt install software-properties-common`
- `sudo apt update && sudo apt upgrade`
- Install requirements: `sudo apt install curl git php redis-server unzip supervisor`
- Install requirements: `sudo apt install curl git php redis unzip`
- Verify that PHP 7.1+ is installed: `php -v`
- Install the corresponding `php-xml` and `php-mbstring` packages for your version, e.g:
- PHP 7.1: `sudo apt install php7.1-xml php7.1-mbstring`
@ -41,10 +42,10 @@ This is specifically for Ubuntu, but other distributions should work similarly.
- Install composer: `curl -sS https://getcomposer.org/installer | sudo php -- --install-dir=/usr/local/bin --filename=composer`
2. Start the redis server: `sudo service redis start`
#### Mac
##### Mac
1. Install [brew](https://brew.sh/)
2. Install requirements: `brew install php composer redis supervisor`
2. Install requirements: `brew install php composer redis`
3. Start the redis server: `brew services start redis`
### Setting Up
@ -52,44 +53,18 @@ This is specifically for Ubuntu, but other distributions should work similarly.
1. `git clone https://github.com/jikan-me/jikan-rest.git`
2. `cd jikan-rest`
3. `cp .env.dist .env`
5. `composer install`
5. `composer install` (Make sure Jikan's directory has write permissions)
#### Configuring Jikan
You're able to configure Jikan through the `.env` file.
A few kernel commands are available from the project directory by running the `artisan` file.
Before running, you need to set the correct values to the following keys in `.env`
The first thing you need to do is generate an `APP_KEY`.
1. `APP_KEY` : a random 32 alphanumeric character string
2. `APP_URL` : If you're using a virtual host, set the correct domain here. Additionally, include the port number if you've changed it from the standard. **Do not leave a trailing slash.**
##### Do's
- `http://api.jikan.moe` :heavy_check_mark:
- `https://api.jikan.local` :heavy_check_mark:
- `http://localhost` :heavy_check_mark:
- `http://localhost:8000` :heavy_check_mark:
##### Dont's
- `http://localhost/` :x:
- `http://api.jikan.moe/` :x:
#### Configuring Supervisor
##### Linux
1. `sudo cp conf/supervisor/jikan-worker.conf /etc/supervisor/conf.d`
- Be sure to update to the correct directory in `jikan-worker.conf` for `command` and `stdout_logfile` to the directory of jikan!
2. `sudo supervisorctl reread`
3. `sudo supervisorctl update`
4. `sudo supervisorctl start jikan-worker:*`
##### Mac
1. `supervisord -c /usr/local/etc/supervisord.ini`
2. Copy `conf/supervisor/jikan-worker.conf` to `/usr/local/etc/supervisor.d/`
3. `brew services start supervisor`
4. `sudo supervisorctl update`
5. `sudo supervisorctl start jikan-worker:*`
1. `php artisan key:generate`
2. Configure how Jikan caches (scroll down)
3. Configure how Jikan handles expired cache
#### Ignition
@ -101,6 +76,75 @@ Jikan is now hosted on `http://localhost:8000/v3/`
:information_source: You can also configure Jikan for Apache. If you wish to configure it for Nginx or anything else, you'll have to port the rewrite rules located at `public/.htaccess`
### Configuring how Jikan Caches
Jikan caches on file by default in `/storage/framework/cache`. So even if you don't change the caching method, Jikan will work out of the box.
However, you can configure Jikan to cache on Redis instead: `php artisan cache:driver redis`
Note: If you're currently running Jikan, you're required to stop it before running the above command.
### Configuring how Jikan handles expired cache
Jikan handles cache in the `legacy` manner out of the box. This method was used previously to update cache.
#### Cache Method: Legacy
When a cache expires, it gets deleted. So if you make a request that has an expired cache, your request will take longer as Jikan has to fetch and parse the new data from MyAnimeList again.
#### Cache Method: Queue
This is a newly introduced caching method to the API, it's what the public API runs on as well. It requires some further setup.
When a cache expires, it does not get deleted. Instead, if you make a request that has an expired cache, a job will be dispatched to the queue which handles updating the cache in the background. Therefore, the request will keep on providing stale cache until the job is complete and the cache is replaced with fresh data.
This method provides zero delay, and is highly recommended if you have immense traffic coming your way.
Note: If you're currently running Jikan, you're required to stop it before running the above command. You're also required to clear any cache you've stored as well as anything on the Redis server.
1. `php artisan cache:method queue`
Next, you need to make sure that there's a service looking after the queue. This can be manually done by running a process through `php artisan queue:work --queue=high,low`. You can set the command to run on cron, nohup, etc.
But a recommended way is to install Supervisor and have it handle the queue automatically.
Note: `--queue=high,low`; Jikan stores two types of queues; high priority and low priority. This depends on the type of request. You can check which request is considered to be high priority in the [JikanResponseHandler.php](https://github.com/jikan-me/jikan-rest/blob/master/app/Http/Middleware/JikanResponseHandler.php) middleware in the `HIGH_PRIORITY_QUEUE` array.
Note 2: Not all requests are queuable. Some are handled the `legacy` way. You can find out which ones in the [JikanResponseHandler.php](https://github.com/jikan-me/jikan-rest/blob/master/app/Http/Middleware/JikanResponseHandler.php) middleware in the `NON_QUEUEABLE` array.
This reason for this is quite simple. User related requests such as anime/manga list can be frequently updated. They're cached by default for 5 minutes (you can change this in `.env`). But if they were to get queued for a cache update, it would take longer than 5 minutes because the update job would have to wait in line. So it skips the queue and is automatically updated on the request. This does mean a slight delay in fetching and parsing the fresh data from MyAnimeList.
Note 3: Note 1 & Note 2 are default behavior. You can obviously change them as per your needs.
##### Configuring Supervisor
###### Linux
1. Install supervisor: `sudo apt install supervisor`
2. `sudo cp conf/supervisor/jikan-worker.conf /etc/supervisor/conf.d`
- A default supervisor configureation file is available in this repo `conf/supervisor/jikan-worker.conf`
- Be sure to update to the correct directory in `jikan-worker.conf` for `command` and `stdout_logfile` to the directory of jikan!
Example: If I install Jikan in `/var/www/jikan-is-installed-here`, you will have to adjust the following values in the `jikan-worker.conf` file.
```
...
command=php /var/www/jikan-is-installed-here/artisan queue:work --queue=high,low
...
stdout_logfile=/var/www/jikan-is-installed-here/storage/logs/worker.log
stderr_logfile=/var/www/jikan-is-installed-here/storage/logs/worker.error.log
```
3. `sudo supervisorctl reread`
4. `sudo supervisorctl update`
5. `sudo supervisorctl start jikan-worker:*`
###### Mac
1. Install Supervisor: `brew install supervisor`
2. `supervisord -c /usr/local/etc/supervisord.ini`
3. Copy `conf/supervisor/jikan-worker.conf` to `/usr/local/etc/supervisor.d/`
4. `brew services start supervisor`
5. `sudo supervisorctl update`
6. `sudo supervisorctl start jikan-worker:*`
### Information
If you don't want to host your instance, there's a public API available.